Annotation of pkgsrc/doc/pkgsrc.html, revision 1.172
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.132 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
1.148 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75 rillig 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.110 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.75 rillig 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.104 rillig 33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.106 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.148 asau 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
48: <dl>
49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
1.157 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 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>
1.82 rillig 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.151 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>
1.166 jnemeth 85: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
86: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
87: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
88: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
89: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
90: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
91: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 92: </dl></dd>
93: </dl></dd>
94: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
97: <dd><dl>
98: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
99: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 100: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
101: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
102: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
103: <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>
104: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
105: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 106: </dl></dd>
107: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
108: <dd><dl>
109: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
110: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
111: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
112: </dl></dd>
113: </dl></dd>
114: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
115: <dd><dl>
116: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
117: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 118: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 119: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 120: <dd><dl>
1.103 wiz 121: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 122: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
123: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 124: </dl></dd>
1.103 wiz 125: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
126: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 127: </dl></dd>
128: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
129: <dd><dl>
130: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
131: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 132: </dl></dd>
133: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
134: builds)</a></span></dt>
1.75 rillig 135: <dd><dl>
1.106 rillig 136: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
137: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
138: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
139: <dd><dl>
140: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
141: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
142: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
143: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
144: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
145: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
146: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
147: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
148: </dl></dd>
149: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 150: <dd><dl>
151: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
152: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
153: </dl></dd>
1.106 rillig 154: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
155: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
156: </dl></dd>
157: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
158: <dd><dl>
1.128 wiz 159: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
160: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106 rillig 161: </dl></dd>
162: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
163: <dd><dl>
164: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
165: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
166: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
167: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
168: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
169: <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>
170: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.128 wiz 171: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106 rillig 172: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.128 wiz 173: <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
174: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
175: <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.106 rillig 176: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
177: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
178: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.128 wiz 179: <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.106 rillig 180: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.128 wiz 181: <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.75 rillig 182: </dl></dd>
183: </dl></dd>
184: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
185: <dd><dl>
1.106 rillig 186: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 187: <dd><dl>
1.106 rillig 188: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 189: <dd><dl>
1.106 rillig 190: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
191: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 192: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 193: </dl></dd>
1.106 rillig 194: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
195: <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>
196: </dl></dd>
197: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
198: <dd><dl>
1.128 wiz 199: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
200: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 201: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
202: <dd><dl>
203: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
204: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
205: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
206: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
207: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
208: </dl></dd>
209: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
210: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
211: <dd><dl>
212: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
213: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
214: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
215: </dl></dd>
1.128 wiz 216: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
217: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 218: </dl></dd>
1.128 wiz 219: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 220: <dd><dl>
221: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 222: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 223: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
224: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
225: <dd><dl>
226: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
227: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
228: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
229: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
230: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
231: </dl></dd>
232: </dl></dd>
233: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
234: <dd><dl>
235: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 236: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
237: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 238: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
239: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 240: <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.106 rillig 241: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
242: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
243: </dl></dd>
244: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
245: <dd><dl>
246: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 247: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 248: <dd><dl>
249: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 250: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
251: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
252: and
253: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
254: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 255: </dl></dd>
1.128 wiz 256: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106 rillig 257: <dd><dl>
1.128 wiz 258: <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.106 rillig 259: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
260: </dl></dd>
261: </dl></dd>
262: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
263: <dd><dl>
264: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
265: <dd><dl>
266: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
267: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
268: </dl></dd>
269: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
270: <dd><dl>
1.128 wiz 271: <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.106 rillig 272: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
273: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
274: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
275: </dl></dd>
276: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
277: <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>
278: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
279: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
280: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
281: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
282: <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>
283: </dl></dd>
284: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
285: <dd><dl>
286: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 287: <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.106 rillig 288: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 289: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 290: </dl></dd>
291: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
292: <dd><dl>
293: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
294: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
295: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
296: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 297: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 298: <dd><dl>
299: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
300: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
301: </dl></dd>
1.128 wiz 302: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
303: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
304: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
305: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
306: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
307: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
308: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
309: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
310: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
311: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 312: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
313: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
314: </dl></dd>
315: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
316: <dd><dl>
317: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
318: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
319: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
320: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
321: </dl></dd>
322: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
323: <dd><dl>
324: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
325: <dd><dl>
326: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 327: <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.106 rillig 328: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
329: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
330: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
331: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
332: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
333: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
334: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
335: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
336: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
337: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
338: </dl></dd>
1.128 wiz 339: <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.106 rillig 340: <dd><dl>
341: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
342: <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>
343: </dl></dd>
1.128 wiz 344: <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.106 rillig 345: <dd><dl>
346: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
347: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
348: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
349: </dl></dd>
350: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
351: <dd><dl>
352: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
353: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
354: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 355: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
356: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 357: </dl></dd>
1.128 wiz 358: <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.106 rillig 359: <dd><dl>
360: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
361: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 362: <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.106 rillig 363: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
364: </dl></dd>
1.128 wiz 365: <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.106 rillig 366: <dd><dl>
367: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
368: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
369: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
370: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
371: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
372: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
373: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
374: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 375: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 376: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 377: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
378: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
379: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
380: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
381: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
382: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
383: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
384: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 385: emulation</a></span></dt>
1.106 rillig 386: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
387: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 388: </dl></dd>
1.106 rillig 389: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 390: </dl></dd>
1.106 rillig 391: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
392: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 393: <dd><dl>
1.106 rillig 394: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
395: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
396: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140 wiz 397: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 398: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 399: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
400: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 401: </dl></dd>
402: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
403: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
404: <dd><dl>
405: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
406: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
407: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
408: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 409: </dl></dd>
1.75 rillig 410: </dl></dd>
411: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
412: <dd><dl>
1.106 rillig 413: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 414: <dd><dl>
1.106 rillig 415: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
416: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
417: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 418: <dd><dl>
1.106 rillig 419: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
420: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 421: </dl></dd>
1.106 rillig 422: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
423: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 424: <dd><dl>
1.106 rillig 425: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
426: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 427: </dl></dd>
1.106 rillig 428: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 429: <dd><dl>
1.128 wiz 430: <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>
431: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 432: </dl></dd>
433: </dl></dd>
1.106 rillig 434: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 435: <dd><dl>
1.106 rillig 436: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
437: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
438: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 439: <dd><dl>
1.106 rillig 440: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
441: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 442: </dl></dd>
443: </dl></dd>
1.106 rillig 444: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 445: <dd><dl>
1.106 rillig 446: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
447: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 448: </dl></dd>
449: </dl></dd>
450: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
451: <dd><dl>
452: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
453: <dd><dl>
454: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
455: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
456: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 457: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75 rillig 458: </dl></dd>
459: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
460: </dl></dd>
461: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
462: <dd><dl>
463: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
464: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
465: </dl></dd>
1.76 rillig 466: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
467: <dd><dl>
1.128 wiz 468: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
469: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
470: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
471: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
472: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
473: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 474: source packages</a></span></dt>
475: </dl></dd>
1.75 rillig 476: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
477: <dd><dl>
1.79 rillig 478: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 479: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
480: </dl></dd>
481: </dl>
482: </div>
1.82 rillig 483: <div class="list-of-tables">
484: <p><b>List of Tables</b></p>
485: <dl>
486: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
487: </dt>
1.106 rillig 488: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 489: </dt>
1.106 rillig 490: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 491: </dt>
1.82 rillig 492: </dl>
493: </div>
1.148 asau 494: <div class="chapter">
495: <div class="titlepage"><div><div><h1 class="title">
496: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 497: <div class="toc">
498: <p><b>Table of Contents</b></p>
499: <dl>
500: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 501: <dd><dl>
502: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
503: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
504: </dl></dd>
1.75 rillig 505: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
506: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 507: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 508: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
509: </dl>
510: </div>
1.148 asau 511: <div class="sect1">
1.75 rillig 512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
513: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 514: <p>There is a lot of software freely available for Unix-based
515: systems, which is usually available in form of the source code. Before
516: such software can be used, it needs to be configured to the local
517: system, compiled and installed, and this is exactly what The NetBSD
518: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
519: to handle binary packages, so that not every user has to build the
520: packages for himself, which is a time-costly task.</p>
1.75 rillig 521: <p>pkgsrc currently contains several thousand packages,
522: including:</p>
1.148 asau 523: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 524: <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.75 rillig 525: web server</p></li>
1.128 wiz 526: <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.75 rillig 527: web browser</p></li>
1.128 wiz 528: <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.75 rillig 529: Desktop Environment</p></li>
1.128 wiz 530: <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.75 rillig 531: Desktop Environment</p></li>
532: </ul></div>
533: <p>...just to name a few.</p>
534: <p>pkgsrc has built-in support for handling varying dependencies,
535: such as pthreads and X11, and extended features such as IPv6 support on
536: a range of platforms.</p>
1.148 asau 537: <div class="sect2">
1.82 rillig 538: <div class="titlepage"><div><div><h3 class="title">
539: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
540: <p>
541: pkgsrc provides the following key features:
542: </p>
1.148 asau 543: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 544: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 545: and installation of binary packages. The source and latest
546: patches are retrieved from a master or mirror download site, checksum
547: verified, then built on your system. Support for binary-only
548: distributions is available for both native platforms and NetBSD
549: emulated platforms.</p></li>
1.128 wiz 550: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 551: including binaries, libraries, man pages and other
552: documentation.</p></li>
1.128 wiz 553: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82 rillig 554: are handled automatically. The configuration files of various
555: packages are handled automatically during updates, so local changes
556: are preserved.</p></li>
1.128 wiz 557: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 558: consists of highly portable code. This allows the greatest speed of
1.132 spz 559: development when porting to a new platform. This portability also
1.82 rillig 560: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
561: platforms</em></span>.</p></li>
1.128 wiz 562: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 563: international encryption requirements and build-time options for a
564: large number of packages are all set in a simple, central
565: configuration file.</p></li>
1.128 wiz 566: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 567: freely available under a BSD license, so you may extend and adapt
568: pkgsrc to your needs. Support for local packages and patches is
569: available right out of the box, so you can configure it specifically
570: for your environment.</p></li>
571: </ul></div>
1.91 rillig 572: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 573: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 574: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 575: — That means, if a package contains bugs, it's better to find
1.91 rillig 576: them and to complain about them rather than to just install the package
577: and hope that it works. There are numerous checks in pkgsrc that try to
578: 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
579: of shell scripts), and post-installation checks (installed files,
580: references to shared libraries, script interpreters).</p></li>
1.128 wiz 581: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 582: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 583: pkgsrc has been ported to many operating systems. Care is taken that
584: packages behave the same on all platforms.</p></li>
585: </ul></div>
1.82 rillig 586: </div>
1.148 asau 587: <div class="sect2">
1.82 rillig 588: <div class="titlepage"><div><div><h3 class="title">
589: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
590: <p>pkgsrc consists of both a source distribution and a binary
591: distribution for these operating systems. After retrieving the required
592: source or binaries, you can be up and running with pkgsrc in just
593: minutes!</p>
1.75 rillig 594: <p>pkgsrc was derived from FreeBSD's ports system, and
595: initially developed for NetBSD only. Since then, pkgsrc has
596: grown a lot, and now supports the following platforms:</p>
1.82 rillig 597: <div class="table">
598: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 599: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 600: <colgroup>
601: <col>
602: <col>
603: </colgroup>
604: <thead><tr>
605: <th>Platform</th>
606: <th>Date Support Added</th>
607: </tr></thead>
608: <tbody>
609: <tr>
1.110 hubertf 610: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 611: <td align="center">Aug 1997</td>
612: </tr>
613: <tr>
1.110 hubertf 614: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 615: <td align="center">Mar 1999</td>
616: </tr>
617: <tr>
1.110 hubertf 618: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 619: <td align="center">Jun 1999</td>
620: </tr>
621: <tr>
622: <td>
1.110 hubertf 623: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
624: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 625: </td>
626: <td align="center">Oct 2001</td>
627: </tr>
628: <tr>
1.110 hubertf 629: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 630: <td align="center">Nov 2002</td>
631: </tr>
632: <tr>
1.110 hubertf 633: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 634: <td align="center">Nov 2002</td>
635: </tr>
636: <tr>
1.110 hubertf 637: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 638: <td align="center">Dec 2002</td>
639: </tr>
640: <tr>
641: <td>BSD/OS</td>
642: <td align="center">Dec 2003</td>
643: </tr>
644: <tr>
1.110 hubertf 645: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 646: <td align="center">Dec 2003</td>
647: </tr>
648: <tr>
649: <td>
1.110 hubertf 650: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 651: (Microsoft Windows Services for Unix)
652: </td>
653: <td align="center">Mar 2004</td>
654: </tr>
655: <tr>
1.110 hubertf 656: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 657: <td align="center">Oct 2004</td>
658: </tr>
659: <tr>
1.110 hubertf 660: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 661: <td align="center">Nov 2004</td>
662: </tr>
1.98 wiz 663: <tr>
1.110 hubertf 664: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 665: <td align="center">Apr 2007</td>
666: </tr>
1.128 wiz 667: <tr>
668: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
669: <td align="center">Sep 2010</td>
670: </tr>
1.151 obache 671: <tr>
672: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 673: <td align="center">Jan 2011</td>
1.151 obache 674: </tr>
675: <tr>
676: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
677: <td align="center">Nov 2011</td>
678: </tr>
679: <tr>
680: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
681: <td align="center">Mar 2013</td>
682: </tr>
1.166 jnemeth 683: <tr>
684: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
685: <td align="center">Jul 2013</td>
686: </tr>
1.82 rillig 687: </tbody>
1.91 rillig 688: </table></div>
1.82 rillig 689: </div>
1.91 rillig 690: <br class="table-break">
1.82 rillig 691: </div>
1.75 rillig 692: </div>
1.148 asau 693: <div class="sect1">
1.75 rillig 694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
695: <a name="overview"></a>1.2. Overview</h2></div></div></div>
696: <p>This document is divided into three parts. The first,
1.110 hubertf 697: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 698: describes how one can use one of the packages in the Package
699: Collection, either by installing a precompiled binary package,
1.93 rillig 700: or by building one's own copy using the NetBSD package system.
1.110 hubertf 701: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75 rillig 702: package so it can be easily built by other NetBSD users without
703: knowing about the package's building details. The third part,
1.110 hubertf 704: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 705: is intended for those who want to understand how pkgsrc is
706: implemented.</p>
707: <p>This document is available in various formats:
1.110 hubertf 708: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75 rillig 709: </div>
1.148 asau 710: <div class="sect1">
1.75 rillig 711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
712: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 713: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
714: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 715: terminology used within this document.</p>
1.148 asau 716: <div class="variablelist"><dl class="variablelist">
1.75 rillig 717: <dt><span class="term">Package</span></dt>
718: <dd><p>A set of files and building instructions
719: that describe what's necessary
720: to build a certain piece of software using
721: pkgsrc. Packages are traditionally stored under
1.76 rillig 722: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 723: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 724: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 725: is part of the NetBSD operating system and can be bootstrapped
726: to run on non-NetBSD operating systems as well. It handles
727: building (compiling), installing, and removing of
728: packages.</p></dd>
1.75 rillig 729: <dt><span class="term">Distfile</span></dt>
730: <dd><p>This term describes the file or files that are
731: provided by the author of the piece of software to
732: distribute his work. All the changes necessary to build on
733: NetBSD are reflected in the corresponding package. Usually
734: the distfile is in the form of a compressed tar-archive,
735: but other types are possible, too. Distfiles are usually
736: stored below
1.76 rillig 737: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 738: <dt><span class="term">Port</span></dt>
739: <dd><p>This is the term used by FreeBSD and OpenBSD people
740: for what we call a package.
1.128 wiz 741: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 742: architecture.</p></dd>
743: <dt><span class="term">Precompiled/binary package</span></dt>
744: <dd>
745: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 746: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 747: file so it can be installed on machines of the same
748: machine architecture without the need to
749: recompile. Packages are usually generated in
1.76 rillig 750: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 751: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 752: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 753: especially in the context of precompiled packages.</p>
754: </dd>
755: <dt><span class="term">Program</span></dt>
1.88 wiz 756: <dd><p>The piece of software to be installed which will be
757: constructed from all the files in the distfile by the
758: actions defined in the corresponding package.</p></dd>
1.75 rillig 759: </dl></div>
1.148 asau 760: <div class="sect2">
1.75 rillig 761: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 762: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 763: <div class="variablelist"><dl class="variablelist">
1.75 rillig 764: <dt><span class="term">pkgsrc users</span></dt>
765: <dd>
766: <p>The
767: pkgsrc users are people who use the packages provided by pkgsrc.
768: Typically they are system administrators. The people using the
1.128 wiz 769: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
770: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 771: <p>There are two kinds of pkgsrc users: Some only want to
772: install pre-built binary packages. Others build the pkgsrc
773: packages from source, either for installing them directly or for
1.110 hubertf 774: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.75 rillig 775: documentation.</p>
776: </dd>
777: <dt><span class="term">package maintainers</span></dt>
778: <dd><p>A
1.110 hubertf 779: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.75 rillig 780: <dt><span class="term">infrastructure developers</span></dt>
781: <dd><p>These people are involved in all those files
1.76 rillig 782: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 783: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.75 rillig 784: too.</p></dd>
785: </dl></div>
786: </div>
787: </div>
1.148 asau 788: <div class="sect1">
1.75 rillig 789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
790: <a name="typography"></a>1.4. Typography</h2></div></div></div>
791: <p>When giving examples for commands, shell prompts are used to
792: show if the command should/can be issued as root, or if
1.128 wiz 793: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.75 rillig 794: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
795: shell prompt, assuming they use the C-shell or tcsh.</p>
796: </div>
797: </div>
1.148 asau 798: <div class="part">
1.75 rillig 799: <div class="titlepage"><div><div><h1 class="title">
800: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
801: <div class="toc">
802: <p><b>Table of Contents</b></p>
803: <dl>
804: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
805: <dd><dl>
806: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
807: <dd><dl>
1.157 asau 808: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 809: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 810: </dl></dd>
811: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
812: <dd><dl>
813: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
814: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
815: </dl></dd>
816: </dl></dd>
817: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
818: <dd><dl>
1.82 rillig 819: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
820: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
821: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
822: <dd><dl>
1.151 obache 823: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
824: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
825: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 826: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
827: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
828: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
829: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
830: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
831: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
832: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 833: </dl></dd>
834: </dl></dd>
835: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
836: <dd><dl>
837: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
838: <dd><dl>
839: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
840: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 841: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
842: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
843: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
844: <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>
845: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
846: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 847: </dl></dd>
848: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
849: <dd><dl>
850: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
851: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
852: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
853: </dl></dd>
854: </dl></dd>
855: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
856: <dd><dl>
857: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
858: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 859: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 860: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 861: <dd><dl>
1.103 wiz 862: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 863: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
864: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 865: </dl></dd>
1.103 wiz 866: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
867: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 868: </dl></dd>
869: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
870: <dd><dl>
871: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
872: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 873: </dl></dd>
874: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
875: builds)</a></span></dt>
1.75 rillig 876: <dd><dl>
1.106 rillig 877: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
878: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
879: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
880: <dd><dl>
881: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
882: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
883: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
884: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
885: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
886: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
887: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
888: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
889: </dl></dd>
890: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 891: <dd><dl>
892: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
893: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
894: </dl></dd>
1.106 rillig 895: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
896: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
897: </dl></dd>
898: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
899: <dd><dl>
1.128 wiz 900: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
901: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106 rillig 902: </dl></dd>
903: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
904: <dd><dl>
905: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
906: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
907: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
908: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
909: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
910: <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>
911: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.128 wiz 912: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106 rillig 913: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.128 wiz 914: <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
915: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
916: <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.106 rillig 917: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
918: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
919: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.128 wiz 920: <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.106 rillig 921: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.128 wiz 922: <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.75 rillig 923: </dl></dd>
924: </dl>
925: </div>
1.148 asau 926: <div class="chapter">
1.75 rillig 927: <div class="titlepage"><div><div><h2 class="title">
928: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
929: <div class="toc">
930: <p><b>Table of Contents</b></p>
931: <dl>
932: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
933: <dd><dl>
1.157 asau 934: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 935: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 936: </dl></dd>
937: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
938: <dd><dl>
939: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
940: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
941: </dl></dd>
942: </dl>
943: </div>
1.91 rillig 944: <p>Before you download and extract the files, you need to decide
945: where you want to extract them. When using pkgsrc as root user, pkgsrc
946: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
947: free to install the sources and binary packages wherever you want in
948: your filesystem, provided that the pathname does not contain white-space
949: or other characters that are interpreted specially by the shell and some
950: other programs. A safe bet is to use only letters, digits, underscores
951: and dashes.</p>
1.148 asau 952: <div class="sect1">
1.75 rillig 953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
954: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
955: <p>Before you download any pkgsrc files, you should decide
956: whether you want the <span class="emphasis"><em>current</em></span> branch or the
957: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
958: quarterly basis from the current branch and only gets modified
959: for security updates. The names of the stable branches are built
960: from the year and the quarter, for example
1.124 snj 961: <code class="literal">2009Q1</code>.</p>
1.75 rillig 962: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 963: want to download pkgsrc. You can get it as a tar file or via CVS.
964: Both ways are described here.</p>
1.157 asau 965: <p>Note that tar archive contains CVS working copy.
966: Thus you can switch to using CVS at any later time.</p>
967: <p>Note also that quarterly branch is not frozen in stone.
968: It receives critical updates.</p>
1.148 asau 969: <div class="sect2">
1.75 rillig 970: <div class="titlepage"><div><div><h3 class="title">
1.157 asau 971: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75 rillig 972: <p>The primary download location for all pkgsrc files is
1.157 asau 973: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
974: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
975: (it points to the same location).
976: There are a number of subdirectories for different purposes,
977: 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>
978: <p>The tar archive for the current branch is in the directory
979: <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.75 rillig 980: It is autogenerated daily.</p>
1.157 asau 981: <p>To save download time we provide bzip2- and
982: xz-compressed archives which are published at
983: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
984: and
985: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
986: respectively.
987: </p>
988: <p>You can fetch the same files using FTP.</p>
1.166 jnemeth 989: <p>The tar file for the stable branch 2013Q1 is in the
990: directory <code class="filename">pkgsrc-2013Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2013Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.112 weinem 991: <p>To download a pkgsrc stable tarball, run:</p>
992: <pre class="screen">
1.166 jnemeth 993: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.126 jakllsch 994: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 995: stable branch to be downloaded, for example,
1.166 jnemeth 996: <span class="quote">“<span class="quote">pkgsrc-2013Q1</span>”</span>.</p>
1.157 asau 997: <p>You can use fetch it also using "wget", "curl",
998: or your web browser.</p>
1.112 weinem 999: <p>Then, extract it with:</p>
1.126 jakllsch 1000: <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.112 weinem 1001: <p>This will create the directory <code class="filename">pkgsrc/</code>
1002: in <code class="filename">/usr/</code> and all the package source will be
1003: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1004: <p>To download pkgsrc-current, run:</p>
1005: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75 rillig 1006: </div>
1.148 asau 1007: <div class="sect2">
1.75 rillig 1008: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 1009: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
1010: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146 wiz 1011: <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.128 wiz 1012: </pre>
1013: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1014: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span></p>
1015: <p>This will create the directory <code class="filename">pkgsrc/</code>
1016: in your <code class="filename">/usr/</code> directory and all the package source
1017: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1018: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 1019: <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 grant 1020: </pre>
1.136 dholland 1021: <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.128 wiz 1022: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146 wiz 1023: <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.128 wiz 1024: </pre>
1025: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1026: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1027: or better globally in <code class="filename">/etc/profile</code>:</p>
1028: <pre class="programlisting">
1029: # set CVS remote shell command
1030: CVS_RSH=ssh
1031: export CVS_RSH
1032: </pre>
1033: <p>By default, CVS doesn't do things like most people would expect it to do.
1034: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1035: in your home directory and saving the following lines to it.
1036: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1037: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1038: <pre class="programlisting">
1039: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1040: cvs -q -z2
1.101 rillig 1041: checkout -P
1.103 wiz 1042: update -dP
1043: diff -upN
1.101 rillig 1044: rdiff -u
1.128 wiz 1045: release -d
1.101 rillig 1046: </pre>
1.75 rillig 1047: </div>
1048: </div>
1.148 asau 1049: <div class="sect1">
1.75 rillig 1050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1051: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1052: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1053: (which also works if you have first installed it via a tar
1054: file). It saves bandwidth and hard disk activity, compared to
1055: downloading the tar file again.</p>
1.148 asau 1056: <div class="sect2">
1.75 rillig 1057: <div class="titlepage"><div><div><h3 class="title">
1058: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148 asau 1059: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1060: <h3 class="title">Warning</h3>
1.77 rillig 1061: <p>When updating from a tar file, you first need to
1062: completely remove the old pkgsrc directory. Otherwise those
1063: files that have been removed from pkgsrc in the mean time will
1064: not be removed on your local disk, resulting in inconsistencies.
1065: When removing the old files, any changes that you have done to
1066: the pkgsrc files will be lost after updating. Therefore updating
1067: via CVS is strongly recommended.</p>
1.75 rillig 1068: </div>
1.82 rillig 1069: <p>Note that by default the distfiles and the binary packages
1070: are saved in the pkgsrc tree, so don't forget to rescue them
1071: before updating. You can also configure pkgsrc to use other than
1072: the default directories by setting the
1073: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1074: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1075: <p>To update pkgsrc from a tar file, download the tar file as
1076: explained above. Then, make sure that you have not made any
1077: changes to the files in the pkgsrc directory. Remove the pkgsrc
1078: directory and extract the new tar file. Done.</p>
1079: </div>
1.148 asau 1080: <div class="sect2">
1.75 rillig 1081: <div class="titlepage"><div><div><h3 class="title">
1082: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132 spz 1083: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1084: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1085: </pre>
1086: <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>
1087: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1088: </pre>
1.148 asau 1089: <div class="sect3">
1.75 rillig 1090: <div class="titlepage"><div><div><h4 class="title">
1091: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1092: <p>When updating pkgsrc, the CVS program keeps track of the
1093: branch you selected. But if you, for whatever reason, want to
1094: switch from the stable branch to the current one, you can do it
1.128 wiz 1095: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1096: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1097: back to the stable branch, add the
1.128 wiz 1098: <span class="quote">“<span class="quote">-rpkgsrc-2009Q3</span>”</span> option.</p>
1.75 rillig 1099: </div>
1.148 asau 1100: <div class="sect3">
1.75 rillig 1101: <div class="titlepage"><div><div><h4 class="title">
1102: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1103: <p>When you update pkgsrc, the CVS program will only touch
1104: those files that are registered in the CVS repository. That
1105: means that any packages that you created on your own will stay
1106: unmodified. If you change files that are managed by CVS, later
1107: updates will try to merge your changes with those that have been
1108: done by others. See the CVS manual, chapter
1.128 wiz 1109: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1110: </div>
1111: </div>
1112: </div>
1113: </div>
1.148 asau 1114: <div class="chapter">
1.75 rillig 1115: <div class="titlepage"><div><div><h2 class="title">
1116: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1117: <div class="toc">
1118: <p><b>Table of Contents</b></p>
1119: <dl>
1.82 rillig 1120: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1121: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1122: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1123: <dd><dl>
1.151 obache 1124: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1125: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1126: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 1127: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1128: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1129: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1130: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1131: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1132: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1133: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 1134: </dl></dd>
1135: </dl>
1136: </div>
1.148 asau 1137: <div class="sect1">
1.75 rillig 1138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1139: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1140: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.82 rillig 1141: </div>
1.148 asau 1142: <div class="sect1">
1.82 rillig 1143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1144: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1145: <p>pkgsrc can be bootstrapped for use in two different modes:
1146: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1147: to privileged one all programs are installed under one particular user
1.149 asau 1148: and cannot utilise privileged operations (packages don't create
1149: special users and all special file permissions like setuid are ignored).
1150: </p>
1.82 rillig 1151: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1152: <pre class="screen">
1.167 asau 1153: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75 rillig 1154: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1155: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1156: </pre>
1.149 asau 1157: <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>
1158: <p>By default, in privileged mode pkgsrc uses
1159: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1160: where programs will be installed in,
1.87 wiz 1161: and <code class="filename">/var/db/pkg</code> for the package database
1.149 asau 1162: directory where pkgsrc will do its internal bookkeeping,
1163: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1164: where packages install their persistent data.
1165: In unprivileged mode pkgsrc uses
1166: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1167: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1168: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1169: </p>
1170: <p>You can change default layout using command-line arguments.
1171: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1172: </p>
1.148 asau 1173: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1174: <h3 class="title">Note</h3>
1.110 hubertf 1175: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1176: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1177: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1178: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1179: </div>
1.149 asau 1180: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1181: <h3 class="title">Note</h3>
1182: <p>It is possible to bootstrap multiple instances of pkgsrc
1183: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1184: corresponding to the installation you're working with to build
1185: and install packages.
1186: </p>
1187: </div>
1.75 rillig 1188: </div>
1.148 asau 1189: <div class="sect1">
1.75 rillig 1190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1191: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1192: <p>Here are some platform-specific notes you should be aware of.</p>
1.148 asau 1193: <div class="sect2">
1.75 rillig 1194: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1195: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1196: <p>Cygwin 1.7.x and later are supported.</p>
1197: <p>You need to install minimal base packages in `Base' category
1198: plus any of compiler, gcc, gcc4, and/or clang.
1199: For gcc and gcc4, C and C++ compiler will be installed by default,
1200: but you can install Fortran compiler additionally
1201: because it will be required to use libtool.
1202: If it is not installed (or too old), Fortran compiler will be
1203: installed with pkgsrc automatically.</p>
1204: <p>As noted in
1205: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1206: su(1) command has been in Cygwin distribution, but it has never worked.
1207: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1208: </p>
1209: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1210: then pick "Run as administrator".</p></li></ul></div>
1211: </div>
1212: <div class="sect2">
1213: <div class="titlepage"><div><div><h3 class="title">
1214: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.148 asau 1215: <p>Darwin 5.x and up are supported.</p>
1216: <p>Before you start, you need to download and install
1217: the Mac OS X Developer Tools from Apple's Developer Connection.
1218: This requires (free) membership. See
1.126 jakllsch 1219: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148 asau 1220: for details. Also, make sure you install X11 (an optional
1221: package included with the Developer Tools) if you intend
1222: to build packages that use the X11 Window System.
1223: (If you don't want or need the full Xcode GUI,
1224: download and install Command Line Tools for Xcode.)</p>
1.75 rillig 1225: </div>
1.148 asau 1226: <div class="sect2">
1.75 rillig 1227: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1228: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136 dholland 1229: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87 wiz 1230: other versions may work.</p>
1.75 rillig 1231: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1232: with the FreeBSD userland tools. There are several steps:</p>
1.128 wiz 1233: <div class="orderedlist"><ol class="orderedlist" type="1">
1234: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 1235: <code class="filename">/var/db/pkg</code>. It is therefore
1236: recommended that you choose a different location (e.g.
1237: <code class="filename">/usr/pkgdb</code>) by
1238: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1239: <li class="listitem">
1.75 rillig 1240: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1241: good idea to move them out of the way to avoid confusion, e.g.</p>
1242: <pre class="screen">
1243: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1244: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1245: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1246: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1247: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1248: </pre>
1.75 rillig 1249: </li>
1.128 wiz 1250: <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.87 wiz 1251: <code class="filename">/etc/mk.conf.example</code> file
1252: when you use the bootstrap script.</p></li>
1.75 rillig 1253: </ol></div>
1254: </div>
1.148 asau 1255: <div class="sect2">
1.75 rillig 1256: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1257: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1258: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1259: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1260: <p> You should install ncurses (libncurses and libncurses-dev)
1261: packages.</p>
1262: </div>
1263: <div class="sect2">
1264: <div class="titlepage"><div><div><h3 class="title">
1265: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.75 rillig 1266: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1267: providing a Unix-like environment with a tighter kernel integration than
1268: available with Cygwin. It is part of the Windows Services for Unix
1269: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1270: (not including XP Home), or 2003. SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93 rillig 1271: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1272: are not officially supported. (The main difference in 3.0/3.1 is lack
1273: of pthreads, but other parts of libc may also be lacking.)</p>
1.129 wiz 1274: <p>Services for Unix Applications (aka SUA) is an integrated
1275: component of Windows Server 2003 R2 (5.2), Windows Vista and
1276: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1277: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1278: 6.1 (64bit) subsystems have been tested. Other versions may
1279: work as well. The Interix 5.x subsystem has not yet been tested
1280: with pkgsrc.</p>
1.148 asau 1281: <div class="sect3">
1.75 rillig 1282: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1283: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1284: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1285: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148 asau 1286: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1287: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1288: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1289: <li class="listitem"><p>Remote Connectivity</p></li>
1290: <li class="listitem"><p>Interix SDK</p></li>
1.75 rillig 1291: </ul></div>
1292: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1293: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1294: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1295: pkgsrc (or from a binary package).</p>
1.75 rillig 1296: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1297: not need to be installed, but Remote Connectivity itself should be
1298: installed in order to have a working inetd.</p>
1.75 rillig 1299: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1300: behavior for Interix programs, and whether to make pathnames default to
1301: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1302: enabled. (Without case-sensitivity, a large number of packages including
1303: perl will not build.)</p>
1.75 rillig 1304: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1305: works (via the Data Execution Prevention feature). In order to use
1306: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1307: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1308: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1309: support contract; however, Debian Interix Port has made most Interix
1310: 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.93 rillig 1311: <p>In addition to the hotfix noted above, it may be necessary to
1312: disable Data Execution Prevention entirely to make Interix functional.
1313: This may happen only with certain types of CPUs; the cause is not fully
1314: understood at this time. If gcc or other applications still segfault
1315: repeatedly after installing one of the hotfixes note above, the
1316: following option can be added to the appropriate "boot.ini" line on the
1317: Windows boot drive: /NoExecute=AlwaysOff
1318: (WARNING, this will disable DEP completely, which may be a security
1319: risk if applications are often run as a user in the Administrators
1320: group!)</p>
1.75 rillig 1321: </div>
1.148 asau 1322: <div class="sect3">
1.75 rillig 1323: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1324: <a name="platform.interix-sfu-postinstall"></a>3.3.5.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75 rillig 1325: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1326: with pkgsrc, note the following things.</p>
1.148 asau 1327: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1328: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1329: Windows Services for UNIX, then click Change. In the installer, choose
1330: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 wiz 1331: <li class="listitem">
1.75 rillig 1332: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1333: change the following registry key:</p>
1.75 rillig 1334: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1335: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1336: </li>
1.128 wiz 1337: <li class="listitem">
1.75 rillig 1338: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1339: following registry key:</p>
1.75 rillig 1340: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1341: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1342: </li>
1343: </ul></div>
1344: </div>
1.148 asau 1345: <div class="sect3">
1.75 rillig 1346: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1347: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1348: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1349: running "pkg_add") must be a member of the local Administrators
1350: group. Such a user must also be used to run the bootstrap. This is
1351: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1352: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1353: automatically complain if this is not the case. This ensures that
1354: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1355: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1356: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1357: NOT be used in conjunction with pkgsrc. If you choose to use them at
1358: the same time as the pkgsrc packages, ensure that you use the proper
1359: pkg_* tools for each type of binary package.</p>
1.75 rillig 1360: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1361: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1362: don't have a termcap/terminfo entry for it, but the following .termcap
1363: entry provides adequate emulation in most cases:</p>
1.75 rillig 1364: <pre class="programlisting">
1.100 rillig 1365: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1366: </pre>
1.75 rillig 1367: </div>
1.148 asau 1368: <div class="sect3">
1.75 rillig 1369: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1370: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1371: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1372: for a full Unix-like platform, it has some drawbacks that should
1373: be noted for those desiring to make the most of Interix.</p>
1.148 asau 1374: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1375: <li class="listitem">
1.75 rillig 1376: <p><span class="strong"><strong>X11:</strong></span></p>
1377: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1378: and can run X11 based applications, but it does
1379: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1380: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1381: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1382: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1383: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1384: and the free X11 server included with
1.110 hubertf 1385: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1386: </li>
1.128 wiz 1387: <li class="listitem">
1.75 rillig 1388: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1389: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1390: Win32 applications, it does not currently support various X11
1391: protocol extensions for acceleration (such as MIT-SHM or DGA).
1392: Most interactive applications to a local X server will run
1393: reasonably fast, but full motion video and other graphics
1394: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1395: </li>
1.128 wiz 1396: <li class="listitem">
1.75 rillig 1397: <p><span class="strong"><strong>Audio:</strong></span></p>
1398: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1399: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1400: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1401: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.110 hubertf 1402: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1403: server component. To output audio via an Interix host, the
1.91 rillig 1404: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1.87 wiz 1405: must also be installed.</p>
1.75 rillig 1406: </li>
1.128 wiz 1407: <li class="listitem">
1.75 rillig 1408: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1409: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1410: is not currently possible to access CD/DVD drives, USB devices,
1411: or SCSI devices through non-filesystem means. Among other things,
1412: this makes it impossible to use Interix directly for CD/DVD
1413: burning.</p>
1.75 rillig 1414: </li>
1.128 wiz 1415: <li class="listitem">
1.75 rillig 1416: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1417: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1418: drives are also not directly accessible in Interix. However,
1419: support is in work to make tape drive access possible by using
1420: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1421: esound server).</p>
1.75 rillig 1422: </li>
1423: </ul></div>
1424: </div>
1.148 asau 1425: <div class="sect3">
1.75 rillig 1426: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1427: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1428: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1429: Windows system; any member of the local Administrators group will
1430: suffice. However, some packages currently assume that the user
1431: named "root" is the privileged user. To accommodate these, you
1432: may create such a user; make sure it is in the local group
1433: Administrators (or your language equivalent).</p>
1.110 hubertf 1434: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1435: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1436: time being, install packages as the local Administrator (or
1437: your language equivalent), or run the following command after
1438: installing a package to work around the issue:</p>
1.75 rillig 1439: <pre class="screen">
1.87 wiz 1440: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1441: </pre>
1.75 rillig 1442: </div>
1443: </div>
1.148 asau 1444: <div class="sect2">
1.75 rillig 1445: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1446: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75 rillig 1447: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1448: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1449: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1450: compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75 rillig 1451: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.136 dholland 1452: 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.87 wiz 1453: etc.</p>
1.86 schwarz 1454: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1455: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1456: you start out using "abi=n32", that's what all your packages will be built
1457: with.</p>
1458: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1459: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1460: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1461: try to link n32 object files with lib64 or vice versa. Check your
1462: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1463: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1464: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1465: as it appears that IRIX linker occasionally runs into issues when trying to
1466: link over a network-mounted file system.</p>
1.75 rillig 1467: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1468: as imake(1), but you may want to set some options depending on your local
1469: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1470: course, your compiler's man pages for details.</p>
1.75 rillig 1471: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1472:
1.87 wiz 1473: </p>
1.75 rillig 1474: <pre class="programlisting">
1.100 rillig 1475: PKGSRC_COMPILER= mipspro
1.87 wiz 1476: </pre>
1.75 rillig 1477: <p>
1.1 grant 1478:
1.110 hubertf 1479: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1480: are using gcc and may end up passing invalid flags to the compiler. Note that
1481: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1482: default.</p>
1.75 rillig 1483: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1484: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1485: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1486: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1487: '--preserve-path' flag.</p>
1.75 rillig 1488: </div>
1.148 asau 1489: <div class="sect2">
1.75 rillig 1490: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1491: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87 wiz 1492: <p>Some versions of Linux (for example Debian GNU/Linux) need
1493: either libtermcap or libcurses (libncurses). Installing the
1494: distributions libncurses-dev package (or equivalent) should fix
1495: the problem.</p>
1496: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1497: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1498: i386 have been tested.</p>
1.75 rillig 1499: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1500: directory:</p>
1.75 rillig 1501: <pre class="programlisting">
1.138 wiz 1502: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87 wiz 1503: </pre>
1.148 asau 1504: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1505: <h3 class="title">Note</h3>
1.138 wiz 1506: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1507: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1508: <p>For icc 10.1 neither of these appears to be necessary.</p>
1509: </div>
1510: <p>Use a value for ICCBASE that corresponds to the directory
1511: where icc is installed. After bootstrapping, set
1512: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137 wiz 1513: <pre class="programlisting">
1.138 wiz 1514: ICCBASE= /opt/intel/cc/10.1.008
1.87 wiz 1515: </pre>
1.138 wiz 1516: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1517: <code class="filename">/opt/intel_cc_80</code>. This is the default
1518: install directory for icc 8.0. If you are using a more recent
1519: version, be sure to set the correct path explicitly.
1520: </p>
1.75 rillig 1521: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1522: provided by icc, so binaries can be run on other systems which do not
1523: have the shared libraries installed.</p>
1524: <p>Libtool, however, extracts a list of libraries from the
1.136 dholland 1525: <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.87 wiz 1526: records it, throwing away the -Bstatic and -Bdynamic options
1527: interspersed between the libraries. This means that
1528: libtool-linked C++ shared libraries will have a runtime
1529: dependency on the icc libraries until this is fixed in
1530: libtool.</p>
1.75 rillig 1531: </div>
1.148 asau 1532: <div class="sect2">
1.75 rillig 1533: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1534: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163 bsiegert 1535: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1536: Older versions might also work. Releases before #10 are not
1537: supported.</p>
1538: <p>The package tools of the (older) native ports tree,
1539: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1540: have the same names as the ones used by pkgsrc. Care should be taken
1541: that the right tools are used. When installing packages from source,
1542: use the <code class="filename">bmake</code> command for pkgsrc and
1543: <code class="filename">mmake</code> for MirPorts.</p>
1544: <p>pkgsrc and MirPorts use the same location for the package
1545: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1546: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1547: tree is self-contained. This is also the default setting used in the
1548: binary package builds.</p>
1549: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1550: server. The bootstrap kit there already contains the
1551: <span class="command"><strong>pkgin</strong></span> package manager. See the
1552: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1553: page for more details.</p>
1554: </div>
1555: <div class="sect2">
1556: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1557: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136 dholland 1558: <p>OpenBSD 5.1 has been tested and supported,
1559: other versions may work.</p>
1.75 rillig 1560: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1561: with the OpenBSD userland tools. There are several steps:</p>
1.128 wiz 1562: <div class="orderedlist"><ol class="orderedlist" type="1">
1563: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 1564: <code class="filename">/var/db/pkg</code>. It is therefore
1565: recommended that you choose a different location (e.g.
1566: <code class="filename">/usr/pkgdb</code>) by
1567: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1568: <li class="listitem">
1.75 rillig 1569: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1570: good idea to move them out of the way to avoid confusion, e.g.</p>
1571: <pre class="screen">
1572: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1573: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1574: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1575: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1576: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1577: </pre>
1.75 rillig 1578: </li>
1.128 wiz 1579: <li class="listitem">
1.110 hubertf 1580: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1581: <code class="filename">/etc/mk.conf.example</code> file
1582: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1583: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1584: as well. You can work around this by enclosing all the pkgsrc-specific parts
1585: of the file with:</p>
1586: <pre class="programlisting">
1.100 rillig 1587: .ifdef BSD_PKG_MK
1588: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1589: .else
1590: # OpenBSD stuff
1591: .endif
1.87 wiz 1592: </pre>
1.75 rillig 1593: </li>
1594: </ol></div>
1595: </div>
1.148 asau 1596: <div class="sect2">
1.75 rillig 1597: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1598: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142 wiz 1599: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1600: You will need a working C compiler. Both gcc 4.5.3 and
1.87 wiz 1601: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1602: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1603: process and to build packages.</p>
1.148 asau 1604: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1605: <li class="listitem"><p>SUNWsprot</p></li>
1606: <li class="listitem"><p>SUNWarc</p></li>
1607: <li class="listitem"><p>SUNWbtool</p></li>
1608: <li class="listitem"><p>SUNWtoo</p></li>
1609: <li class="listitem"><p>SUNWlibm</p></li>
1.75 rillig 1610: </ul></div>
1.78 rillig 1611: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1612: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1613: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1614: your $prefix are in your <code class="varname">PATH</code>. This includes
1615: <code class="filename">/usr/ccs/{bin,lib}</code>
1616: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148 asau 1617: <div class="sect3">
1.75 rillig 1618: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1619: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1620: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1621: for building all packages.</p>
1.75 rillig 1622: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1623: then either build gcc from
1.142 wiz 1624: <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.87 wiz 1625: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1626: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75 rillig 1627: </div>
1.148 asau 1628: <div class="sect3">
1.75 rillig 1629: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1630: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1631: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1632: 5.0)</p>
1.148 asau 1633: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1634: <li class="listitem"><p>SPROcc
1.87 wiz 1635: - Sun WorkShop Compiler C 5.0</p></li>
1.128 wiz 1636: <li class="listitem"><p>SPROcpl
1.87 wiz 1637: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 wiz 1638: <li class="listitem"><p>SPROild
1.87 wiz 1639: - Sun WorkShop Incremental Linker</p></li>
1.128 wiz 1640: <li class="listitem"><p>SPROlang
1.87 wiz 1641: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1642: </ul></div>
1.96 rillig 1643: <p>You should set the following variables in your
1.110 hubertf 1644: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1645: <pre class="programlisting">
1.100 rillig 1646: CC= cc
1647: CXX= CC
1648: CPP= cc -E
1649: CXXCPP= CC -E
1.96 rillig 1650: </pre>
1.148 asau 1651: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1652: <h3 class="title">Note</h3>
1653: <p>The <code class="varname">CPP</code> setting might break some
1654: packages that use the C preprocessor for processing things other
1655: than C source code.</p>
1656: </div>
1.75 rillig 1657: </div>
1.148 asau 1658: <div class="sect3">
1.75 rillig 1659: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1660: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1661: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1662: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1663: <pre class="programlisting">
1.100 rillig 1664: PKGSRC_COMPILER= sunpro
1665: ABI= 64
1.96 rillig 1666: </pre>
1.148 asau 1667: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1668: <h3 class="title">Note</h3>
1669: <p>This setting has been tested for the SPARC
1670: architecture. Intel and AMD machines need some more
1671: work.</p>
1672: </div>
1.75 rillig 1673: </div>
1.148 asau 1674: <div class="sect3">
1.75 rillig 1675: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1676: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110 hubertf 1677: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1678: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1679: The workaround is to use another shell for the configure
1.91 rillig 1680: scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.110 hubertf 1681: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1682: <pre class="programlisting">
1.100 rillig 1683: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1684: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1685: </pre>
1.91 rillig 1686: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1.75 rillig 1687: </div>
1688: </div>
1689: </div>
1690: </div>
1.148 asau 1691: <div class="chapter">
1.75 rillig 1692: <div class="titlepage"><div><div><h2 class="title">
1693: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1694: <div class="toc">
1695: <p><b>Table of Contents</b></p>
1696: <dl>
1697: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1698: <dd><dl>
1699: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1700: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1701: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1702: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1703: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1704: <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>
1705: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1706: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1707: </dl></dd>
1708: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1709: <dd><dl>
1710: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1711: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1712: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1713: </dl></dd>
1714: </dl>
1715: </div>
1716: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1717: is to only install the package tools and to use binary packages
1.128 wiz 1718: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1719: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1720: of pkgsrc, too. Then you are able to build your own packages,
1721: and you can still use binary packages from someone else.</p>
1.148 asau 1722: <div class="sect1">
1.75 rillig 1723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1724: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1725: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1726: server and its mirrors, there are collections of binary packages,
1727: ready to be installed. These binary packages have been built using the
1728: default settings for the directories, that is:</p>
1.148 asau 1729: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1730: <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>
1731: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1732: <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.109 rillig 1733: </ul></div>
1734: <p>If you cannot use these directories for whatever reasons (maybe
1735: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1736: 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.148 asau 1737: <div class="sect2">
1.75 rillig 1738: <div class="titlepage"><div><div><h3 class="title">
1739: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1740: <p>To install binary packages, you first need to know from where
1741: to get them. The first place where you should look is on the main
1.110 hubertf 1742: pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105 weinem 1743: <p>This directory contains binary packages for multiple
1744: platforms. First, select your operating system. (Ignore the
1745: directories with version numbers attached to it, they just exist for
1746: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1747: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1748: <p>In this directory, you often find a file called
1749: <code class="filename">bootstrap.tar.gz</code> which contains the package
1750: management tools. If the file is missing, it is likely that your
1751: operating system already provides those tools. Download the file and
1752: extract it in the <code class="filename">/</code> directory. It will create
1753: the directories <code class="filename">/usr/pkg</code> (containing the tools
1754: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1755: (the database of installed packages).</p>
1.75 rillig 1756: </div>
1.148 asau 1757: <div class="sect2">
1.75 rillig 1758: <div class="titlepage"><div><div><h3 class="title">
1759: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1760: <p>In the directory from the last section, there is a
1761: subdirectory called <code class="filename">All</code>, which contains all the
1762: binary packages that are available for the platform, excluding those
1763: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1764: medium you are using).</p>
1.109 rillig 1765: <p>To install packages directly from an FTP or HTTP server, run
1766: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1767: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1768: <pre class="screen">
1769: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1770: <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>
1771: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1772: </pre>
1773: <p>Instead of URLs, you can also use local paths, for example if
1774: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1775: repository. If you want to install packages from multiple sources,
1776: you can separate them by a semicolon in
1777: <code class="varname">PKG_PATH</code>.</p>
1778: <p>After these preparations, installing a package is very
1779: easy:</p>
1780: <pre class="screen">
1781: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1782: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1783: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1784: </pre>
1.75 rillig 1785: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1786: package in question will be installed, too, assuming they are
1787: present where you install from.</p>
1.128 wiz 1788: <p>Adding packages might install vulnerable packages.
1789: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1790: regularly, especially after installing new packages, and verify
1791: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1792: <p>After you've installed packages, be sure to have
1.88 wiz 1793: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1794: <code class="varname">PATH</code> so you can actually start the just
1795: installed program.</p>
1.75 rillig 1796: </div>
1.148 asau 1797: <div class="sect2">
1.75 rillig 1798: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1799: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1800: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1801: installed from source code or from a binary package. The
1.110 hubertf 1802: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1803: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1804: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1805: name can be given with or without version number. Wildcards can
1806: also be used to deinstall a set of packages, for example
1807: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1808: so that the shell does not expand them before
1809: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1810: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1811: removes all the packages that require the package in question
1812: and then removes the package itself. For example:
1.82 rillig 1813:
1.88 wiz 1814: </p>
1.82 rillig 1815: <pre class="screen">
1.88 wiz 1816: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1817: </pre>
1.82 rillig 1818: <p>
1819:
1.88 wiz 1820: will remove jpeg and all the packages that used it; this allows
1821: upgrading the jpeg package.</p>
1.82 rillig 1822: </div>
1.148 asau 1823: <div class="sect2">
1.82 rillig 1824: <div class="titlepage"><div><div><h3 class="title">
1825: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1826: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1827: installed packages or binary package files.</p>
1.82 rillig 1828: </div>
1.148 asau 1829: <div class="sect2">
1.82 rillig 1830: <div class="titlepage"><div><div><h3 class="title">
1831: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1832: <p>
1.88 wiz 1833: The NetBSD Security-Officer and Packages Groups maintain a list of
1834: known security vulnerabilities to packages which are (or have been)
1835: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1836: FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.88 wiz 1837: </p>
1.82 rillig 1838: <p>
1.125 wiz 1839: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1840: this list can be downloaded
1841: automatically, and a security audit of all packages installed on a system
1842: can take place.
1843: </p>
1.82 rillig 1844: <p>
1.125 wiz 1845: There are two components to auditing. The first
1846: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1847: is for downloading
1.88 wiz 1848: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1849: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1850: installed packages are vulnerable. If a package is vulnerable, you
1851: will see output similar to the following:
1852: </p>
1.82 rillig 1853: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1854: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1855: <p>
1.125 wiz 1856: You may wish to have the
1.110 hubertf 1857: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1858: file downloaded daily so that
1859: it remains current. This may be done by adding an appropriate entry
1.136 dholland 1860: 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.125 wiz 1861: </p>
1862: <pre class="screen">
1863: # download vulnerabilities file
1864: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1865: </pre>
1866: <p>
1867: will update the vulnerability list every day at 3AM. You may wish to do
1868: this more often than once a day.
1869:
1870: In addition, you may wish to run the package audit from the daily
1871: security script. This may be accomplished by adding the following
1872: line to <code class="filename">/etc/security.local</code>:
1873: </p>
1874: <pre class="screen">
1875: /usr/sbin/pkg_admin audit
1876: </pre>
1877: <p>
1.88 wiz 1878: </p>
1.82 rillig 1879: </div>
1.148 asau 1880: <div class="sect2">
1.82 rillig 1881: <div class="titlepage"><div><div><h3 class="title">
1882: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1883: <p>
1.112 weinem 1884: 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.128 wiz 1885: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1886: argument to check if your packages are up-to-date, e.g.
1887: </p>
1888: <pre class="screen">
1889: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1890: ...
1.88 wiz 1891: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1892: </pre>
1.110 hubertf 1893: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1894: package on your system and rebuild any dependencies.
1895: </p>
1.82 rillig 1896: </div>
1.148 asau 1897: <div class="sect2">
1.82 rillig 1898: <div class="titlepage"><div><div><h3 class="title">
1899: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1900: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1901: administrative functions on the package system.</p>
1.82 rillig 1902: </div>
1.148 asau 1903: <div class="sect2">
1.82 rillig 1904: <div class="titlepage"><div><div><h3 class="title">
1905: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1906: <p>Please pay very careful attention to the warnings
1.136 dholland 1907: 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.88 wiz 1908: inherent dangers of installing binary packages which you did
1909: not create yourself, and the security holes that can be
1910: introduced onto your system by indiscriminate adding of such
1911: files.</p>
1.75 rillig 1912: <p>The same warning of course applies to every package you
1.88 wiz 1913: install from source when you haven't completely read and
1914: understood the source code of the package, the compiler that
1915: is used to build the package and all the other tools that are
1916: involved.</p>
1.75 rillig 1917: </div>
1918: </div>
1.148 asau 1919: <div class="sect1">
1.75 rillig 1920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1921: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1922: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1923: directory now contains a set of packages, organized into
1924: categories. You can browse the online index of packages, or run
1.110 hubertf 1925: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1926: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 1927: all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88 wiz 1928: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1929: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1930: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1931: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1932: different <code class="varname">LOCALBASE</code> definitions on the same
1933: system (inside a chroot is an exception). </p>
1934: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1935: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.88 wiz 1936: instructions how to create your own packages.</p>
1.148 asau 1937: <div class="sect2">
1.75 rillig 1938: <div class="titlepage"><div><div><h3 class="title">
1939: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1940: <p>To build packages from source, you need a working C
1.88 wiz 1941: compiler. On NetBSD, you need to install the
1.128 wiz 1942: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1943: sets. If you want to build X11-related packages, the
1.128 wiz 1944: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1945: sets are required, too.</p>
1.75 rillig 1946: </div>
1.148 asau 1947: <div class="sect2">
1.75 rillig 1948: <div class="titlepage"><div><div><h3 class="title">
1949: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1950: <p>The first step for building a package is downloading the
1.88 wiz 1951: distfiles (i.e. the unmodified source). If they have not yet been
1952: downloaded, pkgsrc will fetch them automatically.</p>
1953: <p>If you have all files that you need in the
1954: <code class="filename">distfiles</code> directory,
1955: you don't need to connect. If the distfiles are on CD-ROM, you can
1956: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1957: </p>
1.82 rillig 1958: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1959: <p>
1.110 hubertf 1960: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1961: <p>By default a list of distribution sites will be randomly
1962: intermixed to prevent huge load on servers which holding popular
1963: packages (for example, SourceForge.net mirrors). Thus, every
1964: time when you need to fetch yet another distfile all the mirrors
1965: will be tried in new (random) order. You can turn this feature
1966: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1967: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1968: <p>You can overwrite some of the major distribution sites to
1969: fit to sites that are close to your own. By setting one or two
1970: variables you can modify the order in which the master sites are
1971: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1972: delimited list of domain suffixes.
1973: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1974: contains a whitespace delimited list of regular expressions. It
1975: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1976: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1977: some examples. This may save some of your bandwidth and
1978: time.</p>
1.75 rillig 1979: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1980: if you want to keep the settings, by editing the
1.110 hubertf 1981: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1982: and adding the definitions there.</p>
1.82 rillig 1983: <p>
1.88 wiz 1984: If a package depends on many other packages (such as
1.93 rillig 1985: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.88 wiz 1986: alternate between periods of
1987: downloading source, and compiling. To ensure you have all the source
1988: downloaded initially you can run the command:
1989: </p>
1.82 rillig 1990: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1991: <p>
1.88 wiz 1992: which will output and run a set of shell commands to fetch the
1993: necessary files into the <code class="filename">distfiles</code> directory. You can
1994: also choose to download the files manually.
1995: </p>
1.75 rillig 1996: </div>
1.148 asau 1997: <div class="sect2">
1.75 rillig 1998: <div class="titlepage"><div><div><h3 class="title">
1999: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 2000: <p>
1.88 wiz 2001: Once the software has downloaded, any patches will be applied, then it
2002: will be compiled for you. This may take some time depending on your
2003: computer, and how many other packages the software depends on and their
2004: compile time.
2005: </p>
1.148 asau 2006: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 2007: <h3 class="title">Note</h3>
2008: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 2009: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 2010: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 2011: </div>
1.87 wiz 2012: <p>For example, type</p>
1.88 wiz 2013: <pre class="screen">
2014: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2015: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2016: </pre>
1.75 rillig 2017: <p>at the shell prompt to build the various components of the
1.88 wiz 2018: package.</p>
1.82 rillig 2019: <p>The next stage is to actually install the newly compiled
1.88 wiz 2020: program onto your system. Do this by entering:
1.82 rillig 2021:
1.88 wiz 2022: </p>
1.82 rillig 2023: <pre class="screen">
1.88 wiz 2024: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2025: </pre>
1.82 rillig 2026: <p>
2027:
1.88 wiz 2028: while you are still in the directory for whatever package you
2029: are installing.</p>
1.82 rillig 2030: <p>Installing the package on your system may require you to
1.88 wiz 2031: be root. However, pkgsrc has a
2032: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2033: to only become root for the actual installation step.</p>
1.82 rillig 2034: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2035: You can now enter:
1.82 rillig 2036:
1.88 wiz 2037: </p>
1.82 rillig 2038: <pre class="screen">
1.88 wiz 2039: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2040: </pre>
1.82 rillig 2041: <p>
2042:
1.88 wiz 2043: to remove the compiled files in the work directory, as you shouldn't need
2044: them any more. If other packages were also added to your system
2045: (dependencies) to allow your program to compile, you can tidy these up
2046: also with the command:</p>
1.82 rillig 2047: <pre class="screen">
1.88 wiz 2048: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2049: </pre>
1.75 rillig 2050: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 2051: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88 wiz 2052: <p>The program is installed under the default root of the
2053: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2054: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2055: variable in your environment, and it will use that value as the
2056: root of your packages tree. So, to use
2057: <code class="filename">/usr/local</code>, set
2058: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2059: Please note that you should use a directory which is dedicated to
2060: packages and not shared with other programs (i.e., do not try and
2061: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2062: to add any of your own files or directories (such as
2063: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2064: <code class="filename">pkgsrc/</code>) below the
2065: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2066: conflicts between programs and other files installed by the
2067: package system and whatever else may have been installed
2068: there.</p>
1.110 hubertf 2069: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2070: alter some configuration options at build time. Have a look at
2071: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2072: of what will be set there by default. Environment variables such
2073: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 2074: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2075: set them each time you want to use pkgsrc.</p>
1.128 wiz 2076: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2077: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 2078: or being installed. This may be for debugging purposes, or out of
2079: simple curiosity. A number of utility values have been added to
2080: help with this.</p>
1.128 wiz 2081: <div class="orderedlist"><ol class="orderedlist" type="1">
2082: <li class="listitem">
1.136 dholland 2083: <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.88 wiz 2084: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2085: information will be displayed. For example,</p>
1.75 rillig 2086: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2087: <p>will show all the commands that are invoked, up to and
1.128 wiz 2088: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 2089: </li>
1.128 wiz 2090: <li class="listitem">
1.136 dholland 2091: <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.88 wiz 2092: definition, then the <code class="varname">VARNAME</code> definition
2093: should be used, in conjunction with the show-var
1.136 dholland 2094: 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.88 wiz 2095: variable <code class="varname">LOCALBASE</code>:</p>
2096: <pre class="screen">
2097: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2098: /usr/pkg
2099: <code class="prompt">%</code>
1.88 wiz 2100: </pre>
1.75 rillig 2101: </li>
2102: </ol></div>
2103: <p>If you want to install a binary package that you've either
1.88 wiz 2104: created yourself (see next section), that you put into
2105: pkgsrc/packages manually or that is located on a remote FTP
2106: server, you can use the "bin-install" target. This target will
1.136 dholland 2107: 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.110 hubertf 2108: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2109: sites searched is kept in the variable
2110: <code class="varname">BINPKG_SITES</code>, which defaults to
1.136 dholland 2111: 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.88 wiz 2112: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2113: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2114: details.</p>
2115: <p>A final word of warning: If you set up a system that has a
2116: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2117: set that before any packages are installed, as you cannot use
2118: several directories for the same purpose. Doing so will result in
2119: pkgsrc not being able to properly detect your installed packages,
2120: and fail miserably. Note also that precompiled binary packages are
2121: usually built with the default <code class="varname">LOCALBASE</code> of
2122: <code class="filename">/usr/pkg</code>, and that you should
2123: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2124: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2125: </div>
2126: </div>
2127: </div>
1.148 asau 2128: <div class="chapter">
1.75 rillig 2129: <div class="titlepage"><div><div><h2 class="title">
2130: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2131: <div class="toc">
2132: <p><b>Table of Contents</b></p>
2133: <dl>
2134: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2135: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2136: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2137: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2138: <dd><dl>
1.103 wiz 2139: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 2140: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2141: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 2142: </dl></dd>
1.103 wiz 2143: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2144: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2145: </dl>
2146: </div>
1.104 rillig 2147: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2148: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2149: that file depends on the installation. On NetBSD, when you use
1.136 dholland 2150: <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.89 rillig 2151: <code class="filename">/etc/</code>. In all other cases the default location is
2152: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2153: bootstrap program to install the binary packages.</p>
2154: <p>During the bootstrap, an example configuration file is created. To
2155: use that, you have to create the directory
2156: <code class="filename">${PREFIX}/etc</code> and copy the example file
2157: there.</p>
2158: <p>The format of the configuration file is that of the usual
2159: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2160: is done by setting variables in this file. Note that you can define all
2161: kinds of variables, and no special error checking (for example for
2162: spelling mistakes) takes place, so you have to try it out to see if it
2163: works.</p>
1.148 asau 2164: <div class="sect1">
1.75 rillig 2165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2166: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2167: <p>In this section, you can find some variables that apply to all
1.89 rillig 2168: pkgsrc packages. A complete list of the variables that can be
2169: configured by the user is available in
2170: <code class="filename">mk/defaults/mk.conf</code>, together with some
2171: comments that describe each variable's intent.</p>
1.148 asau 2172: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2173: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2174: packages will be installed. The default is
1.76 rillig 2175: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2176: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 2177: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2178: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 2179: installed. The default is
1.76 rillig 2180: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 2181: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2182: X11 is installed on the system. The default is
1.76 rillig 2183: <code class="filename">/usr/X11R6</code>.</p></li>
1.128 wiz 2184: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2185: downloaded copies of the original source distributions used
2186: for building pkgsrc packages. The default is
1.76 rillig 2187: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 2188: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2189: database about installed packages is stored. The default is
2190: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 wiz 2191: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2192: If set, override the packages'
2193: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 2194: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2195: Backup location(s) for distribution files and patch files
2196: if not found locally or in
1.76 rillig 2197: <code class="filename">${MASTER_SITES}</code> or
2198: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2199: The defaults are
1.132 spz 2200: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2201: and
1.76 rillig 2202: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 2203: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2204: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2205: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 2206: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2207: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2208: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2209: List of acceptable licenses. License names are case-sensitive.
2210: Whenever you try to build a package whose license is not in this
2211: list, you will get an error message. If the license condition is
2212: simple enough, the error message will include specific
2213: instructions on how to change this variable.</p></li>
1.75 rillig 2214: </ul></div>
2215: </div>
1.148 asau 2216: <div class="sect1">
1.75 rillig 2217: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2218: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2219: <p>XXX
2220: </p>
1.148 asau 2221: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2222: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2223: directory for the binary packages. The default is
1.76 rillig 2224: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 2225: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2226: The top level directory where, if defined, the separate
2227: working directories will get created, and symbolically
1.76 rillig 2228: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2229: This is useful for building packages on several
1.76 rillig 2230: architectures, then <code class="filename">${PKGSRCDIR}</code>
2231: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2232: is local to every architecture. (It should be noted that
2233: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2234: — it is an internal definition which refers to the
1.75 rillig 2235: root of the pkgsrc tree. It is possible to have many
2236: pkgsrc tree instances.)</p></li>
1.128 wiz 2237: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2238: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2239: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2240: information.</p></li>
1.128 wiz 2241: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2242: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2243: BSD-style Makefile. If this is not set,
2244: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2245: <code class="filename">/dev/null</code> to avoid picking up
2246: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 wiz 2247: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2248: By default, dependencies are only installed, and no binary
2249: package is created for them. You can set this variable to
2250: <code class="literal">package</code> to automatically create binary
2251: packages after installing dependencies.</p></li>
1.75 rillig 2252: </ul></div>
2253: </div>
1.148 asau 2254: <div class="sect1">
1.75 rillig 2255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2256: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.131 wiz 2257: <p>Most packages support installation into a
1.103 wiz 2258: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2259: to be built, before the actual filesystem is touched. DESTDIR
2260: support exists in two variations:</p>
1.148 asau 2261: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2262: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 2263: installation and packaging is still run as root.</p></li>
2264: <li class="listitem"><p>Full DESTDIR support can run the complete
2265: build, installation and packaging as normal user. Root
2266: privileges are only needed to add packages.</p></li>
2267: </ul></div>
2268: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2269: you can set
2270: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2271: so it's preferable to convert a package to DESTDIR instead.</p>
1.103 wiz 2272: <p>DESTDIR support changes the behaviour of various targets
2273: slightly. To install a package after building it, use
2274: <code class="literal">package-install</code>. <code class="literal">package</code> and
2275: <code class="literal">install</code> don't do that any
2276: longer. <code class="literal">package-install</code> can be used as
2277: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2278: will ask for the root password to install the package and fail,
2279: <code class="literal">package-install</code> will ask again.</p>
2280: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2281: clean</code></strong> needs to be run as root.</p>
1.118 imil 2282: <p>Considering the <code class="filename">foo/bar</code> package,
2283: DESTDIR full support can be tested using the following commands
2284:
2285: </p>
2286: <pre class="programlisting">
2287: <code class="prompt">$</code> id
2288: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2289: <code class="prompt">$</code> mkdir $HOME/packages
2290: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2291: </pre>
2292: <p>
2293:
2294: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2295: should be needed
2296:
2297: </p>
2298: <pre class="programlisting">
1.123 snj 2299: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.118 imil 2300: </pre>
2301: <p>
2302:
2303: Create a package without root privileges
2304:
2305: </p>
2306: <pre class="programlisting">
1.123 snj 2307: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.118 imil 2308: </pre>
2309: <p>
2310:
2311: For the following command, you must be able to gain root
1.136 dholland 2312: 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.118 imil 2313:
2314: </p>
2315: <pre class="programlisting">
1.123 snj 2316: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.118 imil 2317: </pre>
2318: <p>
2319:
2320: Then, as a simple user
2321:
2322: </p>
2323: <pre class="programlisting">
2324: <code class="prompt">$</code> make clean
2325: </pre>
2326: <p>
2327:
2328: </p>
1.103 wiz 2329: </div>
1.148 asau 2330: <div class="sect1">
1.103 wiz 2331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2332: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 2333: <div class="sect2">
1.78 rillig 2334: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2335: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2336: <p>By default, pkgsrc will use GCC to build packages. This may be
2337: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 2338: <div class="variablelist"><dl class="variablelist">
1.89 rillig 2339: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2340: <dd>
2341: <p>This is a list of values specifying the chain of
2342: compilers to invoke when building packages. Valid values
2343: are:</p>
1.148 asau 2344: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2345: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2346: distributed C/C++ (chainable)</p></li>
1.128 wiz 2347: <li class="listitem"><p><code class="varname">ccache</code>:
1.89 rillig 2348: compiler cache (chainable)</p></li>
1.128 wiz 2349: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2350: GNU C/C++ Compiler</p></li>
1.128 wiz 2351: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2352: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.128 wiz 2353: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2354: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 2355: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2356: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2357: </ul></div>
2358: <p>The default is
1.128 wiz 2359: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 2360: <code class="varname">ccache</code> and/or
2361: <code class="varname">distcc</code> with an appropriate
2362: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 2363: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2364: variable should always be terminated with a value for
2365: a real compiler. Note that only one real compiler
1.128 wiz 2366: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2367: is not allowed).</p>
1.89 rillig 2368: </dd>
2369: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2370: <dd><p>This specifies the minimum version of GCC to use
2371: when building packages. If the system GCC doesn't
2372: satisfy this requirement, then pkgsrc will build and
2373: install one of the GCC packages to use instead.</p></dd>
2374: </dl></div>
2375: </div>
1.148 asau 2376: <div class="sect2">
1.89 rillig 2377: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2378: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78 rillig 2379: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2380: please make sure to use the <code class="literal">+=</code> operator
2381: instead of the <code class="literal">=</code> operator:</p>
2382: <pre class="programlisting">
1.100 rillig 2383: CFLAGS+= -your -flags
1.78 rillig 2384: </pre>
2385: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2386: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2387: need to add their own flags. You may want to take a look
2388: 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.128 wiz 2389: package if you're interested in optimization specifically
2390: for the current CPU. </p>
1.78 rillig 2391: </div>
1.148 asau 2392: <div class="sect2">
1.88 wiz 2393: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2394: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88 wiz 2395: <p>If you want to pass flags to the linker, both in the configure
2396: step and the build step, you can do this in two ways. Either set
2397: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2398: between the two is that <code class="varname">LIBS</code> will be appended to
2399: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2400: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2401: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2402: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2403: <code class="varname">CFLAGS</code>, if you do not wish to override these
2404: settings, use the <code class="literal">+=</code> operator:</p>
2405: <pre class="programlisting">
1.100 rillig 2406: LDFLAGS+= -your -linkerflags
1.88 wiz 2407: </pre>
2408: </div>
1.78 rillig 2409: </div>
1.148 asau 2410: <div class="sect1">
1.78 rillig 2411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2412: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2413: <p>XXX
2414: </p>
1.148 asau 2415: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2416: <li class="listitem">
1.75 rillig 2417: <p><code class="varname">PKG_DEVELOPER</code>:
2418: Run some sanity checks that package developers want:
2419: </p>
1.148 asau 2420: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2421: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2422: fuzz</p></li>
1.128 wiz 2423: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2424: binaries will find their shared libs.</p></li>
1.75 rillig 2425: </ul></div>
2426: <p>
1.87 wiz 2427: </p>
1.75 rillig 2428: </li>
1.128 wiz 2429: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 2430: of debugging output which is displayed whilst making and
2431: installing the package. The default value for this is 0,
2432: which will not display the commands as they are executed
2433: (normal, default, quiet operation); the value 1 will display
2434: all shell commands before their invocation, and the value 2
2435: will display both the shell commands before their invocation,
1.110 hubertf 2436: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2437: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2438: </ul></div>
2439: <p>
2440: </p>
2441: </div>
1.148 asau 2442: <div class="sect1">
1.75 rillig 2443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2444: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2445: <p>Some packages have build time options, usually to select
2446: between different dependencies, enable optional support for big
2447: dependencies or enable experimental features.</p>
1.75 rillig 2448: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2449: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2450: show-options</strong></span>, for example:</p>
1.75 rillig 2451: <pre class="programlisting">
2452: The following options are supported by this package:
2453: ssl Enable SSL support.
2454: Exactly one of the following gecko options is required:
2455: firefox Use firefox as gecko rendering engine.
2456: mozilla Use mozilla as gecko rendering engine.
2457: At most one of the following database options may be selected:
2458: mysql Enable support for MySQL database.
2459: pgsql Enable support for PostgreSQL database.
1.1 grant 2460:
1.75 rillig 2461: These options are enabled by default: firefox
2462: These options are currently enabled: mozilla ssl
1.1 grant 2463: </pre>
1.75 rillig 2464: <p>The following variables can be defined in
1.110 hubertf 2465: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2466: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2467: which can be used to select or disable options for all packages
2468: that support them, and
2469: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2470: which can be used to select or disable options specifically for
2471: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2472: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2473: are disabled. A few examples:</p>
1.75 rillig 2474: <pre class="screen">
1.110 hubertf 2475: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75 rillig 2476: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2477: PKG_OPTIONS.kdebase= debug -sasl
2478: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2479: <p>It is important to note that options that were specifically
1.120 snj 2480: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2481: you do not wish to include the option. If you are unsure you can view
2482: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2483: <p>The following settings are consulted in the order given, and
2484: the last setting that selects or disables an option is
2485: used:</p>
1.128 wiz 2486: <div class="orderedlist"><ol class="orderedlist" type="1">
2487: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2488: maintainer</p></li>
1.128 wiz 2489: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2490: variables (see below)</p></li>
1.128 wiz 2491: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2492: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2493: </ol></div>
2494: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2495: selected is used, all others are automatically disabled. If an
2496: option of the group is explicitly disabled, the previously
2497: selected option, if any, is used. It is an error if no option
2498: from a required group of options is selected, and building the
2499: package will fail.</p>
2500: <p>Before the options framework was introduced, build options
2501: were selected by setting a variable (often named
2502: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2503: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2504: transition to the options framework for the user, these legacy
2505: variables are converted to the appropriate options setting
2506: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2507: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2508: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2509: directly. Support for the legacy variables will be removed
2510: eventually.</p>
1.75 rillig 2511: </div>
2512: </div>
1.148 asau 2513: <div class="chapter">
1.75 rillig 2514: <div class="titlepage"><div><div><h2 class="title">
2515: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2516: <div class="toc">
2517: <p><b>Table of Contents</b></p>
2518: <dl>
2519: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2520: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2521: </dl>
2522: </div>
1.148 asau 2523: <div class="sect1">
1.75 rillig 2524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2525: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2526: <p>Once you have built and installed a package, you can create
2527: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.136 dholland 2528: 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.87 wiz 2529: the same package on a group of hosts and wasting CPU time. It also
2530: provides a simple means for others to install your package, should
2531: you distribute it.</p>
2532: <p>To create a binary package, change into the appropriate
1.110 hubertf 2533: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2534: package</strong></span>:</p>
2535: <pre class="screen">
2536: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2537: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2538: </pre>
2539: <p>This will build and install your package (if not already done),
2540: and then build a binary package from what was installed. You can
1.110 hubertf 2541: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2542: it. Binary packages are created by default in
2543: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2544: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2545: continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.110 hubertf 2546: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.87 wiz 2547: such a binary package.</p>
1.75 rillig 2548: </div>
1.148 asau 2549: <div class="sect1">
1.75 rillig 2550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2551: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2552: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.106 rillig 2553: </div>
2554: </div>
1.148 asau 2555: <div class="chapter">
1.106 rillig 2556: <div class="titlepage"><div><div><h2 class="title">
2557: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2558: builds)</h2></div></div></div>
2559: <div class="toc">
2560: <p><b>Table of Contents</b></p>
2561: <dl>
2562: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2563: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2564: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2565: <dd><dl>
2566: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2567: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2568: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2569: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2570: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2571: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2572: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2573: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2574: </dl></dd>
2575: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 2576: <dd><dl>
2577: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2578: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2579: </dl></dd>
1.106 rillig 2580: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2581: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2582: </dl>
2583: </div>
2584: <p>When you have multiple machines that should run the same packages,
2585: it is wasted time if they all build their packages themselves from
2586: source. There are two ways of getting a set of binary packages: The old
2587: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2588: system. This chapter describes how to set them up so that the packages
2589: are most likely to be usable later.</p>
1.148 asau 2590: <div class="sect1">
1.106 rillig 2591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2592: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2593: <p>Since a bulk build takes several days or even weeks to finish, you
2594: should think about the setup before you start everything. Pay attention
2595: to at least the following points:</p>
1.148 asau 2596: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2597: <li class="listitem">
1.106 rillig 2598: <p>If you want to upload the binary packages to
2599: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2600: packages:</p>
1.148 asau 2601: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2602: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.106 rillig 2603: by a NetBSD developer on a trusted machine (that is, where you and only
2604: you have root access).</p></li>
1.128 wiz 2605: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.124 snj 2606: the stable branches (like 2009Q1), so that users browsing the available
1.106 rillig 2607: collections can see at a glance how old the packages
2608: are.</p></li>
1.128 wiz 2609: <li class="listitem"><p>The packages must be built as root, since some packages
1.106 rillig 2610: require set-uid binaries at runtime, and creating those packages as
2611: unprivileged user doesn't work well at the moment.</p></li>
2612: </ul></div>
2613: </li>
1.128 wiz 2614: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.106 rillig 2615: your system. Most bulk builds run as root, so they should be run at least
2616: in a chroot environment or something even more restrictive, depending on
2617: what the operating system provides. There have been numerous cases where
2618: certain packages tried to install files outside the
2619: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2620: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2621: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2622: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2623: that you don't need any package during the build.</p></li>
2624: </ul></div>
2625: </div>
1.148 asau 2626: <div class="sect1">
1.106 rillig 2627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2628: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2629: <p>A complete bulk build requires lots of disk space. Some of the
2630: disk space can be read-only, some other must be writable. Some can be on
2631: remote filesystems (such as NFS) and some should be local. Some can be
2632: temporary filesystems, others must survive a sudden reboot.</p>
1.148 asau 2633: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 jnemeth 2634: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2635: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2636: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
1.128 wiz 2637: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
1.169 jnemeth 2638: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
1.128 wiz 2639: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.106 rillig 2640: </ul></div>
1.75 rillig 2641: </div>
1.148 asau 2642: <div class="sect1">
1.75 rillig 2643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2644: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.148 asau 2645: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.116 rillig 2646: <h3 class="title">Note</h3>
2647: <p>There are two ways of doing a bulk build. The old-style
1.128 wiz 2648: one and the new-style <span class="quote">“<span class="quote">pbulk</span>”</span>. The latter is the recommended
1.116 rillig 2649: way.</p>
1.106 rillig 2650: </div>
1.148 asau 2651: <div class="sect2">
1.75 rillig 2652: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2653: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.148 asau 2654: <div class="sect3">
1.75 rillig 2655: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2656: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93 rillig 2657: </h4></div></div></div>
1.76 rillig 2658: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2659: configuration file for bulk builds. You can configure how your
2660: copy of pkgsrc is kept up to date, how the distfiles are
2661: downloaded, how the packages are built and how the report is
2662: generated. You can find an annotated example file in
2663: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2664: it, copy <code class="filename">build.conf-example</code> to
2665: <code class="filename">build.conf</code> and edit it, following the
2666: comments in that file.</p>
1.75 rillig 2667: </div>
1.148 asau 2668: <div class="sect3">
1.75 rillig 2669: <div class="titlepage"><div><div><h4 class="title">
1.110 hubertf 2670: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.104 rillig 2671: </h4></div></div></div>
1.110 hubertf 2672: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87 wiz 2673: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2674: details of the default settings. You will want to ensure that
2675: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.125 wiz 2676: As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.104 rillig 2677: completely bypasses the license check.</p>
1.87 wiz 2678: <pre class="programlisting">
1.100 rillig 2679: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2680: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2681: BSDSRCDIR= /usr/src
2682: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2683: OBJHOSTNAME?= yes # use work.`hostname`
2684: FAILOVER_FETCH= yes # insist on the correct checksum
2685: PKG_DEVELOPER?= yes
1.125 wiz 2686: SKIP_LICENSE_CHECK= yes
1.100 rillig 2687: </pre>
1.75 rillig 2688: <p>Some options that are especially useful for bulk builds
2689: can be found at the top lines of the file
1.76 rillig 2690: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2691: options of these are briefly described here.</p>
1.148 asau 2692: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2693: <li class="listitem"><p>If you are on a slow machine, you may want to
1.87 wiz 2694: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.128 wiz 2695: <span class="quote">“<span class="quote">no</span>”</span>.</p></li>
2696: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.87 wiz 2697: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2698: to the directory where all log files are created. Otherwise the
2699: log files are created in the pkgsrc directory.</p></li>
1.128 wiz 2700: <li class="listitem"><p>Another important variable is
1.87 wiz 2701: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2702: should be always available while building other
2703: packages.</p></li>
1.75 rillig 2704: </ul></div>
2705: <p>Some other options are scattered in the pkgsrc
2706: infrastructure:</p>
1.148 asau 2707: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2708: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2709: should be set to <code class="literal">yes</code>. The purpose of the
2710: bulk builds is creating binary packages, no matter if they
2711: are vulnerable or not. Leaving this variable unset would
2712: prevent the bulk build system from even trying to build
2713: them, so possible building errors would not show
2714: up.</p></li>
2715: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2716: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.128 wiz 2717: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed set of files
1.87 wiz 2718: matches the <code class="filename">PLIST</code>.</p></li>
1.128 wiz 2719: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2720: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.128 wiz 2721: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed
2722: <span class="quote">“<span class="quote">#!</span>”</span>-scripts will find their
1.87 wiz 2723: interpreter.</p></li>
1.128 wiz 2724: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2725: set to <span class="quote">“<span class="quote"><code class="literal">yes</code></span>”</span> to run each
1.91 rillig 2726: package's self-test before installing it. Note that some
1.128 wiz 2727: packages make heavy use of <span class="quote">“<span class="quote">good</span>”</span> random
1.91 rillig 2728: numbers, so you need to assure that the machine on which you
2729: are doing the bulk builds is not completely idle. Otherwise
2730: some test programs will seem to hang, while they are just
2731: waiting for new random data to be
2732: available.</p></li>
1.75 rillig 2733: </ul></div>
2734: </div>
1.148 asau 2735: <div class="sect3">
1.75 rillig 2736: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2737: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93 rillig 2738: </h4></div></div></div>
1.75 rillig 2739: <p>It is possible to configure the bulk build to perform
1.87 wiz 2740: certain site-specific tasks at the end of the pre-build
2741: stage. If the file
2742: <code class="filename">pre-build.local</code> exists in
2743: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.136 dholland 2744: (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.87 wiz 2745: stage. An example use of
2746: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2747: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2748: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2749: <p>to prevent the system from trying to build a particular package
1.87 wiz 2750: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2751: </div>
2752: </div>
1.148 asau 2753: <div class="sect2">
1.75 rillig 2754: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2755: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2756: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2757: deleted at the start of bulk builds, make sure your login
2758: shell is placed somewhere else. Either drop it into
2759: <code class="filename">/usr/local/bin</code> (and adjust your login
2760: shell in the passwd file), or (re-)install it via
1.136 dholland 2761: <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.87 wiz 2762: you can login after a reboot (remember that your current
2763: process won't die if the package is removed, you just can't
2764: start any new instances of the shell any more). Also, if you
2765: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2766: version of ssh for some reason, be sure to install ssh before
2767: starting it from <code class="filename">rc.local</code>:</p>
2768: <pre class="programlisting">
1.100 rillig 2769: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2770: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2771: /usr/pkg/etc/rc.d/sshd
2772: fi
2773: </pre>
1.75 rillig 2774: <p>Not doing so will result in you being not able to log in
1.87 wiz 2775: via ssh after the bulk build is finished or if the machine
2776: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2777: </div>
1.148 asau 2778: <div class="sect2">
1.75 rillig 2779: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2780: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75 rillig 2781: <p>Make sure you don't need any of the packages still
1.87 wiz 2782: installed.</p>
1.148 asau 2783: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 2784: <h3 class="title">Warning</h3>
1.99 rillig 2785: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2786: configuration files and some more files from
2787: <code class="filename">/var</code>, <code class="filename">/home</code> and
2788: possibly other locations will be removed! So don't run a bulk
2789: build with privileges that might harm your
2790: system.</em></span></p>
1.75 rillig 2791: </div>
2792: <p>Be sure to remove all other things that might
1.87 wiz 2793: interfere with builds, like some libs installed in
2794: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2795: <pre class="screen">
2796: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2797: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2798: </pre>
1.75 rillig 2799: <p>If for some reason your last build didn't complete (power
1.87 wiz 2800: failure, system panic, ...), you can continue it by
2801: running:</p>
1.75 rillig 2802: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2803: <p>At the end of the bulk build, you will get a summary via mail,
2804: and find build logs in the directory specified by
2805: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2806: file.</p>
1.75 rillig 2807: </div>
1.148 asau 2808: <div class="sect2">
1.75 rillig 2809: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2810: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75 rillig 2811: <p>The bulk builds consist of three steps:</p>
1.148 asau 2812: <div class="variablelist"><dl class="variablelist">
1.75 rillig 2813: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2814: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2815: cleans out any broken distfiles, and removes all
2816: packages installed.</p></dd>
1.75 rillig 2817: <dt><span class="term">2. the bulk build</span></dt>
1.128 wiz 2818: <dd><p>This is basically <span class="quote">“<span class="quote">make bulk-package</span>”</span> with
1.87 wiz 2819: an optimised order in which packages will be
2820: built. Packages that don't require other packages will
2821: be built first, and packages with many dependencies will
2822: be built later.</p></dd>
1.75 rillig 2823: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2824: <dd><p>Generates a report that's placed in the directory
2825: specified in the <code class="filename">build.conf</code> file
2826: named <code class="filename">broken.html</code>, a short version
2827: of that report will also be mailed to the build's
2828: admin.</p></dd>
1.75 rillig 2829: </dl></div>
1.87 wiz 2830: <p>During the build, a list of broken packages will be compiled
2831: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2832: <code class="filename">.../.broken.${MACHINE}</code> if
2833: <code class="varname">OBJMACHINE</code> is set), individual build logs
2834: of broken builds can be found in the package's
2835: directory. These files are used by the bulk-targets to mark
2836: broken builds to not waste time trying to rebuild them, and
2837: they can be used to debug these broken package builds
2838: later.</p>
1.75 rillig 2839: </div>
1.148 asau 2840: <div class="sect2">
1.75 rillig 2841: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2842: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75 rillig 2843: <p>Currently, roughly the following requirements are valid for
1.169 jnemeth 2844: NetBSD 6.99/amd64:</p>
1.148 asau 2845: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 jnemeth 2846: <li class="listitem"><p>40 GB - distfiles (NFS ok)</p></li>
2847: <li class="listitem"><p>30 GB - full set of all binaries (NFS ok)</p></li>
1.128 wiz 2848: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.87 wiz 2849: </ul></div>
2850: <p>Note that all pkgs will be de-installed as soon as they are
2851: turned into a binary package, and that sources are removed,
2852: so there is no excessively huge demand to disk
2853: space. Afterwards, if the package is needed again, it will
1.136 dholland 2854: 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.87 wiz 2855: there are no cycles wasted by recompiling.</p>
1.75 rillig 2856: </div>
1.148 asau 2857: <div class="sect2">
1.75 rillig 2858: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2859: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2860: <p>If you don't want all the packages nuked from a machine
2861: (rendering it useless for anything but pkg compiling), there
2862: is the possibility of doing the package bulk build inside a
2863: chroot environment.</p>
2864: <p>The first step is to set up a chroot sandbox,
2865: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2866: using null mounts, or manually.</p>
2867: <p>There is a shell script called
1.143 wiz 2868: <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.87 wiz 2869: up the sandbox environment using null mounts. It will also
2870: create a script called <code class="filename">sandbox</code> in the
2871: root of the sandbox environment, which will allow the null
1.110 hubertf 2872: mounts to be activated using the <span class="command"><strong>sandbox
1.87 wiz 2873: mount</strong></span> command and deactivated using the
1.110 hubertf 2874: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87 wiz 2875: <p>To set up a sandbox environment by hand, after extracting all
1.110 hubertf 2876: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87 wiz 2877: distribution DESTDIR=/usr/sandbox</strong></span> in
2878: <code class="filename">/usr/src/etc</code>, be sure the following items
2879: are present and properly configured:</p>
1.128 wiz 2880: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 2881: <li class="step">
1.75 rillig 2882: <p>Kernel</p>
2883: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2884: </li>
1.148 asau 2885: <li class="step">
1.76 rillig 2886: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2887: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2888: </li>
1.148 asau 2889: <li class="step">
1.91 rillig 2890: <p><code class="filename">/etc/resolv.conf</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a> and mail):</p>
1.75 rillig 2891: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2892: </li>
1.148 asau 2893: <li class="step">
1.75 rillig 2894: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2895: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2896: </li>
1.148 asau 2897: <li class="step">
1.91 rillig 2898: <p><code class="filename">/etc/localtime</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a>):</p>
1.75 rillig 2899: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2900: </li>
1.148 asau 2901: <li class="step">
1.76 rillig 2902: <p><code class="filename">/usr/src</code> (system sources,
1.168 wiz 2903: rarely used by packages if at all:</p>
1.75 rillig 2904: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2905: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2906: </li>
1.148 asau 2907: <li class="step">
1.76 rillig 2908: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2909: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2910: </li>
1.148 asau 2911: <li class="step">
1.76 rillig 2912: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2913: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2914: </li>
1.148 asau 2915: <li class="step">
1.75 rillig 2916: <p>Checkout pkgsrc via cvs into
1.87 wiz 2917: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2918: <pre class="screen">
2919: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2920: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2921: </pre>
1.75 rillig 2922: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2923: you do development in, as this will likely cause problems!</p>
1.75 rillig 2924: </li>
1.148 asau 2925: <li class="step"><p>Make
1.87 wiz 2926: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2927: <code class="filename">.../distfiles</code> point somewhere
2928: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.148 asau 2929: <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>
2930: <li class="step"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2931: </ol></div>
2932: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2933: the build with the following steps:</p>
2934: <pre class="screen">
2935: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2936: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2937: </pre>
2938: <p>This will just jump inside the sandbox and start building. At
2939: the end of the build, mail will be sent with the results of
2940: the build. Created binary pkgs will be in
2941: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2942: (wherever that points/mounts to/from).</p>
1.75 rillig 2943: </div>
1.148 asau 2944: <div class="sect2">
1.75 rillig 2945: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2946: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2947: <p>In addition to building a complete set of all packages in
2948: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2949: may be used to build a subset of the packages contained in
2950: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.110 hubertf 2951: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.148 asau 2952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2953: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
2954: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
2955: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
2956: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.75 rillig 2957: </ul></div>
1.87 wiz 2958: <p>will define the set of packages which should be built.
2959: The bulk build code will also include any packages which are
2960: needed as dependencies for the explicitly listed packages.</p>
2961: <p>One use of this is to do a bulk build with
2962: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2963: periodically to have a complete set of the binary packages
2964: needed for your site available without the overhead of
2965: building extra packages that are not needed.</p>
1.75 rillig 2966: </div>
1.148 asau 2967: <div class="sect2">
1.75 rillig 2968: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2969: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2970: <p>This section describes how pkgsrc developers can upload binary
2971: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2972: <p>If you would like to automatically create checksum files for the
2973: binary packages you intend to upload, remember to set
2974: <code class="varname">MKSUMS=yes</code> in your
2975: <code class="filename">mk/bulk/build.conf</code>.</p>
2976: <p>If you would like to PGP sign the checksum files (highly
2977: recommended!), remember to set
2978: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2979: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2980: your GPG password to sign the files before uploading everything.</p>
2981: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2982: set properly in your <code class="filename">mk/bulk/build.conf</code>
2983: file, i.e. adjust it to something like one of the following:</p>
1.132 spz 2984: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
2985: <p>Please use appropriate values for "20xxQy" (the branch),
2986: "a.b.c" (the OS version) and "arch" here. If your login on ftp.NetBSD.org
1.87 wiz 2987: is different from your local login, write your login directly
2988: into the variable, e.g. my local account is "feyrer", but for my
2989: login "hubertf", I use:</p>
1.132 spz 2990: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
1.87 wiz 2991: <p>A separate <code class="filename">upload</code> directory is used
2992: here to allow "closing" the directory during upload. To do
2993: so, run the following command on ftp.NetBSD.org next:</p>
1.132 spz 2994: <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.87 wiz 2995: <p>Before uploading the binary pkgs, ssh authentication needs
2996: to be set up. This example shows how to set up temporary keys
2997: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2998: (assuming that no keys should be present there usually):</p>
2999: <pre class="screen">
3000: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 3001: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
1.132 spz 3002: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t rsa</code></strong>
3003: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-rsa.pub</code></strong>
1.87 wiz 3004: </pre>
1.132 spz 3005: <p>Now take the output of <code class="filename">id-rsa.pub</code> and
1.87 wiz 3006: append it to your <code class="filename">~/.ssh/authorized_keys</code>
1.132 spz 3007: file on ftp.NetBSD.org. You should remove the key after the
1.87 wiz 3008: upload is done!</p>
3009: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 3010: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 3011: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
3012: <p>Now after all this works, you can exit the sandbox and start
3013: the upload:</p>
3014: <pre class="screen">
3015: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 3016: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 3017: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3018: </pre>
1.136 dholland 3019: <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
3020: <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.87 wiz 3021: upload. The upload script will take care of not uploading
1.127 spz 3022: restricted packages.</p>
1.128 wiz 3023: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 3024: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 3025: Gdd:x! </pre>
3026: <p>Use whatever is needed to remove the key you've entered
3027: before! Last, move the uploaded packages out of the
3028: <code class="filename">upload</code> directory to have them accessible
3029: to everyone:</p>
3030: <pre class="screen">
1.132 spz 3031: nbftp% <strong class="userinput"><code>cd /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy</code></strong>
1.75 rillig 3032: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3033: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.132 spz 3034: nbftp% <strong class="userinput"><code>chgrp -R netbsd .</code></strong>
3035: nbftp% <strong class="userinput"><code>find . -type d | xargs chmod 775</code></strong>
1.87 wiz 3036: </pre>
1.75 rillig 3037: </div>
3038: </div>
1.148 asau 3039: <div class="sect1">
1.75 rillig 3040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3041: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 3042: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 3043: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3044: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
3045: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 3046: </ul></div>
1.148 asau 3047: <div class="sect2">
1.116 rillig 3048: <div class="titlepage"><div><div><h3 class="title">
3049: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
1.117 jnemeth 3050: <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>
1.116 rillig 3051: <pre class="screen">
3052: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3053: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
3054: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
3055: </pre>
3056: <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.148 asau 3057: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3058: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
3059: <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>
3060: <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>
3061: <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>
3062: <li class="listitem"><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.116 rillig 3063: </ul></div>
3064: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
3065: <pre class="screen">
3066: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
3067: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
3068: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
3069: </pre>
3070: <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>
3071: </div>
1.148 asau 3072: <div class="sect2">
1.106 rillig 3073: <div class="titlepage"><div><div><h3 class="title">
1.116 rillig 3074: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114 jmcneill 3075: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116 rillig 3076: <p>TODO: continue writing</p>
1.106 rillig 3077: </div>
3078: </div>
1.148 asau 3079: <div class="sect1">
1.106 rillig 3080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3081: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 3082: <p>After your pkgsrc bulk-build has completed, you may wish to
3083: create a CD-ROM set of the resulting binary packages to assist
3084: in installing packages on other machines. The
1.91 rillig 3085: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87 wiz 3086: a simple tool for creating the ISO 9660 images.
1.110 hubertf 3087: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 3088: way that keeps all the dependencies for a given package on the same
3089: CD as that package.</p>
1.148 asau 3090: <div class="sect2">
1.75 rillig 3091: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3092: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 3093: <p>Complete documentation for cdpack is found in the cdpack(1)
3094: man page. The following short example assumes that the binary
3095: packages are left in
3096: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3097: sufficient disk space exists in <code class="filename">/u2</code> to
3098: hold the ISO 9660 images.</p>
3099: <pre class="screen">
3100: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3101: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3102: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3103: </pre>
3104: <p>If you wish to include a common set of files
3105: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3106: etc.) on each CD in the collection, then you need to create a
3107: directory which contains these files. e.g.</p>
3108: <pre class="screen">
3109: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3110: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3111: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3112: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3113: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3114: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3115: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3116: </pre>
1.75 rillig 3117: <p>Now create the images:</p>
3118: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76 rillig 3119: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3120: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3121: in their root directories.</p>
1.75 rillig 3122: </div>
3123: </div>
3124: </div>
1.148 asau 3125: <div class="chapter">
1.75 rillig 3126: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3127: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 3128: <div class="toc">
3129: <p><b>Table of Contents</b></p>
3130: <dl>
1.128 wiz 3131: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
3132: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90 rillig 3133: </dl>
3134: </div>
3135: <p>The files that are installed by pkgsrc are organized in a way that
3136: is similar to what you find in the <code class="filename">/usr</code> directory
3137: of the base system. But some details are different. This is because
3138: pkgsrc initially came from FreeBSD and had adopted its file system
3139: hierarchy. Later it was largely influenced by NetBSD. But no matter
3140: which operating system you are using pkgsrc with, you can expect the
3141: same layout for pkgsrc.</p>
1.91 rillig 3142: <p>There are mainly four root directories for pkgsrc, which are all
3143: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3144: When pkgsrc has been installed as root, the default locations
3145: are:</p>
3146: <pre class="programlisting">
1.100 rillig 3147: LOCALBASE= /usr/pkg
3148: PKG_SYSCONFBASE= /usr/pkg/etc
3149: VARBASE= /var
3150: PKG_DBDIR= /var/db/pkg
1.91 rillig 3151: </pre>
3152: <p>In unprivileged mode (when pkgsrc has been installed as any other
3153: user), the default locations are:</p>
3154: <pre class="programlisting">
1.100 rillig 3155: LOCALBASE= ${HOME}/pkg
3156: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3157: VARBASE= ${HOME}/pkg/var
3158: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3159: </pre>
3160: <p>What these four directories are for, and what they look like is
3161: explained below.</p>
1.148 asau 3162: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3163: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 3164: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 3165: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 3166: the well-known subdirectories like <code class="filename">bin</code>,
3167: <code class="filename">include</code>, <code class="filename">lib</code>,
3168: <code class="filename">share</code> and
3169: <code class="filename">sbin</code>.</p></li>
1.128 wiz 3170: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 3171: <code class="filename">/var</code> in the base system. Some programs (especially
3172: games, network daemons) need write access to it during normal
3173: operation.</p></li>
1.128 wiz 3174: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 3175: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 3176: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90 rillig 3177: itself.</p></li>
3178: </ul></div>
1.148 asau 3179: <div class="sect1">
1.90 rillig 3180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3181: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 3182: </h2></div></div></div>
1.90 rillig 3183: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3184: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 3185: <div class="variablelist"><dl class="variablelist">
1.90 rillig 3186: <dt><span class="term"><code class="filename">bin</code></span></dt>
3187: <dd><p>Contains executable programs that are intended to be
3188: directly used by the end user.</p></dd>
3189: <dt><span class="term"><code class="filename">emul</code></span></dt>
3190: <dd><p>Contains files for the emulation layers of various other
3191: operating systems, especially for
3192: NetBSD.</p></dd>
3193: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3194: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3195: <dd><p>Contains
3196: the configuration files.</p></dd>
3197: <dt><span class="term"><code class="filename">include</code></span></dt>
3198: <dd><p>Contains headers for the C and C++ programming
3199: languages.</p></dd>
3200: <dt><span class="term"><code class="filename">info</code></span></dt>
3201: <dd><p>Contains GNU info files of various
3202: packages.</p></dd>
3203: <dt><span class="term"><code class="filename">lib</code></span></dt>
3204: <dd><p>Contains shared and static
3205: libraries.</p></dd>
3206: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3207: <dd><p>Contains data files that don't change after
3208: installation. Other data files belong into
3209: <code class="filename">${VARBASE}</code>.</p></dd>
3210: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3211: <dd><p>Contains programs that are not intended to be used by
3212: end users, such as helper programs or network
3213: daemons.</p></dd>
3214: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3215: <dd><p>Contains programs that are intended to be executed as
3216: CGI scripts by a web server.</p></dd>
3217: <dt><span class="term"><code class="filename">man</code> (the usual value of
3218: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3219: <dd><p>Contains brief
3220: documentation in form of manual pages.</p></dd>
3221: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3222: <dd><p>Contains programs that are intended to be used only by
3223: the super-user.</p></dd>
3224: <dt><span class="term"><code class="filename">share</code></span></dt>
3225: <dd><p>Contains platform-independent data files that don't
3226: change after installation.</p></dd>
3227: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3228: <dd><p>Contains documentation files provided by the
3229: packages.</p></dd>
3230: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3231: <dd><p>Contains example files provided by the packages. Among
3232: others, the original configuration files are saved here and copied to
3233: <code class="filename">${PKG_SYSCONFDIR}</code> during
3234: installation.</p></dd>
3235: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3236: <dd><p>Contains the original files for rc.d
3237: scripts.</p></dd>
3238: <dt><span class="term"><code class="filename">var</code> (the usual location of
3239: <code class="filename">${VARBASE}</code>)</span></dt>
3240: <dd><p>Contains files
3241: that may be modified after
3242: installation.</p></dd>
3243: </dl></div>
3244: </div>
1.148 asau 3245: <div class="sect1">
1.90 rillig 3246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3247: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 3248: </h2></div></div></div>
1.148 asau 3249: <div class="variablelist"><dl class="variablelist">
1.90 rillig 3250: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3251: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3252: <dd><p>Contains
3253: information about the currently installed
3254: packages.</p></dd>
3255: <dt><span class="term"><code class="filename">games</code></span></dt>
3256: <dd><p>Contains highscore
3257: files.</p></dd>
3258: <dt><span class="term"><code class="filename">log</code></span></dt>
3259: <dd><p>Contains log files.</p></dd>
3260: <dt><span class="term"><code class="filename">run</code></span></dt>
3261: <dd><p>Contains informational files about daemons that are
3262: currently running.</p></dd>
3263: </dl></div>
3264: </div>
3265: </div>
1.148 asau 3266: <div class="chapter">
1.90 rillig 3267: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3268: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3269: <div class="toc">
3270: <p><b>Table of Contents</b></p>
3271: <dl>
1.106 rillig 3272: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3273: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3274: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3275: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3276: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3277: <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>
3278: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.128 wiz 3279: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106 rillig 3280: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.128 wiz 3281: <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
3282: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
3283: <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.106 rillig 3284: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3285: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3286: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.128 wiz 3287: <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.106 rillig 3288: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.128 wiz 3289: <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.75 rillig 3290: </dl>
3291: </div>
3292: <p>This section contains hints, tips & tricks on special things in
3293: pkgsrc that we didn't find a better place for in the previous chapters, and
3294: it contains items for both pkgsrc users and developers.</p>
1.148 asau 3295: <div class="sect1">
1.75 rillig 3296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3297: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3298: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 3299: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3300: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 3301: This is a general purpose list for most issues regarding
3302: pkgsrc, regardless of platform, e.g. soliciting user help
3303: for pkgsrc configuration, unexpected build failures, using
3304: particular packages, upgrading pkgsrc installations,
3305: questions regarding the pkgsrc release branches, etc. General announcements or
3306: proposals for changes that impact the pkgsrc user community,
3307: e.g. major infrastructure changes, new features, package
3308: removals, etc., may also be posted.</p></li>
1.128 wiz 3309: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 3310: A list where the results of pkgsrc bulk builds are sent and
3311: discussed.</p></li>
1.128 wiz 3312: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 3313: This list is for those who are interested in getting a
3314: commit message for every change committed to pkgsrc. It is
3315: also available in digest form, meaning one daily message
3316: containing all commit messages for changes to the package
3317: source tree in that 24 hour period.</p></li>
3318: </ul></div>
3319: <p>To subscribe, do:</p>
3320: <pre class="programlisting">
1.100 rillig 3321: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 3322: </pre>
3323: <p>Archives for all these mailing lists are available from
1.110 hubertf 3324: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 3325: </div>
1.148 asau 3326: <div class="sect1">
1.75 rillig 3327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3328: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3329: <p>Pkgviews is tightly integrated with buildlink. You can find a
3330: pkgviews User's guide in
1.76 rillig 3331: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3332: </div>
1.148 asau 3333: <div class="sect1">
1.75 rillig 3334: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3335: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3336: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3337: a number of useful utilities for both users and developers of pkgsrc. This
3338: section attempts only to make the reader aware of the utilities and when
3339: they might be useful, and not to duplicate the documentation that comes
3340: with each package.</p>
3341: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.148 asau 3342: <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.75 rillig 3343: Symlinks for use by buildlink.</p></li></ul></div>
3344: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 3345: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3346: <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.75 rillig 3347: Calculates various kinds of checksums (including SHA1).</p></li>
1.128 wiz 3348: <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.75 rillig 3349: Compatibility library for pkgsrc tools.</p></li>
1.128 wiz 3350: <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.87 wiz 3351: non-BSD systems due to lack of native mtree.</p></li>
1.128 wiz 3352: <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.75 rillig 3353: Up-to-date replacement for
1.76 rillig 3354: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3355: systems where pkg_install is not present.</p></li>
3356: </ul></div>
3357: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 3358: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3359: <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.75 rillig 3360: Create a binary package from an
1.110 hubertf 3361: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 3362: save the old package.</p></li>
1.128 wiz 3363: <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.75 rillig 3364: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3365: from multiple locations. It currently supports the following
3366: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.128 wiz 3367: <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.75 rillig 3368: packages someplace else (enabled by default).</p></li>
1.128 wiz 3369: <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.117 jnemeth 3370: the best compiler flags to optimise code for your current
1.128 wiz 3371: CPU and compiler. </p></li>
1.75 rillig 3372: </ul></div>
3373: <p>Utilities for keeping track of installed packages, being up to date,
3374: etc:</p>
1.148 asau 3375: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3376: <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.75 rillig 3377: packages whose installed versions do not match the latest pkgsrc
3378: entries.</p></li>
1.128 wiz 3379: <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.75 rillig 3380: dependency graphs of packages, to aid in choosing a strategy for
3381: updating.</p></li>
1.128 wiz 3382: <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.91 rillig 3383: 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.128 wiz 3384: <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.112 weinem 3385: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.128 wiz 3386: <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.75 rillig 3387: does various checks on the complete pkgsrc system.</p></li>
1.128 wiz 3388: <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.75 rillig 3389: packages you have installed.</p></li>
3390: </ul></div>
3391: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 3392: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3393: <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.75 rillig 3394: making and maintaining patches for a package (includes pkgdiff,
3395: pkgvi, mkpatches, etc.).</p></li>
1.128 wiz 3396: <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.91 rillig 3397: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75 rillig 3398: converting to pkgsrc.</p></li>
1.128 wiz 3399: <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.75 rillig 3400: pkgsrc to a Solaris package.</p></li>
3401: </ul></div>
3402: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3403: utilities)</p>
1.148 asau 3404: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3405: <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.75 rillig 3406: packages in a chrooted area.</p></li>
1.128 wiz 3407: <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.75 rillig 3408: kernel version for chrooted cross builds.</p></li>
3409: </ul></div>
3410: </div>
1.148 asau 3411: <div class="sect1">
1.75 rillig 3412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3413: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3414: <p>If you want to use pkgsrc as non-root user, you can set some
3415: variables to make pkgsrc work under these conditions. At the very least,
1.128 wiz 3416: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.75 rillig 3417: will turn on unprivileged mode and set multiple related variables to allow
3418: installation of packages as non-root.</p>
3419: <p>In case the defaults are not enough, you may want to tune some other
3420: variables used. For example, if the automatic user/group detection leads
3421: to incorrect values (or not the ones you would like to use), you can change
3422: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3423: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3424: <p>As regards bootstrapping, please note that the
1.110 hubertf 3425: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128 wiz 3426: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.76 rillig 3427: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3428: installation targets. These directories can be overridden by the
1.128 wiz 3429: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.75 rillig 3430: that allow finer tuning of the tree layout.</p>
3431: </div>
1.148 asau 3432: <div class="sect1">
1.75 rillig 3433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3434: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3435: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3436: enable this feature by adding the option
3437: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3438: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3439: distfile is found, pkgsrc will try to resume it.</p>
3440: <p>You can also
1.168 wiz 3441: use a different program than the platform default program by changing the
1.117 jnemeth 3442: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3443: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3444: by using the value manual. A value of custom disables the system defaults
3445: and dependency tracking for the fetch program. In that case you have to
3446: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3447: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3448: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3449: <p>For example, if you want to use
1.117 jnemeth 3450: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3451: like:</p>
3452: <pre class="programlisting">
1.117 jnemeth 3453: FETCH_USING= wget
1.1 grant 3454: </pre>
1.75 rillig 3455: </div>
1.148 asau 3456: <div class="sect1">
1.75 rillig 3457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3458: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 3459: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3460: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3461: you will have to add the following line into
1.110 hubertf 3462: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3463: <pre class="programlisting">
1.103 wiz 3464: X11_TYPE=modular
1.1 grant 3465: </pre>
1.148 asau 3466: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 3467: <h3 class="title">Note</h3>
1.103 wiz 3468: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3469: </p>
1.75 rillig 3470: </div>
3471: </div>
1.148 asau 3472: <div class="sect1">
1.75 rillig 3473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3474: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3475: <p>If you are sitting behind a firewall which does not allow direct
3476: connections to Internet hosts (i.e. non-NAT), you may specify the
3477: relevant proxy hosts. This is done using an environment variable in the
3478: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 3479: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 3480: port 80 as the proxy port number. So the proxy environment variables
3481: are:</p>
3482: <pre class="programlisting">
1.100 rillig 3483: ftp_proxy=ftp://orpheus.amdahl.com:80/
3484: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3485: </pre>
1.75 rillig 3486: </div>
1.148 asau 3487: <div class="sect1">
1.75 rillig 3488: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 3489: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 3490: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3491: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3492: the first available command from the following list:</p>
1.148 asau 3493: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3494: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3495: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3496: </ul></div>
3497: <p>On a default NetBSD installation, this will be
1.76 rillig 3498: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3499: connections first, and falls back to active connections if the server
3500: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3501: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3502: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3503: <p>Having that option present will prevent
1.76 rillig 3504: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3505: transfers.</p>
3506: </div>
1.148 asau 3507: <div class="sect1">
1.75 rillig 3508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3509: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3510: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3511: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 3512: 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.75 rillig 3513: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3514: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3515: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3516: resulting list to your machine at work/school and use it there. If you
1.136 dholland 3517: 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.75 rillig 3518: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3519: URL:</p>
3520: <p>At home:</p>
3521: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3522: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3523: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3524: <p>At work:</p>
3525: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3526: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3527: home.</p>
3528: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3529: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3530: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3531: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3532: directly by running:</p>
1.75 rillig 3533: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3534: <p>If you even decide to ignore
3535: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3536: by running:</p>
3537: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3538: </div>
1.148 asau 3539: <div class="sect1">
1.75 rillig 3540: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 wiz 3541: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
3542: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.91 rillig 3543: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75 rillig 3544: package, you get the error from make that it doesn't know how to make
1.76 rillig 3545: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3546: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3547: the NetBSD base distribution on your machine. It is recommended to do
3548: that to format man pages.</p>
1.91 rillig 3549: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75 rillig 3550: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3551: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3552: </div>
1.148 asau 3553: <div class="sect1">
1.75 rillig 3554: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 wiz 3555: <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.87 wiz 3556: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3557: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3558: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3559: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3560: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3561: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3562: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3563: -r</strong></span>).</p>
3564: </div>
1.148 asau 3565: <div class="sect1">
1.75 rillig 3566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3567: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3568: <p>When installing packages as non-root user and using the just-in-time
1.136 dholland 3569: <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.75 rillig 3570: password for each required package installed. To avoid this, the sudo
3571: package can be used, which does password caching over a limited time. To
3572: use it, install sudo (either as binary package or from
1.98 wiz 3573: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110 hubertf 3574: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3575: <span class="emphasis"><em>after</em></span> the definition of the
3576: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3577: <pre class="programlisting">
1.100 rillig 3578: .if exists(${LOCALBASE}/bin/sudo)
3579: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3580: .endif
1.1 grant 3581: </pre>
1.75 rillig 3582: </div>
1.148 asau 3583: <div class="sect1">
1.75 rillig 3584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3585: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3586: <p>As the system administrator, you can choose where configuration files
3587: are installed. The default settings make all these files go into
1.76 rillig 3588: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3589: be suboptimal depending on your expectations (e.g., a read-only,
3590: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3591: configuration of the provided packages).</p>
3592: <p>In order to change the defaults, you can modify the
3593: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3594: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3595: directory; some common examples include <code class="filename">/etc</code> or
3596: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3597: <p>Furthermore, you can change this value on a per-package basis by
3598: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3599: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3600: package you would like to modify, that is, the contents of
3601: <code class="varname">PKGBASE</code>.</p>
3602: <p>Note that after changing these settings, you must rebuild and
3603: reinstall any affected packages.</p>
3604: </div>
1.148 asau 3605: <div class="sect1">
1.75 rillig 3606: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3607: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 3608: <p>Please be aware that there can often be bugs in third-party software,
3609: and some of these bugs can leave a machine vulnerable to exploitation by
3610: attackers. In an effort to lessen the exposure, the NetBSD packages team
3611: maintains a database of known-exploits to packages which have at one time
3612: been included in pkgsrc. The database can be downloaded automatically, and
3613: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3614: do this, refer to the following two tools (installed as part of the
3615: <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.128 wiz 3616: <div class="orderedlist"><ol class="orderedlist" type="1">
3617: <li class="listitem">
1.122 reed 3618: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3619: download a list of the security vulnerabilities information. This list
1.132 spz 3620: is kept up to date by the pkgsrc security team, and is distributed
3621: from the NetBSD ftp server:</p>
3622: <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.75 rillig 3623: </li>
1.128 wiz 3624: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3625: current machine, checking each known vulnerability. If a
1.75 rillig 3626: vulnerable package is installed, it will be shown by output to stdout,
3627: including a description of the type of vulnerability, and a URL
3628: containing more information.</p></li>
3629: </ol></div>
1.114 jmcneill 3630: <p>Use of these tools is strongly recommended! After
1.128 wiz 3631: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.75 rillig 3632: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3633: pkg_install</code></strong>.</p>
1.87 wiz 3634: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3635: perform a security check before building any package. See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, “Variables affecting the build process”</a> for ways to control this
1.87 wiz 3636: check.</p>
1.75 rillig 3637: </div>
1.148 asau 3638: <div class="sect1">
1.75 rillig 3639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3640: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3641: <p>When you add your own preferences to the
3642: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3643: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3644: environment variables to the <code class="filename">./configure</code>
1.136 dholland 3645: 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.75 rillig 3646: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3647: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3648: package.</p>
3649: <p>Currently there is no solution to this problem. If you
3650: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3651: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3652: directory and then inspect any <code class="filename">Makefile</code> and
3653: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3654: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3655: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3656: programmers write so bad code that it only works for the
3657: specific combination of <code class="varname">CFLAGS</code> they have
3658: chosen.</p>
3659: </div>
1.148 asau 3660: <div class="sect1">
1.80 rillig 3661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3662: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3663: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3664: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3665: case that occurs often is that people only update pkgsrc in
3666: parts, because of performance reasons. Since pkgsrc is one large
3667: system, not a collection of many small systems, there are
3668: sometimes changes that only work when the whole pkgsrc tree is
3669: updated.</p></li>
1.148 asau 3670: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3671: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3672: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3673: files.</p></li>
1.148 asau 3674: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3675: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3676: verify this.</p></li>
1.148 asau 3677: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3678: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3679: </ol></div>
3680: </div>
1.148 asau 3681: <div class="sect1">
1.88 wiz 3682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 wiz 3683: <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.89 rillig 3684: <p>You have modified a file from pkgsrc, and someone else has
3685: modified that same file afterwards in the CVS repository. Both changes
3686: are in the same region of the file, so when you updated pkgsrc, the
3687: <code class="literal">cvs</code> command marked the conflicting changes in the
3688: file. Because of these markers, the file is no longer a valid
3689: <code class="filename">Makefile</code>.</p>
3690: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3691: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3692: -dP</strong></span> in that directory to download the current version.</p>
3693: </div>
1.75 rillig 3694: </div>
3695: </div>
1.148 asau 3696: <div class="part">
1.75 rillig 3697: <div class="titlepage"><div><div><h1 class="title">
3698: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3699: <div class="partintro">
1.77 rillig 3700: <div></div>
3701: <p>This part of the book deals with creating and
1.128 wiz 3702: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3703: guide on creating a new package. The remaining chapters are more
3704: like a reference manual for pkgsrc.</p>
1.75 rillig 3705: <div class="toc">
3706: <p><b>Table of Contents</b></p>
3707: <dl>
1.106 rillig 3708: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3709: <dd><dl>
1.106 rillig 3710: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3711: <dd><dl>
1.106 rillig 3712: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3713: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3714: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3715: </dl></dd>
1.106 rillig 3716: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3717: <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>
3718: </dl></dd>
3719: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3720: <dd><dl>
1.128 wiz 3721: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3722: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3723: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3724: <dd><dl>
3725: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3726: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3727: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3728: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3729: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3730: </dl></dd>
3731: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3732: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3733: <dd><dl>
3734: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3735: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3736: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3737: </dl></dd>
1.128 wiz 3738: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3739: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3740: </dl></dd>
1.128 wiz 3741: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3742: <dd><dl>
3743: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 3744: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 3745: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3746: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3747: <dd><dl>
3748: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3749: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3750: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3751: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3752: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3753: </dl></dd>
3754: </dl></dd>
3755: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3756: <dd><dl>
3757: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 3758: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3759: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 3760: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3761: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 3762: <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.106 rillig 3763: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3764: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3765: </dl></dd>
3766: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3767: <dd><dl>
3768: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 3769: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3770: <dd><dl>
3771: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 3772: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3773: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3774: and
3775: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3776: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3777: </dl></dd>
1.128 wiz 3778: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106 rillig 3779: <dd><dl>
1.128 wiz 3780: <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.106 rillig 3781: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3782: </dl></dd>
3783: </dl></dd>
3784: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3785: <dd><dl>
3786: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3787: <dd><dl>
3788: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3789: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3790: </dl></dd>
3791: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3792: <dd><dl>
1.128 wiz 3793: <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.106 rillig 3794: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3795: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3796: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3797: </dl></dd>
3798: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3799: <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>
3800: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3801: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3802: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3803: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3804: <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>
3805: </dl></dd>
3806: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3807: <dd><dl>
3808: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 3809: <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.106 rillig 3810: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3811: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3812: </dl></dd>
3813: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3814: <dd><dl>
3815: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3816: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3817: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3818: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 3819: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 3820: <dd><dl>
3821: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3822: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3823: </dl></dd>
1.128 wiz 3824: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3825: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3826: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3827: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3828: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3829: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3830: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3831: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3832: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3833: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 3834: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3835: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3836: </dl></dd>
3837: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3838: <dd><dl>
3839: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3840: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3841: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3842: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3843: </dl></dd>
3844: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3845: <dd><dl>
3846: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3847: <dd><dl>
3848: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 3849: <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.106 rillig 3850: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3851: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3852: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3853: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3854: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3855: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3856: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3857: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3858: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3859: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3860: </dl></dd>
1.128 wiz 3861: <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.106 rillig 3862: <dd><dl>
3863: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3864: <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>
3865: </dl></dd>
1.128 wiz 3866: <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.106 rillig 3867: <dd><dl>
3868: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3869: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3870: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3871: </dl></dd>
3872: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3873: <dd><dl>
3874: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3875: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3876: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 3877: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3878: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 3879: </dl></dd>
1.128 wiz 3880: <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.106 rillig 3881: <dd><dl>
3882: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3883: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 3884: <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.106 rillig 3885: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3886: </dl></dd>
1.128 wiz 3887: <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.106 rillig 3888: <dd><dl>
3889: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3890: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3891: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3892: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3893: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3894: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3895: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3896: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3897: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3898: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3899: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3900: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3901: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3902: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3903: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3904: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3905: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3906: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3907: emulation</a></span></dt>
1.106 rillig 3908: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3909: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3910: </dl></dd>
1.106 rillig 3911: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3912: </dl></dd>
1.106 rillig 3913: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3914: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3915: <dd><dl>
1.106 rillig 3916: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3917: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3918: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140 wiz 3919: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 3920: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3921: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3922: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3923: </dl></dd>
3924: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3925: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3926: <dd><dl>
3927: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3928: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3929: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3930: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3931: </dl></dd>
1.75 rillig 3932: </dl>
3933: </div>
1.77 rillig 3934: </div>
1.148 asau 3935: <div class="chapter">
1.77 rillig 3936: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3937: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3938: <div class="toc">
3939: <p><b>Table of Contents</b></p>
3940: <dl>
1.106 rillig 3941: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3942: <dd><dl>
1.106 rillig 3943: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3944: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3945: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3946: </dl></dd>
1.106 rillig 3947: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3948: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91 rillig 3949: </dl>
3950: </div>
1.77 rillig 3951: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3952: most likely have a URL from where you can download the source
3953: code. Starting with this URL, creating a package involves only a
3954: few steps.</p>
1.128 wiz 3955: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3956: <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>
3957: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 3958: category in which you want to place your package. You can also create a
3959: directory of your own (maybe called <code class="filename">local</code>). In that
3960: category directory, create another directory for your package and change
3961: into it.</p></li>
1.148 asau 3962: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3963: you for a URL. Enter the URL of the distribution file (in most cases a
3964: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3965: of your package are created automatically. The distribution file is
3966: extracted automatically to fill in some details in the
3967: <code class="filename">Makefile</code> that would otherwise have to be done
3968: manually.</p></li>
1.148 asau 3969: <li class="step">
1.91 rillig 3970: <p>Examine the extracted files to determine the dependencies of
3971: your package. Ideally, this is mentioned in some
3972: <code class="filename">README</code> file, but things may differ. For each of
3973: these dependencies, look where it exists in pkgsrc, and if there is a
3974: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3975: line to your package <code class="filename">Makefile</code> which includes that
3976: file just before the last line. If the
1.132 spz 3977: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3978: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3979: <p>If you just need binaries from a package, add a
1.91 rillig 3980: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3981: version of the dependency and where it can be found in pkgsrc. This line
3982: should be placed in the third paragraph. If the dependency is only
3983: needed for building the package, but not when using it, use
3984: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3985: Your package may then look like this:</p>
1.77 rillig 3986: <pre class="programlisting">
1.100 rillig 3987: [...]
1.77 rillig 3988:
1.100 rillig 3989: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3990: DEPENDS+= screen-[0-9]*:../../misc/screen
3991: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3992:
1.100 rillig 3993: [...]
1.77 rillig 3994:
1.100 rillig 3995: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3996: .include "../../devel/glib2/buildlink3.mk"
3997: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3998: </pre>
3999: </li>
1.148 asau 4000: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 wiz 4001: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.110 hubertf 4002: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
4003: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 4004: -e</strong></span>, which outputs additional
4005: explanations.</p></li>
1.148 asau 4006: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 4007: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, “Common types of packages”</a>. After you have followed the instructions
1.91 rillig 4008: over there, you can hopefully continue here.</p></li>
1.148 asau 4009: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 4010: directory from the extracted files. Besides these files, a lot of cache
4011: files and other system information has been saved in the working
4012: directory, which may become wrong after you edited the
4013: <code class="filename">Makefile</code>.</p></li>
1.148 asau 4014: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 4015: 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.148 asau 4016: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 4017: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 4018: everything works.</p></li>
1.148 asau 4019: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 4020: contains a list of the files that are installed by the package, is
1.110 hubertf 4021: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 4022: >PLIST</strong></span> to generate a probably correct list. Check
4023: the file using your preferred text editor to see if the list of
4024: files looks plausible.</p></li>
1.148 asau 4025: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 4026: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 4027: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 4028: has been registered in the database of installed files, but with an
1.110 hubertf 4029: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
4030: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 4031: registered with the list of files from
4032: <code class="filename">PLIST</code>.</p></li>
1.148 asau 4033: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 4034: package from the set of installed files.</p></li>
1.77 rillig 4035: </ol></div>
1.148 asau 4036: <div class="sect1">
1.91 rillig 4037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4038: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 asau 4039: <div class="sect2">
1.91 rillig 4040: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4041: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 4042: <p>Simple Perl modules are handled automatically by
1.110 hubertf 4043: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 4044: </div>
1.148 asau 4045: <div class="sect2">
1.91 rillig 4046: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4047: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91 rillig 4048: <p>KDE applications should always include
4049: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
4050: settings that are typical of KDE packages.</p>
4051: </div>
1.148 asau 4052: <div class="sect2">
1.118 imil 4053: <div class="titlepage"><div><div><h3 class="title">
4054: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
4055: <p>Python modules and programs packages are easily created using a
4056: set of predefined variables.</p>
4057: <p>
1.171 wiz 4058: If some Python versions are not supported by the software, set the
4059: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
4060: that are not supported, e.g.
1.118 imil 4061: </p>
4062: <pre class="programlisting">
1.172 ! wiz 4063: PYTHON_VERSIONS_INCOMPATIBLE= 26
1.118 imil 4064: </pre>
4065: <p>
4066: If the packaged software is a Python module, include
1.128 wiz 4067: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 4068: In this case, the package directory should be called
1.128 wiz 4069: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
4070: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 4071: </p>
4072: <pre class="programlisting">
4073: DISTNAME= foopymodule-1.2.10
4074: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
4075: </pre>
1.171 wiz 4076: <p>If it is an application, include
4077: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
4078: In order to correctly set the path to the Python interpreter, use the
1.118 imil 4079: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 4080: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 4081: For example:
1.118 imil 4082: </p>
4083: <pre class="programlisting">
1.142 wiz 4084: REPLACE_PYTHON= *.py
1.118 imil 4085: </pre>
1.171 wiz 4086: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
4087: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
4088: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
4089: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
4090: so pkgsrc will use this framework.
4091: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
4092: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
4093: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
4094: to the name of the script.</p>
4095: <p>Otherwise, if the packaged software is egg-aware, you only need
4096: to include
4097: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
4098: <p>Some Python modules have separate distributions for Python-2.x
4099: and Python-3.x support. In pkgsrc this is handled by the
4100: <code class="filename">versioned_dependencies.mk</code> file. Set
4101: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
4102: packages that should be depended upon and include
4103: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
4104: then the pkgsrc infrastructure will depend on the appropriate package
4105: version. For example:
4106: </p>
4107: <pre class="programlisting">
4108: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
4109: </pre>
4110: <p>
4111: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
4112: of supported packages.</p>
1.118 imil 4113: </div>
1.91 rillig 4114: </div>
1.148 asau 4115: <div class="sect1">
1.91 rillig 4116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4117: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 asau 4118: <div class="sect2">
1.91 rillig 4119: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4120: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 4121: <div class="sect3">
1.91 rillig 4122: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4123: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 4124: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 4125: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 4126: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 4127: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 4128: <pre class="programlisting">
1.100 rillig 4129: <code class="prompt">$</code> mkdir www/nvu
4130: <code class="prompt">$</code> cd www/nvu
1.91 rillig 4131: </pre>
4132: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 4133: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 4134: <pre class="programlisting">
1.100 rillig 4135: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 4136: </pre>
4137: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4138: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 4139: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 4140: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4141: <code class="varname">COMMENT</code> fields. Then the package
4142: <code class="filename">Makefile</code> looked like that:</p>
4143: <pre class="programlisting">
1.100 rillig 4144: # $NetBSD$
4145: #
1.91 rillig 4146:
1.100 rillig 4147: DISTNAME= nvu-1.0-sources
4148: PKGNAME= nvu-1.0
4149: CATEGORIES= www
4150: MASTER_SITES= http://cvs.nvu.com/download/
4151: EXTRACT_SUFX= .tar.bz2
4152:
4153: MAINTAINER= rillig@NetBSD.org
4154: HOMEPAGE= http://cvs.nvu.com/
4155: COMMENT= Web Authoring System
1.91 rillig 4156:
1.100 rillig 4157: # url2pkg-marker (please do not remove this line.)
4158: .include "../../mk/bsd.pkg.mk"
1.91 rillig 4159: </pre>
4160: <p>Then, I quit the editor and watched pkgsrc downloading a large
4161: source archive:</p>
4162: <pre class="programlisting">
1.100 rillig 4163: url2pkg> Running "make makesum" ...
4164: => Required installed package digest>=20010302: digest-20060826 found
4165: => Fetching nvu-1.0-sources.tar.bz2
4166: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4167: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4168: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4169: url2pkg> Running "make extract" ...
4170: => Required installed package digest>=20010302: digest-20060826 found
4171: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4172: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4173: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4174: ===> Installing dependencies for nvu-1.0
4175: ===> Overriding tools for nvu-1.0
4176: ===> Extracting for nvu-1.0
4177: url2pkg> Adjusting the Makefile.
1.91 rillig 4178:
1.100 rillig 4179: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 4180:
1.100 rillig 4181: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 4182: </pre>
4183: </div>
1.148 asau 4184: <div class="sect3">
1.91 rillig 4185: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4186: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91 rillig 4187: <p>Now that the package has been extracted, let's see what's inside
4188: it. The package has a <code class="filename">README.txt</code>, but that only
4189: says something about mozilla, so it's probably useless for seeing what
4190: dependencies this package has. But since there is a GNU configure script
4191: in the package, let's hope that it will complain about everything it
4192: needs.</p>
4193: <pre class="programlisting">
1.100 rillig 4194: <code class="prompt">$</code> bmake
4195: => Required installed package digest>=20010302: digest-20060826 found
4196: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4197: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4198: ===> Patching for nvu-1.0
4199: ===> Creating toolchain wrappers for nvu-1.0
4200: ===> Configuring for nvu-1.0
4201: [...]
4202: configure: error: Perl 5.004 or higher is required.
4203: [...]
4204: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4205: [...]
1.91 rillig 4206: </pre>
4207: <p>That worked quite well. So I opened the package Makefile in my
4208: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 4209: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 4210: package have changed now, and since a perl wrapper is automatically
1.128 wiz 4211: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 4212: from scratch.</p>
4213: <pre class="programlisting">
1.100 rillig 4214: <code class="prompt">$</code> bmake clean
4215: ===> Cleaning for nvu-1.0
4216: <code class="prompt">$</code> bmake
4217: [...]
4218: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4219: GNU Make. You will not be able to build Mozilla without GNU Make.
4220: [...]
1.91 rillig 4221: </pre>
1.128 wiz 4222: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 4223: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4224: <pre class="programlisting">
1.100 rillig 4225: [...]
4226: checking for GTK - version >= 1.2.0... no
4227: *** Could not run GTK test program, checking why...
4228: [...]
1.91 rillig 4229: </pre>
4230: <p>Now to the other dependencies. The first question is: Where is the
4231: GTK package hidden in pkgsrc?</p>
4232: <pre class="programlisting">
1.100 rillig 4233: <code class="prompt">$</code> echo ../../*/gtk*
4234: [many packages ...]
4235: <code class="prompt">$</code> echo ../../*/gtk
4236: ../../x11/gtk
4237: <code class="prompt">$</code> echo ../../*/gtk2
4238: ../../x11/gtk2
4239: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4240: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4241: </pre>
4242: <p>The first try was definitely too broad. The second one had exactly
4243: one result, which is very good. But there is one pitfall with GNOME
4244: packages. Before GNOME 2 had been released, there were already many
4245: GNOME 1 packages in pkgsrc. To be able to continue to use these
4246: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 4247: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 4248: whether this was the case here, and indeed it was.</p>
4249: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4250: file, adding the dependency is very easy. I just inserted an
4251: <code class="literal">.include</code> line before the last line of the package
4252: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4253: <pre class="programlisting">
1.100 rillig 4254: [...]
4255: .include "../../x11/gtk2/buildlink3.mk"
4256: .include "../../mk/bsd.pkg.mk
1.91 rillig 4257: </pre>
1.110 hubertf 4258: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 4259: was:</p>
4260: <pre class="programlisting">
1.100 rillig 4261: [...]
4262: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4263: checking for GTK - version >= 1.2.0... no
4264: *** Could not run GTK test program, checking why...
4265: *** The test program failed to compile or link. See the file config.log for the
4266: *** exact error that occured. This usually means GTK was incorrectly installed
4267: *** or that you have moved GTK since it was installed. In the latter case, you
4268: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4269: configure: error: Test for GTK failed.
4270: [...]
1.91 rillig 4271: </pre>
1.128 wiz 4272: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
4273: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 4274: told me that this package really wanted to have the GNOME 1 version of
4275: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 4276: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 4277: So I changed the <code class="literal">x11/gtk2</code> to
4278: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4279: and tried again.</p>
4280: <pre class="programlisting">
1.100 rillig 4281: [...]
1.166 jnemeth 4282: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 4283: In file included from xpidl.c:42:
4284: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4285: In file included from xpidl.c:42:
4286: xpidl.h:132: error: parse error before "IDL_ns"
4287: [...]
1.91 rillig 4288: </pre>
4289: <p>The package still does not find all of its dependencies. Now the
4290: question is: Which package provides the
4291: <code class="filename">libIDL/IDL.h</code> header file?</p>
4292: <pre class="programlisting">
1.100 rillig 4293: <code class="prompt">$</code> echo ../../*/*idl*
4294: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4295: <code class="prompt">$</code> echo ../../*/*IDL*
4296: ../../net/libIDL
1.91 rillig 4297: </pre>
4298: <p>Let's take the one from the second try. So I included the
4299: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4300: again. But the error didn't change. After digging through some of the
4301: code, I concluded that the build process of the package was broken and
4302: couldn't have ever worked, but since the Mozilla source tree is quite
4303: large, I didn't want to fix it. So I added the following to the package
4304: <code class="filename">Makefile</code> and tried again:</p>
4305: <pre class="programlisting">
1.100 rillig 4306: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4307: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4308: </pre>
4309: <p>The latter line is needed because the package expects the library
4310: <code class="filename">libIDL.so</code>, but only
4311: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4312: wrapper to rewrite that on the fly.</p>
4313: <p>The next problem was related to a recent change of the FreeType
4314: 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>
4315: which patch files were relevant for this issue and copied them to the
4316: <code class="filename">patches</code> directory. Then I retried, fixed the
4317: patches so that they applied cleanly and retried again. This time,
4318: everything worked.</p>
4319: </div>
1.148 asau 4320: <div class="sect3">
1.91 rillig 4321: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4322: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 4323: <pre class="programlisting">
1.100 rillig 4324: <code class="prompt">$</code> bmake CHECK_FILES=no install
4325: [...]
4326: <code class="prompt">$</code> bmake print-PLIST >PLIST
4327: <code class="prompt">$</code> bmake deinstall
4328: <code class="prompt">$</code> bmake install
1.91 rillig 4329: </pre>
4330: </div>
4331: </div>
4332: </div>
1.77 rillig 4333: </div>
1.148 asau 4334: <div class="chapter">
1.75 rillig 4335: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4336: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4337: <div class="toc">
4338: <p><b>Table of Contents</b></p>
4339: <dl>
1.128 wiz 4340: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4341: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 4342: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4343: <dd><dl>
4344: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4345: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4346: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4347: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4348: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4349: </dl></dd>
4350: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4351: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4352: <dd><dl>
4353: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4354: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4355: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4356: </dl></dd>
1.128 wiz 4357: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4358: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4359: </dl>
4360: </div>
1.87 wiz 4361: <p>Whenever you're preparing a package, there are a number of
4362: files involved which are described in the following
4363: sections.</p>
1.148 asau 4364: <div class="sect1">
1.75 rillig 4365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4366: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 4367: </h2></div></div></div>
1.75 rillig 4368: <p>Building, installation and creation of a binary package are all
1.87 wiz 4369: controlled by the package's <code class="filename">Makefile</code>.
4370: The <code class="filename">Makefile</code> describes various things about
4371: a package, for example from where to get it, how to configure,
4372: build, and install it.</p>
1.76 rillig 4373: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4374: sections that describe the package.</p>
1.75 rillig 4375: <p>In the first section there are the following variables, which
1.87 wiz 4376: should appear exactly in the order given here. The order and
4377: grouping of the variables is mostly historical and has no further
4378: meaning.</p>
1.148 asau 4379: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4380: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4381: distribution file to be downloaded from the package's
4382: website.</p></li>
1.128 wiz 4383: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4384: package, as used by pkgsrc. You only need to provide it if
4385: <code class="varname">DISTNAME</code> (which is the default) is not a good
4386: name for the package in pkgsrc. Usually it is the pkgsrc
4387: directory name together with the version number. It must match the
4388: regular expression
4389: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4390: starts with a letter or digit, and contains only letters, digits,
4391: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 4392: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.87 wiz 4393: the package file to create if the <code class="varname">PKGNAME</code>
4394: isn't unique on a SVR4 system. The default is
4395: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4396: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
1.87 wiz 4397: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4398: does not produce an unique package name on a SVR4 system.
4399: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4400: characters.</p></li>
1.128 wiz 4401: <li class="listitem">
1.75 rillig 4402: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4403: which the package fits in. You can choose any of the top-level
4404: directories of pkgsrc for it.</p>
1.75 rillig 4405: <p>Currently the following values are available for
1.87 wiz 4406: <code class="varname">CATEGORIES</code>. If more than
4407: one is used, they need to be separated by spaces:</p>
1.75 rillig 4408: <pre class="programlisting">
1.100 rillig 4409: archivers cross geography meta-pkgs security
4410: audio databases graphics misc shells
4411: benchmarks devel ham multimedia sysutils
4412: biology editors inputmethod net textproc
4413: cad emulators lang news time
4414: chat finance mail parallel wm
4415: comms fonts math pkgtools www
4416: converters games mbone print x11
4417: </pre>
1.75 rillig 4418: </li>
1.128 wiz 4419: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4420: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4421: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4422: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 4423: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.75 rillig 4424: </ul></div>
4425: <p>The second section contains information about separately
1.87 wiz 4426: downloaded patches, if any.
4427: </p>
1.148 asau 4428: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4429: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4430: Name(s) of additional files that contain distribution patches.
4431: There is no default. pkgsrc will look for them at
4432: <code class="varname">PATCH_SITES</code>.
4433: They will automatically be uncompressed before patching if
4434: the names end with <code class="filename">.gz</code> or
4435: <code class="filename">.Z</code>.</p></li>
1.128 wiz 4436: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4437: Primary location(s) for distribution patch files (see
4438: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4439: </ul></div>
4440: <p>The third section contains the following variables.
1.87 wiz 4441: </p>
1.148 asau 4442: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4443: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4444: address of the person who feels responsible for this package,
4445: and who is most likely to look at problems or questions regarding
1.136 dholland 4446: 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.114 jmcneill 4447: Other developers may contact the <code class="varname">MAINTAINER</code>
4448: before making changes to the package, but are not required to
4449: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4450: to yourself. If you really can't maintain the package for future
4451: updates, set it to
1.110 hubertf 4452: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 4453: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4454: of <code class="varname">MAINTAINER</code> when you do not want other
4455: developers to update or change the package without contacting
4456: you first. A package Makefile should contain one of
4457: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4458: not both. </p></li>
1.128 wiz 4459: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4460: find more information about the package.</p></li>
1.128 wiz 4461: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4462: description of the package (should not include the package
4463: name).</p></li>
1.75 rillig 4464: </ul></div>
4465: <p>Other variables that affect the build:
1.87 wiz 4466: </p>
1.148 asau 4467: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 4468: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4469: interesting distribution files of the package are found. The
4470: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4471: works for most packages.</p>
1.75 rillig 4472: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4473: (most GNU software does, for instance), but extracts itself in
4474: the current directory, you should set
4475: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4476: <p>If a package doesn't create a subdirectory with the
4477: name of <code class="varname">DISTNAME</code> but some different name,
4478: set <code class="varname">WRKSRC</code> to point to the proper name in
4479: <code class="filename">${WRKDIR}</code>, for example
4480: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4481: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75 rillig 4482: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4483: taken from the <code class="varname">WRKDIR_BASENAME</code>
4484: variable. By default, its value is
4485: <code class="filename">work</code>. If you want to use the same
4486: pkgsrc tree for building different kinds of binary packages,
4487: you can change the variable according to your needs. Two
4488: other variables handle common cases of setting
4489: <code class="varname">WRKDIR_BASENAME</code> individually. If
4490: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4491: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4492: the host's name is attached to the directory name. If
4493: <code class="varname">OBJMACHINE</code> is defined, the platform name
4494: is attached, which might look like
4495: <code class="filename">work.i386</code> or
4496: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4497: </li></ul></div>
4498: <p>Please pay attention to the following gotchas:</p>
1.148 asau 4499: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4500: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4501: installed in compressed form by the package. For packages using
4502: BSD-style makefiles which honor MANZ, there is
4503: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 4504: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4505: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4506: below).</p></li>
1.128 wiz 4507: <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.75 rillig 4508: </ul></div>
4509: </div>
1.148 asau 4510: <div class="sect1">
1.75 rillig 4511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4512: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4513: </h2></div></div></div>
1.76 rillig 4514: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4515: digest, or checksum, of each distfile needed for the package. This
4516: ensures that the distfiles retrieved from the Internet have not been
4517: corrupted during transfer or altered by a malign force to introduce
4518: a security hole. Due to recent rumor about weaknesses of digest
4519: algorithms, all distfiles are protected using both SHA1 and RMD160
4520: message digests, as well as the file size.</p>
1.76 rillig 4521: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4522: checksums for all the patches found in the
1.110 hubertf 4523: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.76 rillig 4524: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4525: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4526: command.</p>
1.75 rillig 4527: <p>Some packages have different sets of distfiles depending on
1.128 wiz 4528: 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.87 wiz 4529: <code class="filename">distinfo</code> file and care should be taken when
4530: upgrading such a package to ensure distfile information is not
4531: lost.</p>
1.75 rillig 4532: </div>
1.148 asau 4533: <div class="sect1">
1.75 rillig 4534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4535: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4536: <p>Many packages still don't work out-of-the box on the various
4537: platforms that are supported by pkgsrc. Therefore, a number of custom
4538: patch files are needed to make the package work. These patch files are
4539: found in the <code class="filename">patches/</code> directory.</p>
4540: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4541: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4542: 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.130 wiz 4543: order</a>.</p>
1.148 asau 4544: <div class="sect2">
1.93 rillig 4545: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4546: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4547: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4548: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4549: problems. (To force patches to apply with fuzz you can set
4550: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4551: should contain only changes for a single file, and no file should be
1.93 rillig 4552: patched by more than one patch file. This helps to keep future
4553: modifications simple.</p>
4554: <p>Each patch file is structured as follows: In the first line,
4555: there is the RCS Id of the patch itself. The second line should be
4556: empty for aesthetic reasons. After that, there should be a comment for
4557: each change that the patch does. There are a number of standard
4558: cases:</p>
1.148 asau 4559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4560: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4561: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 4562: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4563: platform and other environment (for example, the compiler) that the
4564: patch is needed for.</p></li>
4565: </ul></div>
1.130 wiz 4566: <p>In all, the patch should be commented so that any
1.93 rillig 4567: developer who knows the code of the application can make some use of
4568: the patch. Special care should be taken for the upstream developers,
4569: since we generally want that they accept our patches, so we have less
4570: work in the future.</p>
4571: </div>
1.148 asau 4572: <div class="sect2">
1.93 rillig 4573: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4574: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4575: <p>One important thing to mention is to pay attention that no RCS
4576: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4577: later checked into the NetBSD CVS tree. Use the
1.110 hubertf 4578: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93 rillig 4579: problems.</p>
1.87 wiz 4580: <p>For even more automation, we recommend using
1.110 hubertf 4581: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4582: whole set of patches. You just have to backup files before you
4583: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4584: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4585: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4586: you upgrade a package this way, you can easily compare the new
4587: set of patches with the previously existing one with
1.130 wiz 4588: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4589: are replaced by new files, so carefully check if you want to take all
4590: the changes.</p>
1.87 wiz 4591: <p>When you have finished a package, remember to generate
1.110 hubertf 4592: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 4593: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.87 wiz 4594: <p>When adding a patch that corrects a problem in the
4595: distfile (rather than e.g. enforcing pkgsrc's view of where
4596: man pages should go), send the patch as a bug report to the
4597: maintainer. This benefits non-pkgsrc users of the package,
4598: and usually makes it possible to remove the patch in future
4599: version.</p>
1.101 rillig 4600: <p>The file names of the patch files are usually of the form
1.130 wiz 4601: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4602: Many packages still use the previous convention
4603: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4604: but new patches should be of the form containing the filename.
4605: <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
4606: automatically.</p>
1.93 rillig 4607: </div>
1.148 asau 4608: <div class="sect2">
1.93 rillig 4609: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4610: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4611: <p>If you want to share patches between multiple packages
4612: in pkgsrc, e.g. because they use the same distfiles, set
4613: <code class="varname">PATCHDIR</code> to the path where the patch files
4614: can be found, e.g.:</p>
4615: <pre class="programlisting">
1.100 rillig 4616: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4617: </pre>
1.75 rillig 4618: <p>Patch files that are distributed by the author or other
1.87 wiz 4619: maintainers can be listed in
4620: <code class="varname">PATCHFILES</code>.</p>
4621: <p>If it is desired to store any patches that should not be
4622: committed into pkgsrc, they can be kept outside the pkgsrc
4623: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4624: directory tree there is expected to have the same
1.128 wiz 4625: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4626: patches are expected to be stored inside these dirs (also
4627: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4628: example, if you want to keep a private patch for
4629: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4630: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4631: files in the named directory are expected to be patch files,
4632: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4633: applied</em></span>.</p>
1.93 rillig 4634: </div>
1.148 asau 4635: <div class="sect2">
1.85 jmmv 4636: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4637: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4638: <p>When fixing a portability issue in the code do not use
4639: preprocessor magic to check for the current operating system nor
4640: platform. Doing so hurts portability to other platforms because
4641: the OS-specific details are not abstracted appropriately.</p>
4642: <p>The general rule to follow is: instead of checking for the
4643: operating system the application is being built on, check for the
4644: specific <span class="emphasis"><em>features</em></span> you need. For example,
4645: instead of assuming that kqueue is available under NetBSD and
4646: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4647: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4648: yes, this generally involves patching the
1.110 hubertf 4649: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4650: that prevents some OSes from adopting interfaces from other OSes
4651: (e.g. Linux implementing kqueue), something that the above checks
4652: cannot take into account.</p>
4653: <p>Of course, checking for features generally involves more
4654: work on the developer's side, but the resulting changes are
1.87 wiz 4655: cleaner and there are chances they will work on many other
1.85 jmmv 4656: platforms. Not to mention that there are higher chances of being
4657: later integrated into the mainstream sources. Remember:
4658: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4659: <p>Some typical examples:</p>
4660: <div class="table">
1.106 rillig 4661: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4662: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4663: <colgroup>
4664: <col>
4665: <col>
4666: <col>
4667: </colgroup>
4668: <thead><tr>
4669: <th>Where</th>
4670: <th>Incorrect</th>
4671: <th>Correct</th>
4672: </tr></thead>
4673: <tbody>
4674: <tr>
4675: <td>configure script</td>
4676: <td>
1.100 rillig 4677: <pre class="programlisting">
4678: case ${target_os} in
4679: netbsd*) have_kvm=yes ;;
4680: *) have_kvm=no ;;
4681: esac
4682: </pre>
1.85 jmmv 4683: </td>
4684: <td>
1.100 rillig 4685: <pre class="programlisting">
4686: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4687: </pre>
1.85 jmmv 4688: </td>
4689: </tr>
4690: <tr>
4691: <td>C source file</td>
4692: <td>
1.100 rillig 4693: <pre class="programlisting">
4694: #if defined(__NetBSD__)
4695: # include <sys/event.h>
4696: #endif
4697: </pre>
1.85 jmmv 4698: </td>
4699: <td>
1.100 rillig 4700: <pre class="programlisting">
4701: #if defined(HAVE_SYS_EVENT_H)
4702: # include <sys/event.h>
4703: #endif
4704: </pre>
1.85 jmmv 4705: </td>
4706: </tr>
4707: <tr>
4708: <td>C source file</td>
4709: <td>
1.100 rillig 4710: <pre class="programlisting">
4711: int
4712: monitor_file(...)
4713: {
4714: #if defined(__NetBSD__)
4715: int fd = kqueue();
4716: ...
4717: #else
4718: ...
4719: #endif
4720: }
4721: </pre>
1.85 jmmv 4722: </td>
4723: <td>
1.100 rillig 4724: <pre class="programlisting">
4725: int
4726: monitor_file(...)
4727: {
4728: #if defined(HAVE_KQUEUE)
4729: int fd = kqueue();
4730: ...
4731: #else
4732: ...
4733: #endif
4734: }
4735: </pre>
1.85 jmmv 4736: </td>
4737: </tr>
4738: </tbody>
1.91 rillig 4739: </table></div>
1.85 jmmv 4740: </div>
1.91 rillig 4741: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4742: 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
4743: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4744: 2</a>). It summarizes multiple details on how to make
4745: software easier to package; all the suggestions in it were
4746: collected from our experience in pkgsrc work, so they are possibly
4747: helpful when creating patches too.</p>
4748: </div>
1.148 asau 4749: <div class="sect2">
1.85 jmmv 4750: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4751: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4752: <p>Always, always, <span class="strong"><strong>always</strong></span>
4753: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4754: improvements you do to a package to the mainstream developers.
4755: This is the only way to get their attention on portability issues
4756: and to ensure that future versions can be built out-of-the box on
4757: NetBSD. Furthermore, any user that gets newer distfiles will get
4758: the fixes straight from the packaged code.</p>
1.93 rillig 4759: <p>This generally involves cleaning up the patches
4760: (because sometimes the patches that are
1.147 wiz 4761: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 4762: appropriate trackers for the projects and working with the
4763: mainstream authors to accept your changes. It is
4764: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4765: the packages in pkgsrc are kept simple and thus further changes
4766: can be done without much hassle.</p>
1.130 wiz 4767: <p>When you have done this, please add a URL to the upstream
4768: bug report to the patch comment.</p>
1.85 jmmv 4769: <p>Support the idea of free software!</p>
4770: </div>
1.75 rillig 4771: </div>
1.148 asau 4772: <div class="sect1">
1.75 rillig 4773: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4774: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 asau 4775: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4776: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4777: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4778: any credits where they are due. Please bear in mind that others do not
4779: share your sense of humour (or spelling idiosyncrasies), and that others
4780: will read everything that you write here.</p></dd>
1.76 rillig 4781: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4782: <dd><p>This file governs the files that are installed on your
4783: system: all the binaries, manual pages, etc. There are other
4784: directives which may be entered in this file, to control the
4785: creation and deletion of directories, and the location of
1.110 hubertf 4786: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87 wiz 4787: information.</p></dd>
1.75 rillig 4788: </dl></div>
4789: </div>
1.148 asau 4790: <div class="sect1">
1.75 rillig 4791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4792: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 asau 4793: <div class="sect2">
1.78 rillig 4794: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4795: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 4796: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4797: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 4798: <dd>
1.136 dholland 4799: <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.87 wiz 4800: First time after package extraction and before files are
4801: moved in place, the second time after the files to install
4802: are moved in place. This can be used to do any custom
4803: procedures not possible with @exec commands in
1.136 dholland 4804: <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
4805: <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.135 wiz 4806: Please note that you can modify variables in it easily by using
4807: <code class="varname">FILES_SUBST</code> in the package's
4808: <code class="filename">Makefile</code>:</p>
4809: <pre class="programlisting">
4810: FILES_SUBST+= SOMEVAR="somevalue"
4811: </pre>
4812: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4813: <code class="filename">INSTALL</code>. By default, substitution is
4814: performed for <code class="varname">PREFIX</code>,
4815: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4816: <code class="varname">VARBASE</code>, and a few others, type
4817: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4818: complete list.</p>
4819: </dd>
1.76 rillig 4820: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4821: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4822: this script's responsibility to clean up any additional messy details
4823: around the package's installation, since all pkg_delete knows is how to
4824: delete the files created in the original distribution.
1.136 dholland 4825: 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>
4826: 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.135 wiz 4827: The same methods to replace variables can be used as for
4828: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 4829: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4830: <dd>
4831: <p>This file is displayed after installation of the package.
1.87 wiz 4832: Useful for things like legal notices on almost-free
4833: software and hints for updating config files after
4834: installing modules for apache, PHP etc.
4835: Please note that you can modify variables in it easily by using
4836: <code class="varname">MESSAGE_SUBST</code> in the package's
4837: <code class="filename">Makefile</code>:</p>
1.75 rillig 4838: <pre class="programlisting">
1.100 rillig 4839: MESSAGE_SUBST+= SOMEVAR="somevalue"
4840: </pre>
1.128 wiz 4841: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4842: <code class="filename">MESSAGE</code>. By default, substitution is
4843: performed for <code class="varname">PKGNAME</code>,
4844: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4845: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4846: <code class="varname">X11BASE</code>,
4847: <code class="varname">PKG_SYSCONFDIR</code>,
4848: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4849: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4850: <p>You can display a different or additional files by
4851: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4852: default is <code class="filename">MESSAGE</code>, if the file
4853: exists.</p>
1.75 rillig 4854: </dd>
1.78 rillig 4855: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4856: <dd><p>FIXME: There is no documentation on the
4857: alternatives framework.</p></dd>
4858: </dl></div>
4859: </div>
1.148 asau 4860: <div class="sect2">
1.78 rillig 4861: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4862: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 4863: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4864: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4865: <dd><p>This file contains arbitrary things that could
4866: also go into a <code class="filename">Makefile</code>, but its purpose is
4867: to be used by more than one package. This file should only be
4868: used when the packages that will use the file are known in
4869: advance. For other purposes it is often better to write a
4870: <code class="filename">*.mk</code> file and give it a good name that
4871: describes what it does.</p></dd>
4872: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4873: <dd><p>This file contains the dependency information
1.110 hubertf 4874: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.78 rillig 4875: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4876: <dd><p>This file contains workarounds for compiler bugs
4877: and similar things. It is included automatically by the pkgsrc
4878: infrastructure, so you don't need an extra
4879: <code class="literal">.include</code> line for
4880: it.</p></dd>
4881: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4882: <dd><p>This file contains the code for the
1.110 hubertf 4883: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.78 rillig 4884: selected by the user. If a package has only one or two options,
4885: it is equally acceptable to put the code directly into the
4886: <code class="filename">Makefile</code>.</p></dd>
4887: </dl></div>
4888: </div>
1.148 asau 4889: <div class="sect2">
1.78 rillig 4890: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4891: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 4892: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4893: <dt><span class="term"><code class="filename">README*</code></span></dt>
4894: <dd><p>These files do not take place in the creation of
4895: a package and thus are purely informative to the package
4896: developer.</p></dd>
4897: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4898: <dd><p>This file contains things that need to be done
4899: to make the package even
4900: better.</p></dd>
1.75 rillig 4901: </dl></div>
4902: </div>
1.78 rillig 4903: </div>
1.148 asau 4904: <div class="sect1">
1.75 rillig 4905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4906: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4907: </h2></div></div></div>
1.110 hubertf 4908: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4909: unpacked into the directory denoted by
4910: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4911: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4912: directory is also used to keep various timestamp files.
4913: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4914: The default is <code class="filename">${.CURDIR}/work</code>
4915: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4916: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4917: </div>
1.148 asau 4918: <div class="sect1">
1.75 rillig 4919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4920: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4921: </h2></div></div></div>
1.75 rillig 4922: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4923: to configuration or building, you could place these files here and use
1.110 hubertf 4924: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4925: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4926: this. Alternatively, you could simply diff the file against
4927: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4928: the creation of this file.</p>
4929: <p>If you want to share files in this way with other
4930: packages, set the <code class="varname">FILESDIR</code> variable to point
4931: to the other package's <code class="filename">files</code> directory,
4932: e.g.:</p>
4933: <pre class="programlisting">
1.100 rillig 4934: FILESDIR=${.CURDIR}/../xemacs/files
4935: </pre>
1.75 rillig 4936: </div>
4937: </div>
1.148 asau 4938: <div class="chapter">
1.75 rillig 4939: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4940: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4941: <div class="toc">
4942: <p><b>Table of Contents</b></p>
4943: <dl>
1.106 rillig 4944: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4945: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4946: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4947: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4948: <dd><dl>
4949: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4950: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4951: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4952: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4953: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75 rillig 4954: </dl></dd>
4955: </dl>
4956: </div>
1.76 rillig 4957: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4958: each of which forms a well-defined part of the pkgsrc system. Using
1.136 dholland 4959: 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.75 rillig 4960: like pkgsrc requires some discipline to keep the code correct and
4961: understandable.</p>
1.76 rillig 4962: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4963: programming are variables (which are actually macros) and shell
4964: commands. Among these shell commands may even be more complex ones
1.136 dholland 4965: 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.75 rillig 4966: as intended it is necessary to quote all variables correctly when they
4967: are used.</p>
4968: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4969: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4970: with them.</p>
1.148 asau 4971: <div class="sect1">
1.75 rillig 4972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4973: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 asau 4974: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4975: <p>When you are creating a file as a
4976: target of a rule, always write the data to a temporary file first
4977: and finally rename that file. Otherwise there might occur an error
4978: in the middle of generating the file, and when the user runs
1.136 dholland 4979: <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.97 rillig 4980: regenerated properly. Example:</p>
4981: <pre class="programlisting">
1.100 rillig 4982: wrong:
4983: @echo "line 1" > ${.TARGET}
4984: @echo "line 2" >> ${.TARGET}
4985: @false
4986:
4987: correct:
4988: @echo "line 1" > ${.TARGET}.tmp
4989: @echo "line 2" >> ${.TARGET}.tmp
4990: @false
4991: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4992: </pre>
1.110 hubertf 4993: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4994: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4995: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4996: correct</strong></span> gives an error message twice, as expected.</p>
1.136 dholland 4997: <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.97 rillig 4998: <code class="literal">${.TARGET}</code> in case of error, but this only
4999: happens when it is interrupted, for example by pressing
5000: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.136 dholland 5001: 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.97 rillig 5002: </li></ul></div>
5003: </div>
1.148 asau 5004: <div class="sect1">
1.97 rillig 5005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5006: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 5007: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 5008: can be processed using the five operators ``='', ``+='', ``?='',
1.136 dholland 5009: ``:='', 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.75 rillig 5010: page.</p>
5011: <p>When a variable's value is parsed from a
1.76 rillig 5012: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 5013: backslash character ``\'' are handled specially. If a backslash is
5014: followed by a newline, any whitespace immediately in front of the
5015: backslash, the backslash, the newline, and any whitespace
5016: immediately behind the newline are replaced with a single space. A
5017: backslash character and an immediately following hash character are
5018: replaced with a single hash character. Otherwise, the backslash is
5019: passed as is. In a variable assignment, any hash character that is
5020: not preceded by a backslash starts a comment that continues upto the
5021: end of the logical line.</p>
5022: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
5023: the only way to create a variable consisting of a single backslash
5024: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
5025: <p>So far for defining variables. The other thing you can do with
5026: variables is evaluating them. A variable is evaluated when it is
5027: part of the right side of the ``:='' or the ``!='' operator, or
5028: directly before executing a shell command which the variable is part
1.136 dholland 5029: 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.75 rillig 5030: is, variables are not evaluated until there's no other way. The
5031: ``modifiers'' mentioned in the man page also evaluate the
5032: variable.</p>
5033: <p>Some of the modifiers split the string into words and then
5034: operate on the words, others operate on the string as a whole. When
5035: a string is split into words, it is split as you would expect
1.136 dholland 5036: 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.126 jakllsch 5037: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 5038: loop does not follow the shell quoting rules but splits at sequences
5039: of whitespace.</p>
5040: <p>There are several types of variables that should be handled
5041: differently. Strings and two types of lists.</p>
1.148 asau 5042: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5043: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 5044: characters. Nevertheless, you should restrict yourself to only
5045: using printable characters. Examples are
5046: <code class="varname">PREFIX</code> and
5047: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 5048: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 5049: are never exported to any shell command. Their elements are
5050: separated by whitespace. Therefore, the elements themselves cannot
5051: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 5052: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 5053: Examples are <code class="varname">DEPENDS</code> and
5054: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 5055: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 5056: may be exported to a shell command. Their elements can contain any
5057: characters, including whitespace. That's why they cannot be used
1.110 hubertf 5058: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 5059: <code class="varname">DISTFILES</code> and
5060: <code class="varname">MASTER_SITES</code>.</p></li>
5061: </ul></div>
1.148 asau 5062: <div class="sect2">
1.75 rillig 5063: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5064: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 asau 5065: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5066: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 5067: are reserved for use by the pkgsrc infrastructure. They shall
5068: not be used by package
1.76 rillig 5069: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 5070: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 5071: lowercase variable names for the iteration
5072: variables.</p></li>
1.128 wiz 5073: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 5074: name, e.g. <code class="varname">PKG_OPTIONS</code> or
5075: <code class="varname">DISTFILES</code>.</p></li>
5076: </ul></div>
5077: </div>
5078: </div>
1.148 asau 5079: <div class="sect1">
1.75 rillig 5080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5081: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 5082: <p>This section presents you with some code snippets you should
5083: use in your own code. If you don't find anything appropriate here,
5084: you should test your code and add it here.</p>
1.148 asau 5085: <div class="sect2">
1.75 rillig 5086: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5087: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 5088: <pre class="programlisting">
1.100 rillig 5089: STRING= foo * bar `date`
5090: INT_LIST= # empty
5091: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
5092: EXT_LIST= # empty
5093: ANOTHER_EXT_LIST= a=b c=d
5094:
5095: INT_LIST+= ${STRING} # 1
5096: INT_LIST+= ${ANOTHER_INT_LIST} # 2
5097: EXT_LIST+= ${STRING:Q} # 3
5098: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 5099: </pre>
1.75 rillig 5100: <p>When you add a string to an external list (example 3), it
5101: must be quoted. In all other cases, you must not add a quoting
5102: level. You must not merge internal and external lists, unless you
5103: are sure that all entries are correctly interpreted in both
5104: lists.</p>
5105: </div>
1.148 asau 5106: <div class="sect2">
1.75 rillig 5107: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5108: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75 rillig 5109: <pre class="programlisting">
1.100 rillig 5110: EXT_LIST= # empty
5111: .for i in ${INT_LIST}
5112: EXT_LIST+= ${i:Q}""
5113: .endfor
1.1 grant 5114: </pre>
1.75 rillig 5115: <p>This code converts the internal list
5116: <code class="varname">INT_LIST</code> into the external list
5117: <code class="varname">EXT_LIST</code>. As the elements of an internal list
5118: are unquoted they must be quoted here. The reason for appending
5119: <code class="varname">""</code> is explained below.</p>
5120: </div>
1.148 asau 5121: <div class="sect2">
1.75 rillig 5122: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5123: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 5124: <p>Sometimes you may want to print an arbitrary string. There
5125: are many ways to get it wrong and only few that can handle every
5126: nastiness.</p>
1.75 rillig 5127: <pre class="programlisting">
1.100 rillig 5128: STRING= foo bar < > * `date` $$HOME ' "
5129: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 5130:
1.100 rillig 5131: all:
5132: echo ${STRING} # 1
5133: echo "${STRING}" # 2
5134: echo "${STRING:Q}" # 3
5135: echo ${STRING:Q} # 4
5136: echo x${STRING:Q} | sed 1s,.,, # 5
5137: printf "%s\\n" ${STRING:Q}"" # 6
5138: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 5139: </pre>
1.75 rillig 5140: <p>Example 1 leads to a syntax error in the shell, as the
5141: characters are just copied.</p>
5142: <p>Example 2 leads to a syntax error too, and if you leave out
5143: the last " character from <code class="varname">${STRING}</code>,
1.136 dholland 5144: <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.75 rillig 5145: variable would be evaluated, too.</p>
5146: <p>Example 3 outputs each space character preceded by a
5147: backslash (or not), depending on the implementation of the
1.136 dholland 5148: <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.75 rillig 5149: <p>Example 4 handles correctly every string that does not start
5150: with a dash. In that case, the result depends on the
1.136 dholland 5151: 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.75 rillig 5152: guarantee that your input does not start with a dash, this form is
5153: appropriate.</p>
5154: <p>Example 5 handles even the case of a leading dash
5155: correctly.</p>
1.79 rillig 5156: <p>Example 6 also works with every string and is the
5157: light-weight solution, since it does not involve a pipe, which has
5158: its own problems.</p>
1.75 rillig 5159: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5160: because the quoting has already been done when adding elements to
5161: the list.</p>
5162: <p>As internal lists shall not be passed to the shell, there is
5163: no example for it.</p>
5164: </div>
1.148 asau 5165: <div class="sect2">
1.75 rillig 5166: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5167: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 5168: <p>There are many possible sources of wrongly quoted variables.
5169: This section lists some of the commonly known ones.</p>
1.148 asau 5170: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5171: <li class="listitem">
1.75 rillig 5172: <p>Whenever you use the value of a list, think
5173: about what happens to leading or trailing whitespace. If the
5174: list is a well-formed shell expression, you can apply the
5175: <code class="varname">:M*</code> modifier to strip leading and trailing
5176: whitespace from each word. The <code class="varname">:M</code> operator
5177: first splits its argument according to the rules of the shell,
5178: and then creates a new list consisting of all words that match
5179: the shell glob expression <code class="varname">*</code>, that is: all.
5180: One class of situations where this is needed is when adding a
5181: variable like <code class="varname">CPPFLAGS</code> to
5182: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5183: invokes other configure scripts, it strips the leading and
5184: trailing whitespace from the variable and then passes it to the
5185: other configure scripts. But these configure scripts expect the
5186: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5187: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5188: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5189: here is how we do it:</p>
5190: <pre class="programlisting">
1.100 rillig 5191: CPPFLAGS= # empty
5192: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5193: CPPFLAGS+= ${MY_CPPFLAGS}
5194:
5195: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5196:
5197: all:
5198: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5199: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5200: </pre>
1.75 rillig 5201: </li>
1.128 wiz 5202: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 5203: <code class="varname">${PREFIX}</code> is a properly quoted shell
5204: expression, but there is the C compiler after it, which also
5205: expects a properly quoted string (this time in C syntax). The
5206: version above is therefore only correct if
5207: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5208: or double quotes. If you want to allow these, you have to add
5209: another layer of quoting to each variable that is used as a C
5210: string literal. You cannot use the <code class="varname">:Q</code>
5211: operator for it, as this operator only works for the
5212: shell.</p></li>
1.128 wiz 5213: <li class="listitem">
1.75 rillig 5214: <p>Whenever a variable can be empty, the
5215: <code class="varname">:Q</code> operator can have surprising results. Here
5216: are two completely different cases which can be solved with the
5217: same trick.</p>
5218: <pre class="programlisting">
1.100 rillig 5219: EMPTY= # empty
5220: empty_test:
5221: for i in a ${EMPTY:Q} c; do \
5222: echo "$$i"; \
5223: done
5224:
5225: for_test:
5226: .for i in a:\ a:\test.txt
5227: echo ${i:Q}
5228: echo "foo"
5229: .endfor
1.1 grant 5230: </pre>
1.75 rillig 5231: <p>The first example will only print two of the three lines
5232: we might have expected. This is because
5233: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5234: the shell cannot see. The workaround is to write
5235: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5236: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5237: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5238: <p>The second example will only print three lines instead of
5239: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5240: This is because the backslash of the value
5241: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.136 dholland 5242: <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
5243: <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.75 rillig 5244: <code class="varname">${i:Q}""</code>.</p>
5245: </li>
5246: </ul></div>
5247: </div>
1.148 asau 5248: <div class="sect2">
1.75 rillig 5249: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5250: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5251: <p>The pkgsrc bmake program does not handle the following
5252: assignment correctly. In case <code class="varname">_othervar_</code>
5253: contains a ``-'' character, one of the closing braces is included
5254: in <code class="varname">${VAR}</code> after this code executes.</p>
5255: <pre class="programlisting">
1.100 rillig 5256: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5257: </pre>
1.75 rillig 5258: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5259: package <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/regress/make-quoting/README.html" target="_top"><code class="filename">regress/make-quoting</code></a>, testcase
1.75 rillig 5260: <code class="varname">bug1</code>.</p>
5261: </div>
5262: </div>
5263: </div>
1.148 asau 5264: <div class="chapter">
1.75 rillig 5265: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5266: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 5267: <div class="toc">
5268: <p><b>Table of Contents</b></p>
5269: <dl>
1.106 rillig 5270: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 5271: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5272: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 5273: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5274: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 5275: <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.106 rillig 5276: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5277: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5278: </dl>
5279: </div>
1.87 wiz 5280: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 5281: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 5282: the package (relative to the <code class="filename">${PREFIX}</code>
5283: directory it's been installed in) plus some additional statements
1.136 dholland 5284: - 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.87 wiz 5285: This chapter addresses some issues that need attention when
5286: dealing with the <code class="filename">PLIST</code> file (or files, see
5287: below!).</p>
1.148 asau 5288: <div class="sect1">
1.75 rillig 5289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5290: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 5291: <p>Be sure to add a RCS ID line as the first thing in any
5292: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5293: <pre class="programlisting">
1.100 rillig 5294: @comment $NetBSD$
1.87 wiz 5295: </pre>
1.75 rillig 5296: </div>
1.148 asau 5297: <div class="sect1">
1.75 rillig 5298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5299: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 5300: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 5301: to output a PLIST that matches any new files since the package
1.110 hubertf 5302: was extracted. See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.87 wiz 5303: more information on this target.</p>
1.75 rillig 5304: </div>
1.148 asau 5305: <div class="sect1">
1.75 rillig 5306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 5307: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 5308: </h2></div></div></div>
1.87 wiz 5309: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 5310: <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
5311: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 5312: <code class="varname">@comment</code>s instead of real
5313: <code class="varname">@dirrm</code> lines. You can also do this for
5314: specific directories and files, so that the results of that
5315: command are very close to reality. This helps <span class="emphasis"><em>a
5316: lot</em></span> during the update of packages.</p>
5317: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5318: of AWK patterns and actions that are used to filter the output of
5319: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5320: scripting you like to it, but be careful with quoting.</p>
5321: <p>For example, to get all files inside the
5322: <code class="filename">libdata/foo</code> directory removed from the
5323: resulting PLIST:</p>
5324: <pre class="programlisting">
1.100 rillig 5325: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5326: </pre>
5327: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5328: to a specific (shared) directory converted to
5329: <code class="varname">@comment</code>s:</p>
1.75 rillig 5330: <pre class="programlisting">
1.100 rillig 5331: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5332: </pre>
1.75 rillig 5333: </div>
1.148 asau 5334: <div class="sect1">
1.75 rillig 5335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5336: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5337: <p>A number of variables are substituted automatically in
5338: PLISTs when a package is installed on a system. This includes the
5339: following variables:</p>
1.148 asau 5340: <div class="variablelist"><dl class="variablelist">
1.75 rillig 5341: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5342: <dd>
5343: <p>Some packages like emacs and perl embed information
1.87 wiz 5344: about which architecture they were built on into the
5345: pathnames where they install their files. To handle this
5346: case, PLIST will be preprocessed before actually used, and
5347: the symbol
1.128 wiz 5348: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 5349: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 5350: same is done if the string
5351: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5352: PLIST somewhere - use this on packages that have GNU
5353: autoconf-created configure scripts.</p>
1.148 asau 5354: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 5355: <h3 class="title">Legacy note</h3>
5356: <p>There used to be a symbol
1.128 wiz 5357: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 5358: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 5359: -m</strong></span>, but that's no longer supported and has
5360: been removed.</p>
1.75 rillig 5361: </div>
5362: </dd>
5363: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5364: <dd>
5365: <p>Some packages want to embed the OS name and version
1.87 wiz 5366: into some paths. To do this, use these variables in the
5367: <code class="filename">PLIST</code>:
5368: </p>
1.148 asau 5369: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5370: <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>
5371: <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>
5372: <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.75 rillig 5373: </ul></div>
5374: </dd>
5375: </dl></div>
1.87 wiz 5376: <p>For a complete list of values which are replaced by
5377: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5378: search for <code class="varname">PLIST_SUBST</code>).</p>
5379: <p>If you want to change other variables not listed above, you
5380: can add variables and their expansions to this variable in the
1.110 hubertf 5381: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.75 rillig 5382: <pre class="programlisting">
1.100 rillig 5383: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5384: </pre>
1.128 wiz 5385: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 5386: in the <code class="filename">PLIST</code> with
1.128 wiz 5387: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 5388: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 5389: the common case of conditionally including some
5390: <code class="filename">PLIST</code> entries. It can be done by adding
5391: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 5392: setting the corresponding <code class="varname">PLIST.foo</code> variable
5393: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 5394: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 5395: in the <code class="filename">PLIST</code> with either
1.128 wiz 5396: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5397: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 5398: For example, in <code class="filename">Makefile</code>:</p>
5399: <pre class="programlisting">
5400: PLIST_VARS+= foo
5401: .if <em class="replaceable"><code>condition</code></em>
5402: PLIST.foo= yes
5403: .else
5404: </pre>
5405: <p>And then in <code class="filename">PLIST</code>:</p>
5406: <pre class="programlisting">
5407: @comment $NetBSD$
5408: bin/bar
5409: man/man1/bar.1
5410: ${PLIST.foo}bin/foo
5411: ${PLIST.foo}man/man1/foo.1
5412: ${PLIST.foo}share/bar/foo.data
5413: ${PLIST.foo}@dirrm share/bar
5414: </pre>
1.75 rillig 5415: </div>
1.148 asau 5416: <div class="sect1">
1.75 rillig 5417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5418: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5419: <p>Man pages should be installed in compressed form if
1.87 wiz 5420: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5421: and uncompressed otherwise. To handle this in the
1.128 wiz 5422: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5423: appended/removed automatically for man pages according to
5424: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5425: or not, see above for details. This modification of the
5426: <code class="filename">PLIST</code> file is done on a copy of it, not
5427: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5428: </div>
1.148 asau 5429: <div class="sect1">
1.75 rillig 5430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5431: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5432: </h2></div></div></div>
1.76 rillig 5433: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5434: in generating the binary package, set the variable
5435: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.136 dholland 5436: 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.87 wiz 5437: important. The default for <code class="varname">PLIST_SRC</code> is
5438: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5439: </div>
1.148 asau 5440: <div class="sect1">
1.75 rillig 5441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5442: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5443: <p>Some packages decide to install a different set of files based on
1.87 wiz 5444: the operating system being used. These differences can be
5445: automatically handled by using the following files:</p>
1.148 asau 5446: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5447: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5448: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5449: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5450: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5451: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5452: </ul></div>
5453: </div>
1.148 asau 5454: <div class="sect1">
1.75 rillig 5455: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5456: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.128 wiz 5457: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5458: multiple (and unrelated) packages install files. These
1.125 wiz 5459: directories were problematic because you had to add special
5460: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5461: centralized package handle them.</p>
1.125 wiz 5462: <p>In pkgsrc, it is now easy: Each package should create
5463: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5464: will remove any directories left empty after uninstalling a
5465: package.</p>
5466: <p>If a package needs an empty directory to work, create
5467: the directory during installation as usual, and also add an
5468: entry to the PLIST:
5469: </p>
1.87 wiz 5470: <pre class="programlisting">
1.125 wiz 5471: @pkgdir path/to/empty/directory
1.87 wiz 5472: </pre>
1.125 wiz 5473: <p>
5474: </p>
1.75 rillig 5475: </div>
5476: </div>
1.148 asau 5477: <div class="chapter">
1.75 rillig 5478: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5479: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5480: <div class="toc">
5481: <p><b>Table of Contents</b></p>
5482: <dl>
1.106 rillig 5483: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 5484: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5485: <dd><dl>
1.106 rillig 5486: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 5487: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5488: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5489: and
5490: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5491: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5492: </dl></dd>
1.128 wiz 5493: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75 rillig 5494: <dd><dl>
1.128 wiz 5495: <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.106 rillig 5496: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75 rillig 5497: </dl></dd>
5498: </dl>
5499: </div>
5500: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5501: are seen by a package's configure and build processes. This is implemented
5502: in a two step process:</p>
1.128 wiz 5503: <div class="orderedlist"><ol class="orderedlist" type="1">
5504: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5505: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5506: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 5507: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5508: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5509: <code class="option">-L${LOCALBASE}/lib</code> into references to
5510: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5511: native compiler on some operating systems look like GCC, so that
5512: packages that expect GCC won't require modifications to build with
5513: those native compilers.</p></li>
1.75 rillig 5514: </ol></div>
5515: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5516: package may be built consistently despite what other software may be
5517: installed. Please note that the normal system header and library paths,
5518: e.g. <code class="filename">/usr/include</code>,
5519: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5520: designed to insulate the package build from non-system-supplied
5521: software.</p>
1.148 asau 5522: <div class="sect1">
1.75 rillig 5523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5524: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5525: <p>The process of converting packages to use the buildlink3
1.128 wiz 5526: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5527: The things to keep in mind are:</p>
1.128 wiz 5528: <div class="orderedlist"><ol class="orderedlist" type="1">
5529: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5530: instead of the actual toolchain. Some packages are tricky,
5531: and the only way to know for sure is the check
5532: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5533: wrappers are being invoked.</p></li>
1.128 wiz 5534: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5535: the package Makefile, e.g. Java VMs, standalone shells,
5536: etc., because the code to symlink files into
5537: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 5538: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5539: </p></li>
1.128 wiz 5540: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5541: <code class="filename">buildlink3.mk</code> files that you list in a
5542: package's Makefile are added as dependencies for that package.
5543: </p></li>
1.75 rillig 5544: </ol></div>
1.87 wiz 5545: <p>If a dependency on a particular package is required for its libraries and
5546: headers, then we replace:</p>
1.75 rillig 5547: <pre class="programlisting">
1.100 rillig 5548: DEPENDS+= foo>=1.1.0:../../category/foo
5549: </pre>
1.75 rillig 5550: <p>with</p>
5551: <pre class="programlisting">
1.100 rillig 5552: .include "../../category/foo/buildlink3.mk"
5553: </pre>
1.75 rillig 5554: <p>The buildlink3.mk files usually define the required dependencies.
5555: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5556: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5557: <pre class="programlisting">
1.100 rillig 5558: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5559: .include "../../category/foo/buildlink3.mk"
5560: </pre>
1.76 rillig 5561: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5562: files in <code class="filename">pkgsrc/mk</code>
5563: that handle special package issues:</p>
1.148 asau 5564: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5565: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5566: the native or a pkgsrc Berkeley DB implementation based on
5567: the values of <code class="varname">BDB_ACCEPTED</code> and
5568: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 5569: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5570: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5571: 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.128 wiz 5572: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5573: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5574: adding a dependency on Heimdal or MIT-krb5 for packages that
5575: require a Kerberos 5 implementation.</p></li>
1.128 wiz 5576: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5577: system-provided Motif installation or adds a dependency on
1.151 obache 5578: <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.128 wiz 5579: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.151 obache 5580: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5581: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5582: which Motif version will be used.</p></li>
1.161 ryoon 5583: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 5584: system-provided GNU readline or editline (libedit) installation,
1.161 ryoon 5585: 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>,
5586: <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
5587: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5588: If your package really needs GNU readline library, its Makefile
5589: should include <code class="filename">devel/readline/buildlink3.mk</code>
5590: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 5591: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5592: variables that may be used by packages that use the
5593: Open Sound System (OSS) API.</p></li>
1.128 wiz 5594: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 5595: any of the Postgres versions in the variable
5596: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5597: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 5598: the file for more information.</p></li>
1.128 wiz 5599: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5600: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5601: 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.128 wiz 5602: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5603: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5604: library.</p></li>
1.75 rillig 5605: </ul></div>
1.76 rillig 5606: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5607: files provide a more complete
5608: description of how to use them properly.</p>
1.75 rillig 5609: </div>
1.148 asau 5610: <div class="sect1">
1.75 rillig 5611: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5612: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5613: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5614: included by Makefiles to indicate the need to compile and link
5615: against header files and libraries provided by the package. A
5616: <code class="filename">buildlink3.mk</code> file should always provide
5617: enough information to add the correct type of dependency
5618: relationship and include any other
5619: <code class="filename">buildlink3.mk</code> files that it needs to find
5620: headers and libraries that it needs in turn.</p>
5621: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5622: file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87 wiz 5623: package is highly recommended. For most packages, the following
5624: command will generate a good starting point for
5625: <code class="filename">buildlink3.mk</code> files:</p>
5626: <pre class="screen">
5627: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5628: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5629: </pre>
1.148 asau 5630: <div class="sect2">
1.75 rillig 5631: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5632: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5633: <p>The following real-life example
1.87 wiz 5634: <code class="filename">buildlink3.mk</code> is taken
5635: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5636: <pre class="programlisting">
1.120 snj 5637: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5638:
1.120 snj 5639: BUILDLINK_TREE+= tiff
1.1 grant 5640:
1.120 snj 5641: .if !defined(TIFF_BUILDLINK3_MK)
5642: TIFF_BUILDLINK3_MK:=
1.87 wiz 5643:
1.120 snj 5644: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5645: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5646: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5647:
1.100 rillig 5648: .include "../../devel/zlib/buildlink3.mk"
5649: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5650: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5651:
1.120 snj 5652: BUILDLINK_TREE+= -tiff
1.100 rillig 5653: </pre>
1.87 wiz 5654: <p>The header and footer manipulate
1.120 snj 5655: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5656: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5657: the dependency tree.</p>
5658: <p>The main section is protected from multiple inclusion
1.87 wiz 5659: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5660: added. Several important variables are set in the section:</p>
1.148 asau 5661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5662: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5663: is the actual dependency recorded in the installed
5664: package; this should always be set using
1.110 hubertf 5665: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5666: we're appending to any pre-existing list of values. This
5667: variable should be set to the first version of the
1.133 wiz 5668: package that had an backwards-incompatible API change.
1.87 wiz 5669: </p></li>
1.128 wiz 5670: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5671: is the location of the <em class="replaceable"><code>pkg</code></em>
5672: pkgsrc directory.</p></li>
1.128 wiz 5673: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5674: (not shown above) controls whether we use
5675: <code class="varname">BUILD_DEPENDS</code> or
5676: <code class="varname">DEPENDS</code> to add the dependency on
5677: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5678: selected by setting
5679: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5680: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5681: used.</p></li>
1.128 wiz 5682: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5683: and
5684: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5685: (not shown above) are lists of subdirectories of
1.76 rillig 5686: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5687: to add to the header and library search paths. These
1.128 wiz 5688: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5689: respectively.</p></li>
1.128 wiz 5690: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5691: (not shown above) is the list of preprocessor flags to add
5692: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 5693: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5694: should be avoided and instead be handled using
5695: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5696: above.</p></li>
1.75 rillig 5697: </ul></div>
1.87 wiz 5698: <p>The following variables are all optionally defined within
5699: this second section (protected against multiple inclusion) and
5700: control which package files are symlinked into
5701: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5702: transformed during the symlinking:</p>
1.148 asau 5703: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5704: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5705: (not shown above) is a shell glob pattern relative to
1.76 rillig 5706: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5707: to be symlinked into
1.76 rillig 5708: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5709: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 5710: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5711: (not shown above) is a shell pipeline that
5712: outputs to stdout a list of files relative to
5713: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5714: The resulting files are to be symlinked
5715: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5716: this takes the <code class="filename">+CONTENTS</code> of a
5717: <em class="replaceable"><code>pkg</code></em> and filters it through
5718: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 5719: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5720: (not shown above) is a filter command that filters
1.76 rillig 5721: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5722: relative to
1.76 rillig 5723: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5724: on stdout. By default for overwrite packages,
5725: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5726: outputs the contents of the <code class="filename">include</code>
5727: and <code class="filename">lib</code> directories in the package
5728: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5729: it outputs any libtool archives in
1.87 wiz 5730: <code class="filename">lib</code> directories.</p></li>
1.128 wiz 5731: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5732: (not shown above) is a list of sed arguments used to
5733: transform the name of the source filename into a
1.110 hubertf 5734: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5735: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5736: </ul></div>
1.120 snj 5737: <p>This section can additionally include any
1.87 wiz 5738: <code class="filename">buildlink3.mk</code> needed for
5739: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5740: Including these <code class="filename">buildlink3.mk</code> files
5741: means that the headers and libraries for these
5742: dependencies are also symlinked into
5743: <code class="filename">${BUILDLINK_DIR}</code>
5744: whenever the <em class="replaceable"><code>pkg</code></em>
5745: <code class="filename">buildlink3.mk</code>
1.120 snj 5746: file is included. Dependencies are only added for directly
5747: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 5748: <p>When providing a <code class="filename">buildlink3.mk</code> and
5749: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 5750: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 5751: header files are automatically exposed when the package is
5752: use.</p>
5753: <p>In particular, if only an executable
5754: (<code class="filename">bin/foo</code>) is linked against a library, that
5755: library does not need to be propagated in the
5756: <code class="filename">buildlink3.mk</code> file.</p>
5757: <p>The following steps should help you decide if a
5758: <code class="filename">buildlink3.mk</code> file needs to be included:
5759: </p>
5760: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5761: <li class="listitem"><p>Look at the installed header files: What
5762: headers do they include? The packages providing these files
5763: must be buildlinked.</p></li>
1.155 wiz 5764: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5765: libraries and look against what other libraries they link.
5766: Some of the packages providing these probably need to be
5767: buildlinked; however, it's not automatic, since e.g. GTK on
5768: some systems pulls in the X libraries, so they will show up in
5769: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 5770: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 5771: used as a hint.</p></li>
1.153 wiz 5772: </ul></div>
5773: <p>
5774: </p>
1.75 rillig 5775: </div>
1.148 asau 5776: <div class="sect2">
1.75 rillig 5777: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 5778: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 5779: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5780: and
5781: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5782: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5783: <p>These two variables differ in that one describes source
5784: compatibility (API) and the other binary compatibility (ABI).
5785: The difference is that a change in the API breaks compilation of
5786: programs while changes in the ABI stop compiled programs from
5787: running.</p>
5788: <p>Changes to the
1.134 wiz 5789: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5790: variable in a <code class="filename">buildlink3.mk</code> file happen
5791: very rarely. One possible reason is that all packages depending
5792: on this already need a newer version. In case it is bumped see
5793: the description below.</p>
5794: <p>The most common example of an ABI change is that the major
5795: version of a shared library is increased. In this case,
5796: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5797: should be adjusted to require at least the new package version.
5798: Then the packages that depend on this package need their
5799: <code class="varname">PKGREVISION</code>s increased and, if they have
5800: <code class="filename">buildlink3.mk</code> files, their
5801: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5802: adjusted, too. This is needed so pkgsrc will require the correct
5803: package dependency and not settle for an older one when building
5804: the source.</p>
1.110 hubertf 5805: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.133 wiz 5806: more information about dependencies on other packages,
5807: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5808: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5809: <p>Please take careful consideration before adjusting
5810: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5811: or
5812: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5813: as we don't want to cause unneeded package deletions and
5814: rebuilds. In many cases, new versions of packages work just
5815: fine with older dependencies.</p>
5816: <p>Also it is not needed to set
1.133 wiz 5817: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5818: when it is identical to
1.87 wiz 5819: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5820: </div>
5821: </div>
1.148 asau 5822: <div class="sect1">
1.75 rillig 5823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5824: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5825: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5826: coincide with headers and libraries present in the base system.
1.76 rillig 5827: Aside from a <code class="filename">buildlink3.mk</code> file, these
5828: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5829: file that includes the necessary checks to decide whether using
5830: the built-in software or the pkgsrc software is
1.87 wiz 5831: appropriate.</p>
5832: <p>The only requirements of a builtin.mk file for
5833: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 5834: <div class="orderedlist"><ol class="orderedlist" type="1">
5835: <li class="listitem"><p>It should set
1.87 wiz 5836: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5837: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5838: after it is included.</p></li>
1.128 wiz 5839: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5840: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5841: which is already set before the
5842: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 5843: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5844: is <span class="emphasis"><em>very</em></span> important and takes careful
5845: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5846: </ol></div>
1.148 asau 5847: <div class="sect2">
1.75 rillig 5848: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5849: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75 rillig 5850: <p>The following is the recommended template for builtin.mk
1.87 wiz 5851: files:</p>
1.75 rillig 5852: <pre class="programlisting">
1.100 rillig 5853: .if !defined(IS_BUILTIN.foo)
5854: #
5855: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5856: # genuinely exists in the system or not.
5857: #
5858: IS_BUILTIN.foo?= no
5859:
5860: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5861: # version can be determined.
5862: #
5863: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5864: BUILTIN_PKG.foo?= foo-1.0
5865: . endif
5866: .endif # IS_BUILTIN.foo
5867:
5868: .if !defined(USE_BUILTIN.foo)
5869: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5870: . if defined(BUILTIN_PKG.foo)
5871: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5872: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5873: USE_BUILTIN.foo!= \
5874: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5875: && ${ECHO} "yes" || ${ECHO} "no"
5876: . endif
5877: . endfor
5878: . endif
5879: .endif # USE_BUILTIN.foo
5880:
5881: CHECK_BUILTIN.foo?= no
5882: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5883: #
5884: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5885: # "yes" or "no".
5886: #
5887: .endif # CHECK_BUILTIN.foo
5888: </pre>
1.87 wiz 5889: <p>The first section sets
5890: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5891: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5892: in the base system. This should not be a base system software
5893: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 5894: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5895: included as part of the base system. This variable is only
5896: used internally within the <code class="filename">builtin.mk</code>
5897: file.</p>
5898: <p>The second section sets
5899: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5900: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5901: system if it exists (if
5902: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5903: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5904: within the <code class="filename">builtin.mk</code> file.</p>
5905: <p>The third section sets
5906: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5907: and is <span class="emphasis"><em>required</em></span> in all
5908: <code class="filename">builtin.mk</code> files. The code in this
5909: section must make the determination whether the built-in
5910: software is adequate to satisfy the dependencies listed in
5911: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5912: This is typically done by comparing
5913: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5914: against each of the dependencies in
5915: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5916: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5917: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5918: end of the <code class="filename">builtin.mk</code> file. Note that
5919: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5920: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5921: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5922: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5923: that the built-in version of the software is similar enough to
5924: be used as a replacement.</p>
5925: <p>The last section is guarded by
5926: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5927: and includes code that uses the value of
5928: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5929: set in the previous section. This typically includes, e.g.,
5930: adding additional dependency restrictions and listing additional
5931: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5932: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5933: </div>
1.148 asau 5934: <div class="sect2">
1.75 rillig 5935: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5936: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5937: <p>When building packages, it's possible to choose whether to set
5938: a global preference for using either the built-in (native)
5939: version or the pkgsrc version of software to satisfy a
5940: dependency. This is controlled by setting
5941: <code class="varname">PREFER_PKGSRC</code> and
5942: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 5943: 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.87 wiz 5944: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5945: use the pkgsrc versions of software, while
5946: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5947: built-in versions. Preferences are determined by the most
5948: specific instance of the package in either
5949: <code class="varname">PREFER_PKGSRC</code> or
5950: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5951: in neither or in both variables, then
5952: <code class="varname">PREFER_PKGSRC</code> has precedence over
5953: <code class="varname">PREFER_NATIVE</code>. For example, to require
5954: using pkgsrc versions of software for all but the most basic
5955: bits on a NetBSD system, you can set:</p>
5956: <pre class="programlisting">
1.100 rillig 5957: PREFER_PKGSRC= yes
5958: PREFER_NATIVE= getopt skey tcp_wrappers
5959: </pre>
1.87 wiz 5960: <p>A package <span class="emphasis"><em>must</em></span> have a
5961: <code class="filename">builtin.mk</code>
5962: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5963: otherwise it is simply ignored in that list.</p>
1.75 rillig 5964: </div>
5965: </div>
5966: </div>
1.148 asau 5967: <div class="chapter">
1.75 rillig 5968: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5969: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5970: <div class="toc">
5971: <p><b>Table of Contents</b></p>
5972: <dl>
1.106 rillig 5973: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75 rillig 5974: <dd><dl>
1.106 rillig 5975: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5976: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5977: </dl></dd>
1.106 rillig 5978: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5979: <dd><dl>
1.128 wiz 5980: <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.106 rillig 5981: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5982: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5983: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5984: </dl></dd>
5985: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5986: <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>
5987: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5988: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5989: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5990: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5991: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75 rillig 5992: </dl>
5993: </div>
5994: <p>This chapter describes the framework known as
5995: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 5996: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5997: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5998: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5999: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 6000: provided that packages are correctly designed.</p></li>
1.128 wiz 6001: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6002: <li class="listitem"><p>Registration of system users and groups.</p></li>
6003: <li class="listitem"><p>Registration of system shells.</p></li>
6004: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 6005: </ul></div>
6006: <p>The following sections inspect each of the above points in detail.</p>
6007: <p>You may be thinking that many of the things described here could be
6008: easily done with simple code in the package's post-installation target
6009: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6010: as the code in them is only executed when building from source. Machines
6011: using binary packages could not benefit from it at all (as the code itself
6012: could be unavailable). Therefore, the only way to achieve any of the items
6013: described above is by means of the installation scripts, which are
6014: automatically generated by pkginstall.</p>
1.148 asau 6015: <div class="sect1">
1.75 rillig 6016: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6017: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 6018: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 6019: of files and directories that belong to a package. The names used in it
1.76 rillig 6020: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 6021: which means that it cannot register files outside this directory (absolute
6022: path names are not allowed). Despite this restriction, some packages need
6023: to install files outside this location; e.g., under
1.76 rillig 6024: <code class="filename">${VARBASE}</code> or
1.87 wiz 6025: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6026: is to create such files during installation time by using
6027: installation scripts.</p>
6028: <p>The generic installation scripts are shell scripts that can
6029: contain arbitrary code. The list of scripts to execute is taken from
6030: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6031: <code class="filename">INSTALL</code>. A similar variable exists for package
6032: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6033: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6034: commands, so they have the potential to create and manage files
6035: anywhere in the file system.</p>
6036: <p>Using these general installation files is not recommended, but
6037: may be needed in some special cases. One reason for avoiding them is
6038: that the user has to trust the packager that there is no unwanted or
6039: simply erroneous code included in the installation script. Also,
6040: previously there were many similar scripts for the same functionality,
6041: and fixing a common error involved finding and changing all of
6042: them.</p>
6043: <p>The pkginstall framework offers another, standardized way. It
6044: provides generic scripts to abstract the manipulation of such files
6045: and directories based on variables set in the package's
6046: <code class="filename">Makefile</code>. The rest of this section describes
6047: these variables.</p>
1.148 asau 6048: <div class="sect2">
1.75 rillig 6049: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6050: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 6051: <p>The following variables can be set to request the creation of
6052: directories anywhere in the file system:</p>
1.148 asau 6053: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6054: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 6055: contain a list of directories that should be created and should attempt
6056: to be destroyed by the installation scripts. The difference between
6057: the two is that the latter prompts the administrator to remove any
6058: directories that may be left after deinstallation (because they were
6059: not empty), while the former does not.</p></li>
1.128 wiz 6060: <li class="listitem">
1.75 rillig 6061: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6062: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6063: which directories should be created and should attempt to be destroyed
6064: by the installation scripts. Each tuple holds the following values,
6065: separated by spaces: the directory name, its owner, its group and its
6066: numerical mode. For example:</p>
6067: <pre class="programlisting">
1.100 rillig 6068: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 6069: </pre>
1.75 rillig 6070: <p>The difference between the two is exactly the same as their
6071: non-<code class="varname">PERMS</code> counterparts.</p>
6072: </li>
6073: </ul></div>
6074: </div>
1.148 asau 6075: <div class="sect2">
1.75 rillig 6076: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6077: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 6078: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 6079: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 6080: To overcome this problem, the only solution is to extract the file in the
6081: known place (i.e., inside the installation prefix) and copy it to the
6082: appropriate location during installation (done by the installation scripts
6083: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6084: file</em></span> in the following paragraphs, which describe the variables
6085: that can be used to automatically and consistently handle files outside the
6086: installation prefix:</p>
1.148 asau 6087: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6088: <li class="listitem">
1.75 rillig 6089: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 6090: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 6091: During installation time, the master file is copied to the target one
6092: if and only if the latter does not exist. Upon deinstallation, the
6093: target file is removed provided that it was not modified by the
6094: installation.</p>
6095: <p>The difference between the two is that the latter prompts the
6096: administrator to remove any files that may be left after
6097: deinstallation (because they were not empty), while the former does
6098: not.</p>
6099: </li>
1.128 wiz 6100: <li class="listitem">
1.75 rillig 6101: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 6102: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 6103: files as well as their target locations. For each of them, it also
6104: specifies their owner, their group and their numeric permissions, in
6105: this order. For example:</p>
6106: <pre class="programlisting">
1.137 wiz 6107: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 6108: </pre>
1.75 rillig 6109: <p>The difference between the two is exactly the same as their
6110: non-<code class="varname">PERMS</code> counterparts.</p>
6111: </li>
6112: </ul></div>
6113: </div>
6114: </div>
1.148 asau 6115: <div class="sect1">
1.75 rillig 6116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6117: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 6118: <p>Configuration files are special in the sense that they are installed
6119: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
6120: need special treatment during installation (most of which is automated by
6121: pkginstall). The main concept you must bear in mind is that files marked
6122: as configuration files are automatically copied to the right place (somewhere
6123: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
6124: and only if</em></span> they didn't exist before. Similarly, they will not
6125: be removed if they have local modifications. This ensures that
6126: administrators never lose any custom changes they may have made.</p>
1.148 asau 6127: <div class="sect2">
1.75 rillig 6128: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6129: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75 rillig 6130: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
6131: specifies where configuration files shall be installed. Its contents are
6132: set based upon the following variables:</p>
1.148 asau 6133: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6134: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 6135: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 6136: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 6137: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 6138: Packages must not use it directly.</p></li>
1.128 wiz 6139: <li class="listitem">
1.75 rillig 6140: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
6141: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
6142: for the package being built shall be installed. The definition of this
6143: variable only makes sense in the package's
1.76 rillig 6144: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 6145: <p>As an example, consider the Apache package,
1.91 rillig 6146: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache2/README.html" target="_top"><code class="filename">www/apache2</code></a>, which places its
1.75 rillig 6147: configuration files under the
1.76 rillig 6148: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 6149: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
6150: Makefile.</p>
6151: </li>
1.128 wiz 6152: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 6153: variable that holds this package's configuration directory (if
6154: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
6155: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
6156: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 6157: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 6158: directory where the configuration files for the package identified by
6159: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
6160: </ul></div>
6161: <p>Based on the above variables, pkginstall determines the value of
6162: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6163: variable that can be used within a package to refer to its configuration
6164: directory. The algorithm used to set its value is basically the
6165: following:</p>
1.128 wiz 6166: <div class="orderedlist"><ol class="orderedlist" type="1">
6167: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 6168: its value is used.</p></li>
1.128 wiz 6169: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 6170: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 6171: <code class="filename">Makefile</code>, the resulting value is
6172: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 6173: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 6174: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 6175: </ol></div>
1.76 rillig 6176: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 6177: 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
6178: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
6179: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 6180: </div>
1.148 asau 6181: <div class="sect2">
1.75 rillig 6182: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6183: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 6184: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6185: known place, you need to teach each package where it shall install its
6186: files. In some cases you will have to patch the package Makefiles to
6187: achieve it. If you are lucky, though, it may be as easy as passing an
6188: extra flag to the configuration script; this is the case of GNU Autoconf-
6189: generated files:</p>
6190: <pre class="programlisting">
1.100 rillig 6191: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 6192: </pre>
1.75 rillig 6193: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6194: for</em></span> its configuration files, not where they will be originally
6195: installed (although the difference is never explicit,
6196: unfortunately).</p>
6197: </div>
1.148 asau 6198: <div class="sect2">
1.75 rillig 6199: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6200: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6201: <p>As said before, pkginstall automatically handles configuration files.
6202: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6203: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6204: directly</strong></span>. Bad news is that many software installation scripts
6205: will, out of the box, mess with the contents of that directory. So what is
6206: the correct procedure to fix this issue?</p>
6207: <p>You must teach the package (usually by manually patching it) to
6208: install any configuration files under the examples hierarchy,
1.76 rillig 6209: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6210: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6211: has the original copies available.</p>
6212: <p>Once the required configuration files are in place (i.e., under the
6213: examples hierarchy), the pkginstall framework can use them as master copies
6214: during the package installation to update what is in
1.76 rillig 6215: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6216: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 6217: used. Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, “File manipulation”</a> for information
1.75 rillig 6218: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6219: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75 rillig 6220: <pre class="programlisting">
1.100 rillig 6221: EGDIR= ${PREFIX}/share/doc/mutt/samples
6222: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6223: </pre>
1.75 rillig 6224: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6225: package and has no meaning outside it.</p>
6226: </div>
1.148 asau 6227: <div class="sect2">
1.75 rillig 6228: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6229: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6230: <p>The automatic copying of config files can be toggled by setting the
6231: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6232: installation.</p>
6233: </div>
6234: </div>
1.148 asau 6235: <div class="sect1">
1.75 rillig 6236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6237: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 6238: <p>System startup scripts are special files because they must be
6239: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 6240: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.75 rillig 6241: can be used. However, pkginstall provides a special mechanism to handle
6242: these files.</p>
6243: <p>In order to provide system startup scripts, the package has
6244: to:</p>
1.128 wiz 6245: <div class="orderedlist"><ol class="orderedlist" type="1">
6246: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6247: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6248: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.76 rillig 6249: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 6250: <li class="listitem">
1.75 rillig 6251: <p>Tell pkginstall to handle it, appending the name of the script,
6252: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6253: Continuing the previous example:</p>
6254: <pre class="programlisting">
1.100 rillig 6255: RCD_SCRIPTS+= cupsd
1.1 grant 6256: </pre>
1.75 rillig 6257: </li>
6258: </ol></div>
6259: <p>Once this is done, pkginstall will do the following steps for each
6260: script in an automated fashion:</p>
1.128 wiz 6261: <div class="orderedlist"><ol class="orderedlist" type="1">
6262: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 6263: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6264: variable.</p></li>
1.128 wiz 6265: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 6266: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6267: that this master file must be explicitly registered in the
1.76 rillig 6268: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 6269: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 6270: from the examples hierarchy into the system-wide startup scripts
6271: directory.</p></li>
6272: </ol></div>
1.148 asau 6273: <div class="sect2">
1.75 rillig 6274: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6275: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6276: <p>The automatic copying of config files can be toggled by setting the
6277: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6278: installation. Note that the scripts will be always copied inside the
1.76 rillig 6279: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6280: matter what the value of this variable is.</p>
6281: </div>
6282: </div>
1.148 asau 6283: <div class="sect1">
1.75 rillig 6284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6285: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 6286: <p>If a package needs to create special users and/or groups during
6287: installation, it can do so by using the pkginstall framework.</p>
6288: <p>Users can be created by adding entries to the
6289: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6290: syntax:</p>
6291: <pre class="programlisting">
1.100 rillig 6292: user:group
1.1 grant 6293: </pre>
1.87 wiz 6294: <p>Further specification of user details may be done by setting
6295: per-user variables.
6296: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6297: numeric UID for the user.
6298: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6299: user's description or comment.
6300: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6301: user's home directory, and defaults to
6302: <code class="filename">/nonexistent</code> if not specified.
6303: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6304: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6305: not specified.</p>
1.75 rillig 6306: <p>Similarly, groups can be created by adding entries to the
6307: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6308: <pre class="programlisting">
1.100 rillig 6309: group
1.1 grant 6310: </pre>
1.93 rillig 6311: <p>The numeric GID of the group may be set by defining
1.75 rillig 6312: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6313: <p>If a package needs to create the users and groups at an earlier
6314: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6315: either <code class="literal">configure</code> or <code class="literal">build</code> to
6316: indicate the phase before which the users and groups are created. In
6317: this case, the numeric UIDs and GIDs of the created users and groups
6318: are automatically hardcoded into the final installation scripts.</p>
6319: </div>
1.148 asau 6320: <div class="sect1">
1.75 rillig 6321: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6322: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 6323: <p>Packages that install system shells should register them in the shell
1.76 rillig 6324: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6325: administrator. This must be done from the installation scripts to keep
6326: binary packages working on any system. pkginstall provides an easy way to
6327: accomplish this task.</p>
6328: <p>When a package provides a shell interpreter, it has to set the
6329: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6330: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6331: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75 rillig 6332: <pre class="programlisting">
1.100 rillig 6333: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6334: </pre>
1.148 asau 6335: <div class="sect2">
1.75 rillig 6336: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6337: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6338: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6339: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6340: environment variable to <code class="literal">NO</code>.</p>
6341: </div>
6342: </div>
1.148 asau 6343: <div class="sect1">
1.75 rillig 6344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6345: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 6346: <p>Packages that install X11 fonts should update the database files
6347: that index the fonts within each fonts directory. This can easily be
6348: accomplished within the pkginstall framework.</p>
6349: <p>When a package installs X11 fonts, it must list the directories in
6350: which fonts are installed in the
6351: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 6352: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
6353: <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.75 rillig 6354: installation scripts to run the appropriate commands to update the fonts
6355: database files within each of those directories. For convenience, if the
6356: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6357: installation prefix. Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75 rillig 6358: <pre class="programlisting">
1.100 rillig 6359: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6360: </pre>
1.148 asau 6361: <div class="sect2">
1.75 rillig 6362: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6363: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6364: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6365: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6366: environment variable to <code class="literal">NO</code>.</p>
6367: </div>
6368: </div>
6369: </div>
1.148 asau 6370: <div class="chapter">
1.75 rillig 6371: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6372: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 6373: <div class="toc">
6374: <p><b>Table of Contents</b></p>
6375: <dl>
1.106 rillig 6376: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 6377: <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.106 rillig 6378: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 6379: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6380: </dl>
6381: </div>
6382: <p>Many packages have the ability to be built to support different
1.76 rillig 6383: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6384: in pkgsrc that provides generic handling of those options that
6385: determine different ways in which the packages can be built. It's
6386: possible for the user to specify exactly which sets of options will be
6387: built into a package or to allow a set of global default options
6388: apply.</p>
1.107 rillig 6389: <p>There are two broad classes of behaviors that one might want to
6390: control via options. One is whether some particular feature is
6391: enabled in a program that will be built anyway, often by including or
6392: not including a dependency on some other package. The other is
6393: whether or not an additional program will be built as part of the
6394: package. Generally, it is better to make a split package for such
6395: additional programs instead of using options, because it enables
6396: binary packages to be built which can then be added separately. For
6397: example, the foo package might have minimal dependencies (those
6398: packages without which foo doesn't make sense), and then the foo-gfoo
6399: package might include the GTK frontend program gfoo. This is better
6400: than including a gtk option to foo that adds gfoo, because either that
6401: option is default, in which case binary users can't get foo without
6402: gfoo, or not default, in which case they can't get gfoo. With split
6403: packages, they can install foo without having GTK, and later decide to
6404: install gfoo (pulling in GTK at that time). This is an advantage to
6405: source users too, avoiding the need for rebuilds.</p>
6406: <p>Plugins with widely varying dependencies should usually be split
6407: instead of options.</p>
6408: <p>It is often more work to maintain split packages, especially if
6409: the upstream package does not support this. The decision of split
6410: vs. option should be made based on the likelihood that users will want
6411: or object to the various pieces, the size of the dependencies that are
6412: included, and the amount of work.</p>
6413: <p>A further consideration is licensing. Non-free parts, or parts
6414: that depend on non-free dependencies (especially plugins) should
6415: almost always be split if feasible.</p>
1.148 asau 6416: <div class="sect1">
1.75 rillig 6417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6418: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6419: <p>Global default options are listed in
6420: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6421: that should be built into every package if that option is supported.
1.110 hubertf 6422: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6423: </div>
1.148 asau 6424: <div class="sect1">
1.75 rillig 6425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6426: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6427: </h2></div></div></div>
1.75 rillig 6428: <p>The following example shows how
1.76 rillig 6429: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6430: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6431: <code class="filename">Makefile</code>, or in a file,
6432: e.g. <code class="filename">options.mk</code>, that is included by the
6433: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6434: <pre class="programlisting">
1.100 rillig 6435: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6436: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6437: PKG_OPTIONS_OPTIONAL_GROUPS= database
6438: PKG_OPTIONS_GROUP.database= mysql pgsql
6439: PKG_SUGGESTED_OPTIONS= wibble-foo
6440: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6441: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6442:
6443: .include "../../mk/bsd.prefs.mk"
6444:
6445: # this package was previously named wibble2
6446: .if defined(PKG_OPTIONS.wibble2)
6447: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6448: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6449: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6450: .endif
6451:
6452: .include "../../mk/bsd.options.mk"
6453:
6454: # Package-specific option-handling
6455:
6456: ###
6457: ### FOO support
6458: ###
6459: .if !empty(PKG_OPTIONS:Mwibble-foo)
6460: CONFIGURE_ARGS+= --enable-foo
6461: .endif
6462:
6463: ###
6464: ### LDAP support
6465: ###
6466: .if !empty(PKG_OPTIONS:Mldap)
6467: . include "../../databases/openldap-client/buildlink3.mk"
6468: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6469: .endif
6470:
6471: ###
6472: ### database support
6473: ###
6474: .if !empty(PKG_OPTIONS:Mmysql)
6475: . include "../../mk/mysql.buildlink3.mk"
6476: .endif
6477: .if !empty(PKG_OPTIONS:Mpgsql)
6478: . include "../../mk/pgsql.buildlink3.mk"
6479: .endif
1.75 rillig 6480: </pre>
6481: <p>The first section contains the information about which build
6482: options are supported by the package, and any default options settings
6483: if needed.</p>
1.128 wiz 6484: <div class="orderedlist"><ol class="orderedlist" type="1">
6485: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.136 dholland 6486: <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.75 rillig 6487: options. It should be set to
1.78 rillig 6488: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6489: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6490: at the point where the options are processed.</p></li>
1.128 wiz 6491: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6492: build options supported by the package.</p></li>
1.128 wiz 6493: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6494: list of names of groups of mutually exclusive options. The options in
6495: each group are listed in
6496: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6497: The most specific setting of any option from the group takes
6498: precedence over all other options in the group. Options from the
6499: groups will be automatically added to
6500: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 6501: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6502: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6503: packages will fail if no option from the group is
6504: selected.</p></li>
1.128 wiz 6505: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6506: of names of sets of options. At least one option from each set must
6507: be selected. The options in each set are listed in
6508: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6509: Options from the sets will be automatically added to
6510: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6511: fail if no option from the set is selected.</p></li>
1.128 wiz 6512: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6513: build options which are enabled by default.</p></li>
1.128 wiz 6514: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6515: of
1.128 wiz 6516: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.110 hubertf 6517: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6518: their option counterparts. Pairs should be added with
1.128 wiz 6519: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6520: warning will be issued if the user uses a legacy
6521: variable.</p></li>
1.128 wiz 6522: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6523: of
1.128 wiz 6524: <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.75 rillig 6525: pairs that map options that have been renamed to their new
1.128 wiz 6526: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6527: the listing of global legacy options. A warning will be issued if
6528: the user uses a legacy option.</p></li>
1.128 wiz 6529: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6530: options implied by deprecated variables used. This can be used for
6531: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6532: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6533: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 6534: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6535: a list of warnings about deprecated variables or options used, and
6536: what to use instead.</p></li>
6537: </ol></div>
6538: <p>A package should never modify
6539: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6540: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6541: To suggest a default set of options, use
6542: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6543: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6544: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6545: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6546: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6547: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6548: happen with platform-specific options if none of them is supported on
6549: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6550: empty list and the package is otherwise treated as not using the
6551: options framework.</p>
1.76 rillig 6552: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6553: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6554: build options, properly filtered to remove unsupported and duplicate
6555: options.</p>
6556: <p>The remaining sections contain the logic that is specific to
6557: each option. The correct way to check for an option is to check
6558: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6559: <pre class="programlisting">
1.100 rillig 6560: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6561: </pre>
6562: </div>
1.148 asau 6563: <div class="sect1">
1.75 rillig 6564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6565: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6566: <p>Options that enable similar features in different packages (like
6567: optional support for a library) should use a common name in all
6568: packages that support it (like the name of the library). If another
6569: package already has an option with the same meaning, use the same
6570: name.</p>
6571: <p>Options that enable features specific to one package, where it's
6572: unlikely that another (unrelated) package has the same (or a similar)
6573: optional feature, should use a name prefixed with
6574: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6575: <p>If a group of related packages share an optional feature
6576: specific to that group, prefix it with the name of the
1.128 wiz 6577: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6578: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6579: <p>For new options, add a line to
1.76 rillig 6580: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6581: fields, separated by tab. The first field is the option name, the
6582: second its description. The description should be a whole sentence
6583: (starting with an uppercase letter and ending with a period) that
1.128 wiz 6584: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6585: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6586: </div>
1.148 asau 6587: <div class="sect1">
1.107 rillig 6588: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6589: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6590: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107 rillig 6591: different dependencies based on the options with which the package was
6592: built. For querying these options, the file
6593: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6594: typical example looks like this:</p>
6595: <pre class="programlisting">
6596: pkgbase := libpurple
6597: .include "../../mk/pkg-build-options.mk"
6598:
6599: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6600: ...
6601: .endif
6602: </pre>
6603: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6604: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6605: options of the libpurple package, which can then be queried like
6606: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6607: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6608: details.</p>
6609: </div>
1.75 rillig 6610: </div>
1.148 asau 6611: <div class="chapter">
1.75 rillig 6612: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6613: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6614: <div class="toc">
6615: <p><b>Table of Contents</b></p>
6616: <dl>
1.106 rillig 6617: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6618: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6619: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6620: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 6621: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 6622: <dd><dl>
6623: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6624: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6625: </dl></dd>
1.128 wiz 6626: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6627: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6628: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6629: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6630: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6631: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6632: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6633: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6634: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6635: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 6636: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6637: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6638: </dl>
6639: </div>
1.148 asau 6640: <div class="sect1">
1.75 rillig 6641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6642: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6643: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6644: built. Building a package is separated into different
6645: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6646: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6647: described in the following sections. Each phase is split into
1.87 wiz 6648: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6649: containing phase, prefixed by one of <code class="varname">pre-</code>,
6650: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6651: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6652: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6653: <p>Never override the regular targets (like
6654: <code class="varname">fetch</code>), if you have to, override the
6655: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6656: <p>The basic steps for building a program are always the same. First
1.87 wiz 6657: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6658: the local system and then extracted. After any pkgsrc-specific patches
6659: to compile properly are applied, the software can be configured, then
6660: built (usually by compiling), and finally the generated binaries, etc.
6661: can be put into place on the system.</p>
1.97 rillig 6662: <p>To get more details about what is happening at each step,
6663: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6664: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6665: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6666: </div>
1.148 asau 6667: <div class="sect1">
1.75 rillig 6668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6669: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6670: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6671: the next section, here's a brief discussion on where programs are
6672: installed, and which variables influence this.</p>
1.75 rillig 6673: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6674: where all files of the final program shall be installed. It is
6675: usually set to <code class="varname">LOCALBASE</code>
6676: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6677: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6678: <code class="varname">PREFIX</code> needs to be put
6679: into the various places in the program's source where paths to
1.110 hubertf 6680: these files are encoded. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.75 rillig 6681: <p>When choosing which of these variables to use,
1.87 wiz 6682: follow the following rules:</p>
1.148 asau 6683: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6684: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6685: where the current pkg will be installed. When referring to a
6686: pkg's own installation path, use
1.128 wiz 6687: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6688: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6689: are installed. If you need to construct a -I or -L argument
6690: to the compiler to find includes and libraries installed by
1.128 wiz 6691: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6692: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6693: installed all packages in <code class="filename">/usr/local</code>. As
6694: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6695: administrator, this variable is a misnomer.</p></li>
1.128 wiz 6696: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6697: distribution (from xsrc, etc.) is installed. When looking for
6698: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 6699: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6700: <li class="listitem">
1.88 wiz 6701: <p>X11-based packages are special in that they may be
6702: installed in either <code class="varname">X11BASE</code> or
6703: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6704: <p>Usually, X11 packages should be installed under
1.88 wiz 6705: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6706: will need to include
6707: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6708: request the presence of X11 and to get the right compilation
6709: flags.</p>
1.75 rillig 6710: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6711: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6712: files. These packages are special and they must be placed under
6713: <code class="varname">X11BASE</code>. To accomplish this, set either
6714: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6715: your package.</p>
1.75 rillig 6716: <p>Some notes: If you need
1.87 wiz 6717: to find includes or libraries installed by a pkg that has
6718: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6719: its pkg <code class="filename">Makefile</code>, you need to look in
6720: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6721: <code class="filename">${LOCALBASE}</code>. To force installation of
6722: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6723: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
1.87 wiz 6724: is enabled by default.</p>
1.75 rillig 6725: </li>
1.128 wiz 6726: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6727: the installed location of an X11
6728: package. <code class="varname">X11PREFIX</code> will be set to
6729: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6730: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6731: installed.</p></li>
1.128 wiz 6732: <li class="listitem">
1.88 wiz 6733: <p>If xpkgwedge is installed, it is possible to have some
6734: packages installed in <code class="varname">X11BASE</code> and some in
6735: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6736: installed package, the <code class="varname">EVAL_PREFIX</code>
6737: definition can be used. It takes pairs in the format
1.136 dholland 6738: <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.88 wiz 6739: variable <code class="varname">DIRNAME</code> will be set to the prefix
6740: of the installed package <package>, or
1.128 wiz 6741: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6742: installed.</p>
1.75 rillig 6743: <p>This is best illustrated by example.</p>
6744: <p>The following lines are taken from
1.87 wiz 6745: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6746: <pre class="programlisting">
1.100 rillig 6747: EVAL_PREFIX+= GTKDIR=gtk+
6748: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6749: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6750: CONFIGURE_ARGS+= --enable-multibyte
6751: </pre>
1.88 wiz 6752: <p>Specific defaults can be defined for the packages
6753: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6754: definition of the form:</p>
1.75 rillig 6755: <pre class="programlisting">
1.100 rillig 6756: GTKDIR_DEFAULT= ${LOCALBASE}
6757: </pre>
1.75 rillig 6758: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6759: to the first definition in
6760: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6761: </li>
1.128 wiz 6762: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.136 dholland 6763: 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.87 wiz 6764: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6765: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6766: </ul></div>
6767: </div>
1.148 asau 6768: <div class="sect1">
1.75 rillig 6769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6770: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6771: <p>When building a package, various directories are used to store
1.87 wiz 6772: source files, temporary files, pkgsrc-internal files, and so on. These
6773: directories are explained here.</p>
1.75 rillig 6774: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6775: are two common base directories for these relative directories:
6776: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6777: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6778: inside the package itself.</p>
1.148 asau 6779: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6780: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6781: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6782: root directory. Generally, you don't need
6783: it.</p></dd>
1.97 rillig 6784: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6785: <dd><p>This is an absolute pathname that points to the
6786: current package.</p></dd>
1.75 rillig 6787: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6788: <dd><p>This is a pathname relative to
1.87 wiz 6789: <code class="varname">PKGSRCDIR</code> that points to the current
6790: package.</p></dd>
1.75 rillig 6791: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6792: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6793: where all work takes place. The distfiles are extracted to this
1.87 wiz 6794: directory. It also contains temporary directories and log files used by
6795: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6796: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6797: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6798: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6799: where the distfiles are extracted. It is usually a direct subdirectory
6800: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6801: that isn't hidden. This variable may be changed by a package
6802: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6803: </dl></div>
1.114 jmcneill 6804: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6805: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6806: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6807: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6808: If users would like to have their pkgsrc trees behave in a
6809: read-only manner, then the value of
6810: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6811: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6812: </div>
1.148 asau 6813: <div class="sect1">
1.75 rillig 6814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6815: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6816: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6817: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6818: phase. This will automatically run all phases that are required for this
6819: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6820: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6821: the package will be built, but not installed.</p>
1.75 rillig 6822: </div>
1.148 asau 6823: <div class="sect1">
1.75 rillig 6824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6825: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6826: <p>The first step in building a package is to fetch the
1.88 wiz 6827: distribution files (distfiles) from the sites that are providing
6828: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6829: phase.</p>
1.148 asau 6830: <div class="sect2">
1.81 rillig 6831: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6832: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88 wiz 6833: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6834: defines all URLs from where the distfile, whose name is
6835: derived from the <code class="varname">DISTNAME</code> variable, is
6836: fetched. The more complicated cases are described
6837: below.</p>
6838: <p>The variable <code class="varname">DISTFILES</code> specifies
6839: the list of distfiles that have to be fetched. Its value
6840: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6841: so that most packages don't need to define it at all.
6842: <code class="varname">EXTRACT_SUFX</code> is
6843: <code class="literal">.tar.gz</code> by default, but can be changed
6844: freely. Note that if your package requires additional
6845: distfiles to the default one, you cannot just append the
6846: additional filenames using the <code class="literal">+=</code>
6847: operator, but you have write for example:</p>
1.81 rillig 6848: <pre class="programlisting">
1.100 rillig 6849: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6850: </pre>
1.88 wiz 6851: <p>Each distfile is fetched from a list of sites, usually
6852: <code class="varname">MASTER_SITES</code>. If the package has multiple
6853: <code class="varname">DISTFILES</code> or multiple
6854: <code class="varname">PATCHFILES</code> from different sites, you can
6855: set
6856: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6857: to the list of URLs where the file
6858: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6859: (including the suffix) can be found.</p>
6860: <pre class="programlisting">
1.100 rillig 6861: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6862: DISTFILES+= foo-file.tar.gz
6863: SITES.foo-file.tar.gz= \
6864: http://www.somewhere.com/somehow/ \
6865: http://www.somewhereelse.com/mirror/somehow/
6866: </pre>
1.81 rillig 6867: <p>When actually fetching the distfiles, each item from
1.88 wiz 6868: <code class="varname">MASTER_SITES</code> or
6869: <code class="varname">SITES.*</code> gets the name of each distfile
6870: appended to it, without an intermediate slash. Therefore,
6871: all site values have to end with a slash or other separator
6872: character. This allows for example to set
6873: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6874: that gets the name of the distfile as a parameter. In this
6875: case, the definition would look like:</p>
1.81 rillig 6876: <pre class="programlisting">
1.100 rillig 6877: MASTER_SITES= http://www.example.com/download.cgi?file=
6878: </pre>
1.125 wiz 6879: <p> The exception to this rule are URLs starting with a dash.
6880: In that case the URL is taken as is, fetched and the result stored
6881: under the name of the distfile.</p>
1.81 rillig 6882: <p>There are some predefined values for
1.88 wiz 6883: <code class="varname">MASTER_SITES</code>, which can be used in
6884: packages. The names of the variables should speak for
6885: themselves.</p>
6886: <pre class="programlisting">
1.100 rillig 6887: ${MASTER_SITE_APACHE}
6888: ${MASTER_SITE_BACKUP}
6889: ${MASTER_SITE_CYGWIN}
6890: ${MASTER_SITE_DEBIAN}
6891: ${MASTER_SITE_FREEBSD}
6892: ${MASTER_SITE_FREEBSD_LOCAL}
6893: ${MASTER_SITE_GENTOO}
6894: ${MASTER_SITE_GNOME}
6895: ${MASTER_SITE_GNU}
6896: ${MASTER_SITE_GNUSTEP}
6897: ${MASTER_SITE_IFARCHIVE}
6898: ${MASTER_SITE_KDE}
6899: ${MASTER_SITE_MOZILLA}
6900: ${MASTER_SITE_MYSQL}
6901: ${MASTER_SITE_OPENOFFICE}
6902: ${MASTER_SITE_PERL_CPAN}
6903: ${MASTER_SITE_PGSQL}
6904: ${MASTER_SITE_R_CRAN}
6905: ${MASTER_SITE_SOURCEFORGE}
6906: ${MASTER_SITE_SOURCEFORGE_JP}
6907: ${MASTER_SITE_SUNSITE}
6908: ${MASTER_SITE_SUSE}
6909: ${MASTER_SITE_TEX_CTAN}
6910: ${MASTER_SITE_XCONTRIB}
6911: ${MASTER_SITE_XEMACS}
6912: </pre>
1.88 wiz 6913: <p>Some explanations for the less self-explaining ones:
6914: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 6915: 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.132 spz 6916: 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.88 wiz 6917: <p>If you choose one of these predefined sites, you may
6918: want to specify a subdirectory of that site. Since these
6919: macros may expand to more than one actual site, you
6920: <span class="emphasis"><em>must</em></span> use the following construct to
6921: specify a subdirectory:</p>
1.81 rillig 6922: <pre class="programlisting">
1.100 rillig 6923: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6924: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6925: </pre>
1.81 rillig 6926: <p>Note the trailing slash after the subdirectory
1.88 wiz 6927: name.</p>
1.81 rillig 6928: </div>
1.148 asau 6929: <div class="sect2">
1.81 rillig 6930: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6931: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6932: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6933: all the distfiles exist in a local directory
1.93 rillig 6934: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6935: user). If the files do not exist, they are fetched using
6936: commands of the form</p>
1.75 rillig 6937: <pre class="programlisting">
1.100 rillig 6938: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6939: </pre>
1.88 wiz 6940: <p>where <code class="literal">${site}</code> varies through
6941: several possibilities in turn: first,
6942: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6943: sites specified in either <code class="varname">SITES.file</code> if
6944: defined, else <code class="varname">MASTER_SITES</code> or
6945: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6946: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6947: all except the first and the last can be optionally sorted
6948: by the user, via setting either
6949: <code class="varname">MASTER_SORT_RANDOM</code>, and
6950: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6951: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6952: <p> The specific command and arguments used depend on the
6953: <code class="varname">FETCH_USING</code> parameter. The example above is
6954: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6955: <p>The distfiles mirror run by the NetBSD Foundation uses the
6956: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6957: distfiles, if they are freely distributable. Packages setting
6958: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6959: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6960: mirrored.</p>
1.81 rillig 6961: </div>
1.75 rillig 6962: </div>
1.148 asau 6963: <div class="sect1">
1.75 rillig 6964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6965: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6966: <p>After the distfile(s) are fetched, their checksum is
6967: generated and compared with the checksums stored in the
6968: distinfo file. If the checksums don't match, the build is
6969: aborted. This is to ensure the same distfile is used for
6970: building, and that the distfile wasn't changed, e.g. by some
6971: malign force, deliberately changed distfiles on the master
6972: distribution site or network lossage.</p>
1.75 rillig 6973: </div>
1.148 asau 6974: <div class="sect1">
1.75 rillig 6975: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6976: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6977: <p>When the distfiles are present on the local system, they
1.88 wiz 6978: need to be extracted, as they usually come in the form of some
6979: compressed archive format.</p>
1.75 rillig 6980: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6981: extracted. If you only need some of them, you can set the
6982: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6983: files.</p>
6984: <p>Extracting the files is usually done by a little
1.93 rillig 6985: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6986: already knows how to extract various archive formats, so most
6987: likely you will not need to change anything here. But if you
6988: need, the following variables may help you:</p>
1.148 asau 6989: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6990: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6991: <dd><p>Use these variables to override the default
1.88 wiz 6992: options for an extract command, which are defined in
1.93 rillig 6993: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6994: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6995: <dd><p>This variable can be set to
1.114 jmcneill 6996: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6997: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6998: absolute pathname pointing to the command with which tar
1.114 jmcneill 6999: archives should be extracted. It is preferred to choose bsdtar over gtar
7000: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 7001: </dl></div>
1.88 wiz 7002: <p>If the <code class="filename">extract</code> program doesn't
7003: serve your needs, you can also override the
7004: <code class="varname">EXTRACT_CMD</code> variable, which holds the
7005: command used for extracting the files. This command is
7006: executed in the <code class="filename">${WRKSRC}</code>
7007: directory. During execution of this command, the shell
7008: variable <code class="varname">extract_file</code> holds the absolute
7009: pathname of the file that is going to be extracted.</p>
1.75 rillig 7010: <p>And if that still does not suffice, you can override the
1.88 wiz 7011: <code class="varname">do-extract</code> target in the package
7012: Makefile.</p>
1.75 rillig 7013: </div>
1.148 asau 7014: <div class="sect1">
1.75 rillig 7015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7016: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 7017: <p>After extraction, all the patches named by the
1.88 wiz 7018: <code class="varname">PATCHFILES</code>, those present in the patches
7019: subdirectory of the package as well as in
7020: $LOCALPATCHES/$PKGPATH (e.g.
7021: <code class="filename">/usr/local/patches/graphics/png</code>) are
7022: applied. Patchfiles ending in <code class="filename">.Z</code> or
7023: <code class="filename">.gz</code> are uncompressed before they are
7024: applied, files ending in <code class="filename">.orig</code> or
7025: <code class="filename">.rej</code> are ignored. Any special options to
1.136 dholland 7026: <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.110 hubertf 7027: <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.136 dholland 7028: <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.88 wiz 7029: it fail if the patches apply with some lines of fuzz. Please
7030: fix (regen) the patches so that they apply cleanly. The
7031: rationale behind this is that patches that don't apply cleanly
7032: may end up being applied in the wrong place, and cause severe
7033: harm there.</p>
1.75 rillig 7034: </div>
1.148 asau 7035: <div class="sect1">
1.75 rillig 7036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7037: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 7038: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.88 wiz 7039: </p>
1.75 rillig 7040: </div>
1.148 asau 7041: <div class="sect1">
1.75 rillig 7042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7043: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 7044: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 7045: linkers. The following variables can be used to tweak the
7046: wrappers.</p>
1.148 asau 7047: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7048: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
7049: <dd><p>The command used to print progress
1.88 wiz 7050: messages. Does nothing by default. Set to
7051: <code class="literal">${ECHO}</code> to see the progress
7052: messages.</p></dd>
1.75 rillig 7053: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
7054: <dd><p>This variable can be set to
1.88 wiz 7055: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
7056: depending on whether you want additional information in the
7057: wrapper log file.</p></dd>
1.75 rillig 7058: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
7059: <dd><p>This variable can be set to
1.88 wiz 7060: <code class="literal">yes</code> or <code class="literal">no</code>, depending
7061: on whether the wrapper should use its cache, which will
7062: improve the speed. The default value is
7063: <code class="literal">yes</code>, but is forced to
7064: <code class="literal">no</code> if the platform does not support
7065: it.</p></dd>
1.75 rillig 7066: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 7067: <dd><p>A list of reordering commands. A reordering
7068: command has the form
7069: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
7070: It ensures that that
7071: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
7072: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
7073: </p></dd>
1.75 rillig 7074: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
7075: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 7076: investigate further]</p></dd>
1.75 rillig 7077: </dl></div>
7078: </div>
1.148 asau 7079: <div class="sect1">
1.75 rillig 7080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7081: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 7082: <p>Most pieces of software need information on the header
7083: files, system calls, and library routines which are available
7084: on the platform they run on. The process of determining this
7085: information is known as configuration, and is usually
7086: automated. In most cases, a script is supplied with the
7087: distfiles, and its invocation results in generation of header
7088: files, Makefiles, etc.</p>
7089: <p>If the package contains a configure script, this can be
7090: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 7091: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 7092: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 7093: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 7094: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
7095: <pre class="programlisting">
1.100 rillig 7096: .for d in ${CONFIGURE_DIRS}
7097: cd ${WRKSRC} \
7098: && cd ${d} \
7099: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
7100: .endfor
7101: </pre>
1.88 wiz 7102: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 7103: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 7104: <code class="varname">WRKSRC</code>. In each of these directories, the
7105: configure script is run with the environment
7106: <code class="varname">CONFIGURE_ENV</code> and arguments
7107: <code class="varname">CONFIGURE_ARGS</code>. The variables
7108: <code class="varname">CONFIGURE_ENV</code>,
7109: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 7110: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 7111: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
7112: package.</p>
1.144 wiz 7113: <p>If the program uses the Perl way of configuration (mainly Perl
7114: modules, but not only), i.e. a file called
7115: <code class="filename">Makefile.PL</code>, it should include
7116: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
7117: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
7118: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 7119: <p>If the program uses an <code class="filename">Imakefile</code>
7120: for configuration, the appropriate steps can be invoked by
7121: setting <code class="varname">USE_IMAKE</code> to
1.128 wiz 7122: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 7123: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 7124: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
7125: xmkmf's environment by adding them to the
7126: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 7127: <p>If the program uses <code class="filename">cmake</code>
7128: for configuration, the appropriate steps can be invoked by
1.128 wiz 7129: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 7130: You can add variables to cmake's environment by adding them to the
7131: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
7132: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
7133: The top directory argument is given by the
7134: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 7135: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 7136: <p>If there is no configure step at all, set
1.128 wiz 7137: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 7138: </div>
1.148 asau 7139: <div class="sect1">
1.75 rillig 7140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7141: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 7142: <p>For building a package, a rough equivalent of the
7143: following code is executed.</p>
1.75 rillig 7144: <pre class="programlisting">
1.100 rillig 7145: .for d in ${BUILD_DIRS}
7146: cd ${WRKSRC} \
7147: && cd ${d} \
7148: && env ${MAKE_ENV} \
7149: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
7150: -f ${MAKE_FILE} \
7151: ${BUILD_TARGET}
7152: .endfor
7153: </pre>
1.88 wiz 7154: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 7155: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 7156: <code class="varname">WRKSRC</code>. In each of these directories,
7157: <code class="varname">MAKE_PROGRAM</code> is run with the environment
7158: <code class="varname">MAKE_ENV</code> and arguments
7159: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
7160: <code class="varname">MAKE_ENV</code>,
7161: <code class="varname">BUILD_MAKE_FLAGS</code>,
7162: <code class="varname">MAKE_FILE</code> and
7163: <code class="varname">BUILD_TARGET</code> may all be changed by the
7164: package.</p>
1.75 rillig 7165: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 7166: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
7167: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 7168: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 7169: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
7170: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 7171: <p>If there is no build step at all, set
1.128 wiz 7172: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 7173: </div>
1.148 asau 7174: <div class="sect1">
1.75 rillig 7175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7176: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 7177: <p>[TODO]</p>
7178: </div>
1.148 asau 7179: <div class="sect1">
1.75 rillig 7180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7181: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 7182: <p>Once the build stage has completed, the final step is to
1.88 wiz 7183: install the software in public directories, so users can
7184: access the programs and files.</p>
1.75 rillig 7185: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 7186: equivalent of the following code is executed. Additionally,
7187: before and after this code, much magic is performed to do
7188: consistency checks, registering the package, and so on.</p>
7189: <pre class="programlisting">
1.100 rillig 7190: .for d in ${INSTALL_DIRS}
7191: cd ${WRKSRC} \
7192: && cd ${d} \
7193: && env ${MAKE_ENV} \
7194: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7195: -f ${MAKE_FILE} \
7196: ${INSTALL_TARGET}
7197: .endfor
7198: </pre>
1.75 rillig 7199: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 7200: <span class="emphasis"><em>build</em></span> phase.
7201: <code class="varname">INSTALL_DIRS</code> defaults to
7202: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 7203: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
7204: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 7205: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7206: defined.</p>
1.75 rillig 7207: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 7208: variables are useful. They are all variations of the
1.136 dholland 7209: <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.88 wiz 7210: permissions preset. <code class="varname">INSTALL</code> is the plain
7211: install command. The specialized variants, together with their
7212: intended use, are:</p>
1.148 asau 7213: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7214: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 7215: <dd><p>directories that contain
7216: binaries</p></dd>
1.75 rillig 7217: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 7218: <dd><p>directories that contain
7219: scripts</p></dd>
1.75 rillig 7220: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 7221: <dd><p>directories that contain shared and static
7222: libraries</p></dd>
1.75 rillig 7223: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 7224: <dd><p>directories that contain data
7225: files</p></dd>
1.75 rillig 7226: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 7227: <dd><p>directories that contain man
7228: pages</p></dd>
1.75 rillig 7229: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 7230: <dd><p>binaries that can be stripped from debugging
7231: symbols</p></dd>
1.75 rillig 7232: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 7233: <dd><p>binaries that cannot be
7234: stripped</p></dd>
1.75 rillig 7235: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 7236: <dd><p>game
7237: binaries</p></dd>
1.75 rillig 7238: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 7239: <dd><p>shared and static
7240: libraries</p></dd>
1.75 rillig 7241: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7242: <dd><p>data files</p></dd>
7243: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 7244: <dd><p>data files for
7245: games</p></dd>
1.75 rillig 7246: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7247: <dd><p>man pages</p></dd>
7248: </dl></div>
7249: <p>Some other variables are:</p>
1.148 asau 7250: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7251: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7252: <dd><p>A list of directories relative to
1.88 wiz 7253: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 7254: beginning of the <span class="emphasis"><em>install</em></span> phase.
7255: The package is supposed to create all needed directories itself
7256: before installing files to it and list all other directories here.
7257: </p></dd>
1.75 rillig 7258: </dl></div>
1.97 rillig 7259: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 7260: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 7261: mostly relevant for packages in the <code class="filename">regress</code>
7262: category.</p>
1.75 rillig 7263: </div>
1.148 asau 7264: <div class="sect1">
1.75 rillig 7265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7266: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7267: <p>Once the install stage has completed, a binary package of
7268: the installed files can be built. These binary packages can be
7269: used for quick installation without previous compilation, e.g. by
1.110 hubertf 7270: the <span class="command"><strong>make bin-install</strong></span> or by using
7271: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 7272: <p>By default, the binary packages are created in
7273: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7274: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7275: one for each category in the <code class="varname">CATEGORIES</code>
7276: variable. <code class="varname">PACKAGES</code> defaults to
7277: <code class="filename">pkgsrc/packages</code>.</p>
7278: </div>
1.148 asau 7279: <div class="sect1">
1.88 wiz 7280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7281: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 7282: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 7283: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 7284: to clean the work directories of all dependencies too, use
1.110 hubertf 7285: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 7286: </div>
1.148 asau 7287: <div class="sect1">
1.75 rillig 7288: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7289: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 asau 7290: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7291: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7292: <dd><p>For any of the main targets described in the
7293: previous section, two auxiliary targets exist with
1.128 wiz 7294: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.87 wiz 7295: prefix for the main target's name. These targets are
1.88 wiz 7296: invoked before and after the main target is called,
7297: allowing extra configuration or installation steps be
7298: performed from a package's Makefile, for example, which
7299: a program's configure script or install target
7300: omitted.</p></dd>
1.75 rillig 7301: <dt><span class="term">do-*</span></dt>
1.88 wiz 7302: <dd><p>Should one of the main targets do the wrong thing,
7303: and should there be no variable to fix this, you can
7304: redefine it with the do-* target. (Note that redefining
7305: the target itself instead of the do-* target is a bad
7306: idea, as the pre-* and post-* targets won't be called
7307: anymore, etc.) You will not usually need to do
7308: this.</p></dd>
1.75 rillig 7309: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7310: <dd>
1.110 hubertf 7311: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 7312: you noticed some file was not installed properly, you
7313: can repeat the installation with this target, which will
1.128 wiz 7314: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 7315: <p>This is the default value of
7316: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 7317: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 7318: package</strong></span>, where the defaults are
1.128 wiz 7319: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 7320: respectively.</p>
7321: </dd>
1.75 rillig 7322: <dt><span class="term">deinstall</span></dt>
7323: <dd>
1.136 dholland 7324: <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.88 wiz 7325: current directory, effectively de-installing the
7326: package. The following variables can be used to tune the
7327: behaviour:</p>
1.148 asau 7328: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7329: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.136 dholland 7330: <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.75 rillig 7331: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7332: <dd><p>Remove all packages that require (depend on)
7333: the given package. This can be used to remove any
7334: packages that may have been pulled in by a given
1.110 hubertf 7335: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 7336: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7337: <code class="filename">pkgsrc/x11/kde</code>, this is
7338: likely to remove whole KDE. Works by adding
1.136 dholland 7339: <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.88 wiz 7340: command line.</p></dd>
1.75 rillig 7341: </dl></div>
7342: </dd>
1.88 wiz 7343: <dt><span class="term">bin-install</span></dt>
7344: <dd><p>Install a binary package from local disk and via FTP
7345: from a list of sites (see the
7346: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 7347: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 7348: available anywhere. The arguments given to
1.110 hubertf 7349: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 7350: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7351: operation, etc.</p></dd>
1.75 rillig 7352: <dt><span class="term">update</span></dt>
7353: <dd>
1.88 wiz 7354: <p>This target causes the current package to be
7355: updated to the latest version. The package and all
7356: depending packages first get de-installed, then current
7357: versions of the corresponding packages get compiled and
7358: installed. This is similar to manually noting which
7359: packages are currently installed, then performing a
1.110 hubertf 7360: series of <span class="command"><strong>make deinstall</strong></span> and
7361: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7362: <code class="varname">UPDATE_TARGET</code> is set to) for these
7363: packages.</p>
1.128 wiz 7364: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 7365: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7366: update</strong></span> was interrupted for some reason.
7367: However, in this case, make sure you don't call
1.110 hubertf 7368: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7369: list of dependent packages in <code class="varname">WRKDIR</code>.
7370: Otherwise, you lose the ability to automatically update
7371: the current package along with the dependent packages
7372: you have installed.</p>
1.110 hubertf 7373: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7374: update</strong></span> will only work as long as the package
7375: tree remains unchanged. If the source code for one of
7376: the packages to be updated has been changed, resuming
1.110 hubertf 7377: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7378: fail!</p>
7379: <p>The following variables can be used either on the
1.110 hubertf 7380: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7381: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7382: update</strong></span>:</p>
1.148 asau 7383: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7384: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7385: <dd><p>Install target to recursively use for the
7386: updated package and the dependent packages.
7387: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 7388: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7389: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 7390: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7391: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7392: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7393: endless loop!</p></dd>
1.75 rillig 7394: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7395: <dd><p>Don't clean up after updating. Useful if
7396: you want to leave the work sources of the updated
7397: packages around for inspection or other purposes.
7398: Be sure you eventually clean up the source tree
1.128 wiz 7399: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7400: or you may run into troubles with old source code
7401: still lying around on your next
1.110 hubertf 7402: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7403: update</strong></span>.</p></dd>
1.75 rillig 7404: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7405: <dd><p>Deinstall each package before installing
7406: (making <code class="varname">DEPENDS_TARGET</code>). This
7407: may be necessary if the
1.128 wiz 7408: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7409: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7410: update</strong></span>.</p></dd>
1.75 rillig 7411: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7412: <dd><p>Allows you to disable recursion and hardcode
7413: the target for packages. The default is
1.128 wiz 7414: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7415: facilitating a recursive update of prerequisite
7416: packages. Only set
7417: <code class="varname">DEPENDS_TARGET</code> if you want to
7418: disable recursive updates. Use
7419: <code class="varname">UPDATE_TARGET</code> instead to just
7420: set a specific target for each package to be
1.110 hubertf 7421: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7422: (see above).</p></dd>
1.75 rillig 7423: </dl></div>
7424: </dd>
7425: <dt><span class="term">clean-update</span></dt>
7426: <dd>
1.88 wiz 7427: <p>Clean the source tree for all packages that would
1.110 hubertf 7428: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7429: from the current directory. This target should not be
7430: used if the current package (or any of its depending
7431: packages) have already been de-installed (e.g., after
1.110 hubertf 7432: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7433: some packages you intended to update. As a rule of
7434: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7435: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7436: and only if you have a dirty package tree (e.g., if you
7437: used <code class="varname">NOCLEAN</code>).</p>
7438: <p>If you are unsure about whether your tree is
1.110 hubertf 7439: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7440: clean</strong></span> at the top of the tree, or use the
7441: following sequence of commands from the directory of the
7442: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7443: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7444: time, otherwise you lose all the packages you wanted to
7445: update!):</p>
1.87 wiz 7446: <pre class="screen">
7447: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7448: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7449: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7450: </pre>
1.88 wiz 7451: <p>The following variables can be used either on the
1.110 hubertf 7452: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7453: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 7454: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7455: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7456: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7457: reconstruct the list of directories to update for
1.110 hubertf 7458: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7459: update</strong></span> successfully installed all
7460: packages you wanted to update. Normally, this is
1.110 hubertf 7461: done automatically on <span class="command"><strong>make
1.88 wiz 7462: update</strong></span>, but may have been suppressed by
7463: the <code class="varname">NOCLEAN</code> variable (see
7464: above).</p></dd>
1.75 rillig 7465: </dl></div>
7466: </dd>
1.88 wiz 7467: <dt><span class="term">replace</span></dt>
7468: <dd>
7469: <p>Update the installation of the current package. This
7470: differs from update in that it does not replace dependent
1.93 rillig 7471: packages. You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88 wiz 7472: target to work.</p>
7473: <p><span class="emphasis"><em>Be careful when using this
7474: target!</em></span> There are no guarantees that dependent
7475: packages will still work, in particular they will most
1.110 hubertf 7476: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7477: library package whose shared library major version changed
7478: between your installed version and the new one. For this
7479: reason, this target is not officially supported and only
7480: recommended for advanced users.</p>
7481: </dd>
1.75 rillig 7482: <dt><span class="term">info</span></dt>
1.136 dholland 7483: <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.88 wiz 7484: package. You can use this to check which version of a
7485: package is installed.</p></dd>
7486: <dt><span class="term">index</span></dt>
7487: <dd>
7488: <p>This is a top-level command, i.e. it should be used in
7489: the <code class="filename">pkgsrc</code> directory. It creates a
7490: database of all packages in the local pkgsrc tree, including
7491: dependencies, comment, maintainer, and some other useful
7492: information. Individual entries are created by running
1.110 hubertf 7493: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7494: directories. This index file is saved as
7495: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7496: verbose format by running <span class="command"><strong>make
1.88 wiz 7497: print-index</strong></span>. You can search in it with
1.110 hubertf 7498: <span class="command"><strong>make search
1.88 wiz 7499: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7500: extract a list of all packages that depend on a particular
1.110 hubertf 7501: one by running <span class="command"><strong>make show-deps
1.88 wiz 7502: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7503: <p>Running this command takes a very long time, some
7504: hours even on fast machines!</p>
7505: </dd>
1.75 rillig 7506: <dt><span class="term">readme</span></dt>
1.88 wiz 7507: <dd>
7508: <p>This target generates a
7509: <code class="filename">README.html</code> file, which can be
1.91 rillig 7510: viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.88 wiz 7511: contain references to any packages which are in the
7512: <code class="varname">PACKAGES</code> directory on the local
7513: host. The generated files can be made to refer to URLs
7514: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7515: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7516: wanted to generate <code class="filename">README.html</code>
7517: files which pointed to binary packages on the local
7518: machine, in the directory
7519: <code class="filename">/usr/packages</code>, set
7520: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7521: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7522: <code class="varname">${PACKAGES}</code> directory and its
7523: subdirectories will be searched for all the binary
7524: packages.</p>
7525: <p>The target can be run at the toplevel or in category
7526: directories, in which case it descends recursively.</p>
7527: </dd>
1.75 rillig 7528: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7529: <dd><p>This is a top-level command, run it in
7530: <code class="filename">pkgsrc</code>. Use this target to create a
7531: file <code class="filename">README-all.html</code> which contains a
7532: list of all packages currently available in the NetBSD
7533: Packages Collection, together with the category they belong
7534: to and a short description. This file is compiled from the
7535: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7536: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7537: readme</strong></span>.</p></dd>
1.75 rillig 7538: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7539: <dd><p>This is very much the same as the
1.128 wiz 7540: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7541: used when generating a pkgsrc tree to be written to a
7542: CD-ROM. This target also produces
7543: <code class="filename">README.html</code> files, and can be made
7544: to refer to URLs based on
7545: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7546: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7547: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7548: <dd><p>This target shows which distfiles and patchfiles
7549: are needed to build the package
7550: (<code class="varname">ALLFILES</code>, which contains all
7551: <code class="varname">DISTFILES</code> and
1.87 wiz 7552: <code class="varname">PATCHFILES</code>, but not
7553: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7554: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7555: <dd><p>This target shows nothing if the package is not
7556: installed. If a version of this package is installed,
7557: but is not the version provided in this version of
7558: pkgsrc, then a warning message is displayed. This target
7559: can be used to show which of your installed packages are
7560: downlevel, and so the old versions can be deleted, and
7561: the current ones added.</p></dd>
1.75 rillig 7562: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7563: <dd><p>This target shows the directory in the pkgsrc
7564: hierarchy from which the package can be built and
7565: installed. This may not be the same directory as the one
7566: from which the package was installed. This target is
7567: intended to be used by people who may wish to upgrade
7568: many packages on a single host, and can be invoked from
7569: the top-level pkgsrc Makefile by using the
1.128 wiz 7570: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7571: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7572: <dd><p>This target shows which installed packages match
7573: the current package's <code class="varname">DEPENDS</code>. Useful
7574: if out of date dependencies are causing build
7575: problems.</p></dd>
1.75 rillig 7576: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7577: <dd><p>After a package is installed, check all its
7578: binaries and (on ELF platforms) shared libraries to see
7579: if they find the shared libs they need. Run by default
1.110 hubertf 7580: if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75 rillig 7581: <dt><span class="term">print-PLIST</span></dt>
7582: <dd>
1.128 wiz 7583: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7584: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7585: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7586: -newer work/.extract_done</strong></span>. An attempt is made
7587: to care for shared libs etc., but it is
1.87 wiz 7588: <span class="emphasis"><em>strongly</em></span> recommended to review the
7589: result before putting it into
7590: <code class="filename">PLIST</code>. On upgrades, it's useful to
7591: diff the output of this command against an already
7592: existing <code class="filename">PLIST</code> file.</p>
1.136 dholland 7593: <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.88 wiz 7594: other methods that don't update file access times, be
7595: sure to add these files manually to your
1.128 wiz 7596: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7597: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7598: them!</p>
1.128 wiz 7599: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.87 wiz 7600: information on this target.</p>
1.75 rillig 7601: </dd>
7602: <dt><span class="term">bulk-package</span></dt>
7603: <dd>
1.88 wiz 7604: <p>Used to do bulk builds. If an appropriate binary
7605: package already exists, no action is taken. If not, this
7606: target will compile, install and package it (and its
7607: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110 hubertf 7608: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.88 wiz 7609: After creating the binary package, the sources, the
7610: just-installed package and its required packages are
7611: removed, preserving free disk space.</p>
7612: <p><span class="emphasis"><em>Beware that this target may deinstall
7613: all packages installed on a system!</em></span></p>
1.75 rillig 7614: </dd>
7615: <dt><span class="term">bulk-install</span></dt>
7616: <dd>
1.88 wiz 7617: <p>Used during bulk-installs to install required
7618: packages. If an up-to-date binary package is available,
1.136 dholland 7619: 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.110 hubertf 7620: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7621: but the installed binary won't be removed.</p>
1.88 wiz 7622: <p>A binary package is considered
1.128 wiz 7623: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.136 dholland 7624: <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.148 asau 7625: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7626: <li class="listitem"><p>None of the package's files
1.88 wiz 7627: (<code class="filename">Makefile</code>, ...) were modified
7628: since it was built.</p></li>
1.128 wiz 7629: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7630: packages were modified since it was built.</p></li>
1.75 rillig 7631: </ul></div>
1.88 wiz 7632: <p><span class="emphasis"><em>Beware that this target may deinstall
7633: all packages installed on a system!</em></span></p>
1.75 rillig 7634: </dd>
7635: </dl></div>
7636: </div>
7637: </div>
1.148 asau 7638: <div class="chapter">
1.75 rillig 7639: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7640: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7641: <div class="toc">
7642: <p><b>Table of Contents</b></p>
7643: <dl>
1.106 rillig 7644: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7645: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7646: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7647: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7648: </dl>
7649: </div>
1.87 wiz 7650: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7651: by pkgsrc and also for individual packages to define what commands
7652: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7653: or for later run-time of an installed packaged (such as
7654: <code class="varname">DEPENDS</code>).
7655: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7656: package will not be used.</p>
7657: <p>When building a package, the replacement tools are
1.75 rillig 7658: made available in a directory (as symlinks or wrapper scripts)
7659: that is early in the executable search path. Just like the buildlink
1.87 wiz 7660: system, this helps with consistent builds.</p>
7661: <p>A tool may be needed to help build a specific package. For example,
7662: perl, GNU make (gmake) or yacc may be needed.</p>
7663: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7664: tool may be inefficient for building a package with pkgsrc.
7665: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7666: yacc) or a better sed.</p>
7667: <p>The tools used by a package can be listed by running
1.110 hubertf 7668: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 7669: <div class="sect1">
1.75 rillig 7670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7671: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7672: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7673: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7674: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7675: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7676: These can be seen by running:
1.110 hubertf 7677: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7678: <p>If a package needs a specific program to build
1.75 rillig 7679: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7680: to define the tools needed.</p>
1.75 rillig 7681: </div>
1.148 asau 7682: <div class="sect1">
1.75 rillig 7683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7684: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 7685: <p>In the following examples, the :run means that it is needed at
7686: run-time (and becomes a DEPENDS).
1.75 rillig 7687: The default is a build dependency which can be set with
7688: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7689: and pkg-config:build.)</p>
1.75 rillig 7690: <pre class="programlisting">
7691: USE_TOOLS+= gmake perl:run pkg-config
7692: </pre>
1.87 wiz 7693: <p>When using the tools framework, a
1.75 rillig 7694: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7695: which contains the full path to the appropriate tool. For example,
1.128 wiz 7696: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7697: on Linux systems.</p>
7698: <p>If you always need a pkgsrc version of the
1.75 rillig 7699: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7700: </p>
7701: </div>
1.148 asau 7702: <div class="sect1">
1.75 rillig 7703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7704: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7705: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7706: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7707: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7708: the name of the common tools. For example:</p>
7709: <pre class="programlisting">
7710: .if exists(/usr/bin/bzcat)
7711: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7712: .elif exists(/usr/bin/bzip2)
7713: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7714: .endif
1.69 rillig 7715:
1.75 rillig 7716: TOOLS_PLATFORM.true?= true # shell builtin
7717: </pre>
7718: </div>
1.148 asau 7719: <div class="sect1">
1.97 rillig 7720: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7721: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148 asau 7722: <div class="qandaset">
1.172 ! wiz 7723: <a name="idm73532864"></a><dl>
1.106 rillig 7724: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7725: </dt>
1.106 rillig 7726: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7727: tools?</a>
7728: </dt>
1.106 rillig 7729: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7730: package is using while being built? I want to know whether it
7731: uses sed or not.</a>
7732: </dt>
7733: </dl>
1.148 asau 7734: <table border="0" style="width: 100%;">
7735: <colgroup>
1.97 rillig 7736: <col align="left" width="1%">
1.128 wiz 7737: <col>
1.148 asau 7738: </colgroup>
1.97 rillig 7739: <tbody>
1.148 asau 7740: <tr class="question">
1.97 rillig 7741: <td align="left" valign="top">
1.172 ! wiz 7742: <a name="tools.new"></a><a name="idm73532480"></a><p><b>18.4.1.</b></p>
1.97 rillig 7743: </td>
7744: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7745: </tr>
7746: <tr class="answer">
7747: <td align="left" valign="top"></td>
7748: <td align="left" valign="top"><p>TODO</p></td>
7749: </tr>
1.148 asau 7750: <tr class="question">
1.97 rillig 7751: <td align="left" valign="top">
1.172 ! wiz 7752: <a name="tools.listall"></a><a name="idm73531456"></a><p><b>18.4.2.</b></p>
1.97 rillig 7753: </td>
7754: <td align="left" valign="top"><p>How do I get a list of all available
7755: tools?</p></td>
7756: </tr>
7757: <tr class="answer">
7758: <td align="left" valign="top"></td>
7759: <td align="left" valign="top"><p>TODO</p></td>
7760: </tr>
1.148 asau 7761: <tr class="question">
1.97 rillig 7762: <td align="left" valign="top">
1.172 ! wiz 7763: <a name="tools.used"></a><a name="idm73530304"></a><p><b>18.4.3.</b></p>
1.97 rillig 7764: </td>
7765: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7766: package is using while being built? I want to know whether it
7767: uses sed or not.</p></td>
7768: </tr>
7769: <tr class="answer">
7770: <td align="left" valign="top"></td>
7771: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7772: to do it.)</p></td>
7773: </tr>
7774: </tbody>
7775: </table>
7776: </div>
7777: </div>
1.75 rillig 7778: </div>
1.148 asau 7779: <div class="chapter">
1.75 rillig 7780: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7781: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7782: <div class="toc">
7783: <p><b>Table of Contents</b></p>
7784: <dl>
1.106 rillig 7785: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7786: <dd><dl>
1.106 rillig 7787: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 7788: <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.106 rillig 7789: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7790: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7791: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7792: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7793: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7794: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7795: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7796: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7797: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7798: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7799: </dl></dd>
1.128 wiz 7800: <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.106 rillig 7801: <dd><dl>
7802: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7803: <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>
7804: </dl></dd>
1.128 wiz 7805: <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.106 rillig 7806: <dd><dl>
7807: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7808: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7809: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7810: </dl></dd>
7811: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7812: <dd><dl>
7813: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7814: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7815: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 7816: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7817: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 7818: </dl></dd>
1.128 wiz 7819: <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.106 rillig 7820: <dd><dl>
7821: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7822: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 7823: <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.106 rillig 7824: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7825: </dl></dd>
1.128 wiz 7826: <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.106 rillig 7827: <dd><dl>
7828: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7829: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7830: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7831: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7832: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7833: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7834: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7835: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7836: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7837: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7838: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7839: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7840: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7841: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7842: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7843: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7844: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7845: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7846: emulation</a></span></dt>
1.106 rillig 7847: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7848: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7849: </dl></dd>
1.106 rillig 7850: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7851: </dl>
7852: </div>
1.148 asau 7853: <div class="sect1">
1.75 rillig 7854: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7855: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.148 asau 7856: <div class="sect2">
1.75 rillig 7857: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7858: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7859: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7860: different platforms. As a result, it is important to ensure,
7861: where possible, that packages in pkgsrc are portable. This
7862: chapter mentions some particular details you should pay
7863: attention to while working on pkgsrc.</p>
1.78 rillig 7864: </div>
1.148 asau 7865: <div class="sect2">
1.78 rillig 7866: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7867: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93 rillig 7868: </h3></div></div></div>
1.78 rillig 7869: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7870: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7871: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7872: want to use those variables in the preprocessor directives of
1.136 dholland 7873: <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.87 wiz 7874: <code class="literal">.for</code>), you need to include the file
7875: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7876: loads the user preferences.</p>
1.78 rillig 7877: <p>But note that some variables may not be completely defined
1.87 wiz 7878: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7879: included, as they may contain references to variables that are
7880: not yet defined. In shell commands this is no problem, since
7881: variables are actually macros, which are only expanded when they
7882: are used. But in the preprocessor directives mentioned above and
7883: in dependency lines (of the form <code class="literal">target:
7884: dependencies</code>) the variables are expanded at load
7885: time.</p>
1.148 asau 7886: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7887: <h3 class="title">Note</h3>
7888: <p>Currently there is no exhaustive list of all
1.87 wiz 7889: variables that tells you whether they can be used at load time
7890: or only at run time, but it is in preparation.</p>
1.78 rillig 7891: </div>
7892: </div>
1.148 asau 7893: <div class="sect2">
1.78 rillig 7894: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7895: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7896: <p>Occasionally, packages require interaction from the user,
7897: and this can be in a number of ways:</p>
1.148 asau 7898: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7899: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7900: interaction such as entering username/password or accepting a
7901: license on a web page.</p></li>
1.128 wiz 7902: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7903: passwords.</p></li>
1.128 wiz 7904: <li class="listitem"><p>help to configure the package before it is built</p></li>
7905: <li class="listitem"><p>help during the build process</p></li>
7906: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7907: </ul></div>
1.88 wiz 7908: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7909: provided to notify the pkgsrc mechanism of an interactive stage
7910: which will be needed, and this should be set in the package's
7911: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7912: <pre class="programlisting">
1.100 rillig 7913: INTERACTIVE_STAGE= build
1.87 wiz 7914: </pre>
1.78 rillig 7915: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7916: <pre class="programlisting">
1.100 rillig 7917: INTERACTIVE_STAGE= configure install
1.87 wiz 7918: </pre>
1.88 wiz 7919: <p>The user can then decide to skip this package by setting the
7920: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7921: </div>
1.148 asau 7922: <div class="sect2">
1.75 rillig 7923: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7924: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7925: <p>Authors of software can choose the licence under which
7926: software can be copied. This is due to copyright law, and reasons
7927: for license choices are outside the scope of pkgsrc. The pkgsrc
7928: system recognizes that there are a number of licenses which some
7929: users may find objectionable or difficult or impossible to comply
7930: with. The Free Software Foundation has declared some licenses
7931: "Free", and the Open Source Initiative has a definition of "Open
7932: Source". The pkgsrc system, as a policy choice, does not label
7933: packages which have licenses that are Free or Open Source.
7934: However, packages without a license meeting either of those tests
7935: are labeled with a license tag denoting the license. Note that a
7936: package with no license to copy trivially does not meet either the
7937: Free or Open Source test.</p>
7938: <p>For packages which are not Free or Open Source, pkgsrc will
7939: not build the package unless the user has indicated to pkgsrc that
7940: packages with that particular license may be built. Note that
7941: this documentation avoids the term "accepted the license". The
7942: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7943: accidentally building a package with a non-free license;
1.98 wiz 7944: judgement and responsibility remain with the user. (Installation
7945: of binary packages are not currently subject to this mechanism;
7946: this is a bug.)</p>
7947: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7948: or the GPL, and not the other. The free licenses are added to the
7949: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7950: user can override the default by setting the
7951: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7952: of "+=". The licenses accepted by default are:
7953: </p>
7954: <pre class="programlisting">
1.154 rodent 7955: apache-1.1 apache-2.0
7956: arphic-public
7957: artistic artistic-2.0
7958: boost-license
7959: cc-by-sa-v3.0
1.161 ryoon 7960: cc0-1.0-universal
1.154 rodent 7961: cddl-1.0
7962: cpl-1.0
7963: epl-v1.0
7964: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7965: gnu-gpl-v1
7966: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7967: gnu-gpl-v3 gnu-lgpl-v3
7968: ibm-public-license-1.0
7969: ipafont
7970: isc
7971: lppl-1.3c
7972: lucent
7973: miros
7974: mit
7975: mpl-1.0 mpl-1.1 mpl-2.0
7976: mplusfont
7977: ofl-v1.0 ofl-v1.1
7978: original-bsd modified-bsd 2-clause-bsd
7979: php
7980: png-license
7981: postgresql-license
7982: public-domain
7983: python-software-foundation
7984: qpl-v1.0
1.158 rodent 7985: sgi-free-software-b-v2.0
1.154 rodent 7986: sleepycat-public
7987: unlicense
7988: x11
7989: zlib
7990: zpl
1.121 jnemeth 7991: </pre>
7992: <p>
7993: </p>
1.78 rillig 7994: <p>The license tag mechanism is intended to address
1.87 wiz 7995: copyright-related issues surrounding building, installing and
7996: using a package, and not to address redistribution issues (see
7997: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7998: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7999: Packages with redistribution restrictions should set these
8000: tags.</p>
1.98 wiz 8001: <p>Denoting that a package may be copied according to a
8002: particular license is done by placing the license in
1.87 wiz 8003: <code class="filename">pkgsrc/licenses</code> and setting the
8004: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 8005: license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87 wiz 8006: <pre class="programlisting">
1.100 rillig 8007: LICENSE= xv-license
1.87 wiz 8008: </pre>
8009: <p>When trying to build, the user will get a notice that the
1.98 wiz 8010: package is covered by a license which has not been placed in the
8011: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 8012: <pre class="programlisting">
1.100 rillig 8013: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8014: ===> xv-3.10anb9 has an unacceptable license: xv-license.
8015: ===> To view the license, enter "/usr/bin/make show-license".
8016: ===> To indicate acceptance, add this line to your /etc/mk.conf:
8017: ===> ACCEPTABLE_LICENSES+=xv-license
8018: *** Error code 1
1.87 wiz 8019: </pre>
1.110 hubertf 8020: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 8021: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 8022: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 8023: convey to pkgsrc that it should not in the future fail because of
8024: that license:</p>
1.78 rillig 8025: <pre class="programlisting">
1.100 rillig 8026: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 8027: </pre>
1.154 rodent 8028: <p>When adding a package with a new license, the following steps
8029: are required:</p>
8030: <div class="orderedlist"><ol class="orderedlist" type="1">
8031: <li class="listitem">
8032: <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>
8033: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8034: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
8035: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.158 rodent 8036: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154 rodent 8037: </ul></div>
8038: <p>with the proper syntax as demonstrated in those files, respectively.</p>
8039: </li>
8040: <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>
8041: </ol></div>
1.98 wiz 8042: <p>When the license changes (in a way other than formatting),
8043: please make sure that the new license has a different name (e.g.,
8044: append the version number if it exists, or the date). Just
8045: because a user told pkgsrc to build programs under a previous
8046: version of a license does not mean that pkgsrc should build
1.99 rillig 8047: programs under the new licenses. The higher-level point is that
1.98 wiz 8048: pkgsrc does not evaluate licenses for reasonableness; the only
8049: test is a mechanistic test of whether a particular text has been
8050: approved by either of two bodies.</p>
1.78 rillig 8051: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 8052: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
8053: is deprecated because it does not crisply refer to a particular
8054: license text. Another problem with such usage is that it does not
8055: enable a user to tell pkgsrc to proceed for a single package
8056: without also telling pkgsrc to proceed for all packages with that
8057: tag.</p>
1.75 rillig 8058: </div>
1.148 asau 8059: <div class="sect2">
1.75 rillig 8060: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8061: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 8062: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 8063: Because a license tag is required unless the package is Free or
8064: Open Source, all packages with restrictions should have license
8065: tags. By declaring the restrictions, package tools can
8066: automatically refrain from e.g. placing binary packages on FTP
8067: sites.</p>
8068: <p>There are four restrictions that may be encoded, which are
8069: the cross product of sources (distfiles) and binaries not being
8070: placed on FTP sites and CD-ROMs. Because this is rarely the exact
8071: language in any license, and because non-Free licenses tend to be
8072: different from each other, pkgsrc adopts a definition of FTP and
8073: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
8074: should not be made available over the Internet at no charge.
8075: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
8076: made available on some kind of media, together with other source
8077: and binary packages, and which is sold for a distribution charge.
8078: </p>
8079: <p>In order to encode these restrictions, the package system
1.87 wiz 8080: defines five make variables that can be set to note these
8081: restrictions:</p>
1.148 asau 8082: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8083: <li class="listitem">
1.75 rillig 8084: <p><code class="varname">RESTRICTED</code></p>
8085: <p>This variable should be set whenever a restriction
1.87 wiz 8086: exists (regardless of its kind). Set this variable to a
1.98 wiz 8087: string containing the reason for the restriction. It should
8088: be understood that those wanting to understand the restriction
8089: will have to read the license, and perhaps seek advice of
8090: counsel.</p>
1.75 rillig 8091: </li>
1.128 wiz 8092: <li class="listitem">
1.75 rillig 8093: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 8094: <p>Binaries may not be placed on CD-ROM containing other
8095: binary packages, for which a distribution charge may be made.
8096: In this case, set this variable to
8097: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 8098: </li>
1.128 wiz 8099: <li class="listitem">
1.75 rillig 8100: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 8101: <p>Binaries may not made available on the Internet without
8102: charge. In this case, set this variable to
8103: <code class="varname">${RESTRICTED}</code>. If this variable is set,
8104: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 8105: </li>
1.128 wiz 8106: <li class="listitem">
1.75 rillig 8107: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 8108: <p>Distfiles may not be placed on CD-ROM, together with
8109: other distfiles, for which a fee may be charged. In this
8110: case, set this variable to <code class="varname">${RESTRICTED}</code>.
8111: </p>
1.75 rillig 8112: </li>
1.128 wiz 8113: <li class="listitem">
1.75 rillig 8114: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 8115: <p>Distfiles may not made available via FTP at no charge.
8116: In this case, set this variable to
8117: <code class="varname">${RESTRICTED}</code>. If this variable is set,
8118: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 8119: </li>
8120: </ul></div>
1.139 wiz 8121: <p>Please note that packages will to be removed from pkgsrc
8122: when the distfiles are not distributable and cannot be obtained
8123: for a period of one full quarter branch. Packages with manual /
8124: interactive fetch must have a maintainer and it is his/her
8125: responsibility to ensure this.</p>
1.75 rillig 8126: </div>
1.148 asau 8127: <div class="sect2">
1.75 rillig 8128: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8129: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 8130: <p>Your package may depend on some other package being present
1.88 wiz 8131: - and there are various ways of expressing this dependency.
8132: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
8133: <code class="varname">DEPENDS</code> definitions, the
8134: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
8135: via <code class="filename">buildlink3.mk</code>, which is the preferred way
8136: to handle dependencies, and which uses the variables named above.
1.110 hubertf 8137: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 8138: <p>The basic difference between the two variables is as
1.87 wiz 8139: follows: The <code class="varname">DEPENDS</code> definition registers
8140: that pre-requisite in the binary package so it will be pulled in
8141: when the binary package is later installed, whilst the
8142: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
8143: dependency that is only needed for building the package.</p>
1.75 rillig 8144: <p>This means that if you only need a package present whilst
1.87 wiz 8145: you are building, it should be noted as a
8146: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 8147: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 8148: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 8149: <pre class="programlisting">
1.100 rillig 8150: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 8151: </pre>
1.128 wiz 8152: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 8153: may include any of the wildcard version numbers recognized by
1.136 dholland 8154: <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.128 wiz 8155: <div class="orderedlist"><ol class="orderedlist" type="1">
8156: <li class="listitem">
1.75 rillig 8157: <p>If your package needs another package's binaries or
1.160 wiz 8158: libraries to build and run, and if that package has a
1.87 wiz 8159: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 8160: <pre class="programlisting">
1.100 rillig 8161: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 8162: </pre>
1.75 rillig 8163: </li>
1.128 wiz 8164: <li class="listitem">
1.160 wiz 8165: <p>If your package needs another package's binaries or
8166: libraries only for building, and if that package has a
8167: <code class="filename">buildlink3.mk</code> file available, use it:</p>
8168: <pre class="programlisting">
8169: .include "../../graphics/jpeg/buildlink3.mk"
8170: </pre>
8171: <p>but set
8172: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
8173: to make it a build dependency only. This case is rather
8174: rare.</p>
8175: </li>
8176: <li class="listitem">
1.132 spz 8177: <p>If your package needs binaries from another package to build,
8178: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 8179: <pre class="programlisting">
1.132 spz 8180: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87 wiz 8181: </pre>
1.75 rillig 8182: </li>
1.132 spz 8183: <li class="listitem"><p>If your package needs a library with which to link and
8184: there is no <code class="filename">buildlink3.mk</code> file
8185: available, create one. Using
8186: <code class="varname">DEPENDS</code> won't be sufficient because the
8187: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 8188: <li class="listitem">
1.132 spz 8189: <p>If your package needs some executable to be able to run
8190: correctly and if there's no
8191: <code class="filename">buildlink3.mk</code> file, this is specified
8192: using the <code class="varname">DEPENDS</code> variable. The
8193: <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
8194: be able to execute the latex binary from the teTeX package
8195: when it runs, and that is specified:</p>
1.75 rillig 8196: <pre class="programlisting">
1.132 spz 8197: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 8198: </pre>
1.132 spz 8199: </li>
8200: <li class="listitem">
8201: <p>You can use wildcards in package dependencies. Note that
8202: such wildcard dependencies are retained when creating binary
8203: packages. The dependency is checked when installing the binary
8204: package and any package which matches the pattern will be
8205: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 8206: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
8207: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
8208: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
8209: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 8210: <p>Wildcards can also be used to specify that a package
1.87 wiz 8211: will only build against a certain minimum version of a
8212: pre-requisite:</p>
1.75 rillig 8213: <pre class="programlisting">
1.132 spz 8214: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.87 wiz 8215: </pre>
1.132 spz 8216: <p>This means that the package will build using version 6.0
8217: of ImageMagick or newer. Such a dependency may be warranted
8218: if, for example, the command line options of an executable
8219: have changed.</p>
8220: <p>If you need to depend on minimum versions of libraries,
8221: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 8222: <p>For security fixes, please update the package
1.110 hubertf 8223: vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, “Handling packages with security problems”</a> for more
1.87 wiz 8224: information.</p>
1.75 rillig 8225: </li>
1.165 bsiegert 8226: <li class="listitem">
8227: <p>If the package depends on either one of two (or more)
8228: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
8229: comma-separated list between curly braces.</p>
8230: <p>As an example, take a package that depends on the Perl
8231: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
8232: itself since version 5.10.0. This either/or dependency is
8233: expressed as:</p>
8234: <pre class="programlisting">
8235: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
8236: </pre>
8237: </li>
1.75 rillig 8238: </ol></div>
8239: <p>If your package needs files from another package to build,
1.87 wiz 8240: add the relevant distribution files to
8241: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 8242: automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87 wiz 8243: (It relies on the jpeg sources being present in source form
8244: during the build.)</p>
1.75 rillig 8245: </div>
1.148 asau 8246: <div class="sect2">
1.75 rillig 8247: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8248: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 8249: <p>Your package may conflict with other packages a user might
1.87 wiz 8250: already have installed on his system, e.g. if your package
1.88 wiz 8251: installs the same set of files as another package in the pkgsrc
8252: tree.</p>
1.75 rillig 8253: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 8254: space-separated list of packages (including version string) your
8255: package conflicts with.</p>
1.91 rillig 8256: <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>
8257: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.87 wiz 8258: install the same shared library, thus you set in
8259: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8260: <pre class="programlisting">
1.100 rillig 8261: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 8262: </pre>
8263: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 8264: <pre class="programlisting">
1.100 rillig 8265: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 8266: </pre>
1.75 rillig 8267: <p>Packages will automatically conflict with other packages
1.87 wiz 8268: with the name prefix and a different version
1.128 wiz 8269: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
8270: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.75 rillig 8271: </div>
1.148 asau 8272: <div class="sect2">
1.75 rillig 8273: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8274: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 8275: <p>There are several reasons why a package might be
1.88 wiz 8276: instructed to not build under certain circumstances. If the
1.87 wiz 8277: package builds and runs on most platforms, the exceptions
8278: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8279: the package builds and runs on a small handful of platforms,
8280: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8281: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8282: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8283: (OS-version-platform) that can use glob-style
8284: wildcards.</p>
1.88 wiz 8285: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8286: operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.88 wiz 8287: backwards compatible with other versions of the OS, and should be
8288: uploaded to a version specific directory on the FTP server. Mark
8289: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 8290: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 8291: the package system internals, but may be used in the
8292: future.</p>
1.75 rillig 8293: <p>If the package should be skipped (for example, because it
1.87 wiz 8294: provides functionality already provided by the system), set
1.88 wiz 8295: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8296: the package should fail because some preconditions are not met,
8297: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8298: message.</p>
1.75 rillig 8299: </div>
1.148 asau 8300: <div class="sect2">
1.75 rillig 8301: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8302: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8303: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8304: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8305: be set in the package Makefile. This will be carried into any
8306: binary package that is made from this pkgsrc entry. A
1.128 wiz 8307: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.136 dholland 8308: 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.128 wiz 8309: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 8310: </div>
1.148 asau 8311: <div class="sect2">
1.75 rillig 8312: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8313: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8314: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8315: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 8316: and after committing that file, ask pkgsrc-security@NetBSD.org to
8317: update the file on ftp.NetBSD.org.</p>
1.75 rillig 8318: <p>After fixing the vulnerability by a patch, its
1.138 wiz 8319: <code class="varname">PKGREVISION</code> should be increased (this is of
8320: course not necessary if the problem is fixed by using a newer
8321: release of the software), and the pattern in the
8322: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 8323: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8324: branch, be sure to submit a pullup request!</p>
1.75 rillig 8325: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8326: semi-automatically by a weekly cron job.</p>
1.75 rillig 8327: </div>
1.148 asau 8328: <div class="sect2">
1.75 rillig 8329: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8330: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 8331: <p>When making fixes to an existing package it can be useful
1.87 wiz 8332: to change the version number in <code class="varname">PKGNAME</code>. To
8333: avoid conflicting with future versions by the original author, a
1.128 wiz 8334: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.87 wiz 8335: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 8336: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
8337: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 8338: <pre class="programlisting">
1.100 rillig 8339: DISTNAME= foo-17.42
8340: PKGREVISION= 9
1.87 wiz 8341: </pre>
1.75 rillig 8342: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 8343: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
8344: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 8345: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8346: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8347: <p>When a new release of the package is released, the
1.87 wiz 8348: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8349: minor release of the above package, things should be like:</p>
1.75 rillig 8350: <pre class="programlisting">
1.100 rillig 8351: DISTNAME= foo-17.43
1.87 wiz 8352: </pre>
8353: <p><code class="varname">PKGREVISION</code> should be incremented for any
8354: non-trivial change in the resulting binary package. Without a
8355: <code class="varname">PKGREVISION</code> bump, someone with the previous
8356: version installed has no way of knowing that their package is out
8357: of date. Thus, changes without increasing
8358: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8359: trivial that no reasonable person would want to upgrade", and this
8360: is the rough test for when increasing
8361: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8362: changes that do not merit increasing
8363: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 8364: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8365: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 8366: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8367: or comments in Makefile.</p></li>
1.128 wiz 8368: <li class="listitem"><p>
1.100 rillig 8369: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 8370: <li class="listitem"><p>
1.100 rillig 8371: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 8372: <li class="listitem"><p>
1.100 rillig 8373: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8374: </ul></div>
1.87 wiz 8375: <p>Examples of changes that do merit an increase to
8376: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 8377: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8378: <li class="listitem"><p>
1.100 rillig 8379: Security fixes</p></li>
1.128 wiz 8380: <li class="listitem"><p>
1.100 rillig 8381: Changes or additions to a patch file</p></li>
1.128 wiz 8382: <li class="listitem"><p>
1.100 rillig 8383: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 8384: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8385: </ul></div>
1.78 rillig 8386: <p>PKGREVISION must also be incremented when dependencies have ABI
8387: changes.</p>
1.75 rillig 8388: </div>
1.148 asau 8389: <div class="sect2">
1.79 rillig 8390: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8391: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79 rillig 8392: <p>When you want to replace the same text in multiple files
1.87 wiz 8393: or when the replacement text varies, patches alone cannot help.
8394: This is where the SUBST framework comes in. It provides an
8395: easy-to-use interface for replacing text in files.
8396: Example:</p>
8397: <pre class="programlisting">
1.100 rillig 8398: SUBST_CLASSES+= fix-paths
8399: SUBST_STAGE.fix-paths= pre-configure
8400: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8401: SUBST_FILES.fix-paths= src/*.c
8402: SUBST_FILES.fix-paths+= scripts/*.sh
8403: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8404: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8405: </pre>
1.79 rillig 8406: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8407: that are used to identify the different SUBST blocks that are
8408: defined. The SUBST framework is heavily used by pkgsrc, so it is
8409: important to always use the <code class="literal">+=</code> operator with
8410: this variable. Otherwise some substitutions may be
8411: skipped.</p>
1.79 rillig 8412: <p>The remaining variables of each SUBST block are
1.87 wiz 8413: parameterized with the identifier from the first line
8414: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8415: parameters to a function call.</p>
1.79 rillig 8416: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8417: which the replacement will take place. All combinations of
8418: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8419: <code class="literal">post-</code> together with a phase name are
8420: possible, though only few are actually used. Most commonly used
8421: are <code class="literal">post-patch</code> and
8422: <code class="literal">pre-configure</code>. Of these two,
8423: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8424: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8425: have the state after applying the patches but before making any
8426: other changes. This is especially useful when you are debugging
8427: a package in order to create new patches for it. Similarly,
8428: <code class="literal">post-build</code> is preferred over
8429: <code class="literal">pre-install</code>, because the install phase should
8430: generally be kept as simple as possible. When you use
8431: <code class="literal">post-build</code>, you have the same files in the
8432: working directory that will be installed later, so you can check
8433: if the substitution has succeeded.</p>
1.79 rillig 8434: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8435: that is printed just before the substitution is done.</p>
1.79 rillig 8436: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8437: globbing patterns that specifies the files in which the
8438: substitution will take place. The patterns are interpreted
8439: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8440: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.136 dholland 8441: <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.87 wiz 8442: command should be prefixed with <code class="literal">-e</code>, so that
8443: all SUBST blocks look uniform.</p>
1.79 rillig 8444: <p>There are some more variables, but they are so seldomly
1.87 wiz 8445: used that they are only documented in the
8446: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8447: </div>
1.75 rillig 8448: </div>
1.148 asau 8449: <div class="sect1">
1.75 rillig 8450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8451: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8452: <div class="sect2">
1.75 rillig 8453: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8454: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 8455: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8456: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8457: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8458: with the name of each file to download as an argument, expecting
8459: it to output the URL of the directory from which to download
1.91 rillig 8460: it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87 wiz 8461: example of this usage.</p>
1.75 rillig 8462: <p>If the download can't be automated, because the user must
1.87 wiz 8463: submit personal information to apply for a password, or must pay
8464: for the source, or whatever, you can set
8465: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8466: displayed to the user before aborting the build. Example:</p>
8467: <pre class="programlisting">
1.100 rillig 8468: FETCH_MESSAGE= "Please download the files"
8469: FETCH_MESSAGE+= " "${DISTFILES:Q}
8470: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8471: </pre>
1.75 rillig 8472: </div>
1.148 asau 8473: <div class="sect2">
1.75 rillig 8474: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8475: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 8476: <p>Sometimes authors of a software package make some
1.87 wiz 8477: modifications after the software was released, and they put up a
8478: new distfile without changing the package's version number. If a
8479: package is already in pkgsrc at that time, the checksum will
8480: no longer match. The contents of the new distfile should be
8481: compared against the old one before changing anything, to make
8482: sure the distfile was really updated on purpose, and that
8483: no trojan horse or so crept in.
1.97 rillig 8484: Please mention that the distfiles were compared and what was found
1.159 rodent 8485: in your commit message.</p>
8486: <p>Then, the correct way to work around this is to
1.87 wiz 8487: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8488: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8489: <code class="varname">DISTFILES</code> and
1.93 rillig 8490: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8491: subdirectory of the local distfiles directory.
1.110 hubertf 8492: (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, “How to handle incrementing versions when fixing an existing package”</a> for more details.)
1.97 rillig 8493: In case this
1.87 wiz 8494: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8495: including the <code class="filename">nbX</code> suffix) or a date stamp
1.159 rodent 8496: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8497: <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>
8498: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8499: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8500: path in the filenames.
1.159 rodent 8501: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8502: Furthermore, a mail to the package's authors seems appropriate
8503: telling them that changing distfiles after releases without
8504: changing the file names is not good practice.</p>
1.75 rillig 8505: </div>
8506: </div>
1.148 asau 8507: <div class="sect1">
1.75 rillig 8508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8509: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8510: <div class="sect2">
1.75 rillig 8511: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8512: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8513: <p>pkgsrc supports many different machines, with different
1.87 wiz 8514: object formats like a.out and ELF, and varying abilities to do
8515: shared library and dynamic loading at all. To accompany this,
8516: varying commands and options have to be passed to the
8517: compiler, linker, etc. to get the Right Thing, which can be
8518: pretty annoying especially if you don't have all the machines
8519: at your hand to test things. The
1.91 rillig 8520: <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.128 wiz 8521: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8522: both static and dynamic libraries from a set of source files,
8523: thus being platform-independent.</p>
8524: <p>Here's how to use libtool in a package in seven simple
8525: steps:</p>
1.128 wiz 8526: <div class="orderedlist"><ol class="orderedlist" type="1">
8527: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8528: Makefile.</p></li>
1.128 wiz 8529: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8530: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8531: add it to the definition of <code class="varname">CC</code>, if only
8532: libraries are being built in a given Makefile. This one command
8533: will build both PIC and non-PIC library objects, so you need not
8534: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8535: <li class="listitem">
1.75 rillig 8536: <p>For the linking of the library, remove any
1.128 wiz 8537: <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
8538: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8539: <pre class="programlisting">
1.100 rillig 8540: ${LIBTOOL} --mode=link \
8541: ${CC} -o ${.TARGET:.a=.la} \
8542: ${OBJS:.o=.lo} \
8543: -rpath ${PREFIX}/lib \
8544: -version-info major:minor
1.87 wiz 8545: </pre>
1.75 rillig 8546: <p>Note that the library is changed to have a
1.87 wiz 8547: <code class="filename">.la</code> extension, and the objects are
8548: changed to have a <code class="filename">.lo</code>
8549: extension. Change <code class="varname">OBJS</code> as
8550: necessary. This automatically creates all of the
8551: <code class="filename">.a</code>,
8552: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8553: necessary) in the build directory. Be sure to include
1.128 wiz 8554: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8555: minor are zero, as libtool will otherwise strip off the
8556: shared library version.</p>
1.75 rillig 8557: <p>From the libtool manual:</p>
8558: <pre class="programlisting">
1.100 rillig 8559: So, libtool library versions are described by three integers:
1.69 rillig 8560:
1.100 rillig 8561: CURRENT
8562: The most recent interface number that this library implements.
1.69 rillig 8563:
1.100 rillig 8564: REVISION
8565: The implementation number of the CURRENT interface.
1.69 rillig 8566:
1.100 rillig 8567: AGE
8568: The difference between the newest and oldest interfaces that
8569: this library implements. In other words, the library implements
8570: all the interface numbers in the range from number `CURRENT -
8571: AGE' to `CURRENT'.
1.1 grant 8572:
1.100 rillig 8573: If two libraries have identical CURRENT and AGE numbers, then the
8574: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8575: </pre>
1.128 wiz 8576: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8577: different results for a.out and ELF (excluding symlinks)
8578: in only one case. An ELF library of the form
1.128 wiz 8579: <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.87 wiz 8580: will have a symlink of
1.128 wiz 8581: <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.87 wiz 8582: on an a.out platform. This is handled
8583: automatically.</p>
1.128 wiz 8584: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8585: directory of the library being built.</p>
1.76 rillig 8586: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8587: <code class="filename">.la</code> file, the other files will be
8588: added automatically.</p>
1.75 rillig 8589: </li>
1.128 wiz 8590: <li class="listitem">
1.76 rillig 8591: <p>When linking shared object (<code class="filename">.so</code>)
1.136 dholland 8592: 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.128 wiz 8593: shared libraries, use <span class="quote">“<span class="quote">-module
8594: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8595: tacked on.</p>
1.76 rillig 8596: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8597: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8598: </li>
1.128 wiz 8599: <li class="listitem">
1.75 rillig 8600: <p>When linking programs that depend on these libraries
1.87 wiz 8601: <span class="emphasis"><em>before</em></span> they are installed, preface
1.136 dholland 8602: 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.128 wiz 8603: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8604: libraries (static or shared), but please be aware that
8605: libtool will not allow you to specify a relative path in
1.128 wiz 8606: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8607: expects you to change that argument to be the
8608: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8609: <pre class="programlisting">
1.100 rillig 8610: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8611: </pre>
1.75 rillig 8612: <p>should be changed to:</p>
8613: <pre class="programlisting">
1.100 rillig 8614: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8615: </pre>
1.75 rillig 8616: <p>and it will do the right thing with the libraries.</p>
8617: </li>
1.128 wiz 8618: <li class="listitem">
1.136 dholland 8619: <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>
8620: 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.128 wiz 8621: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8622: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8623: <pre class="programlisting">
1.126 jakllsch 8624: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8625: </pre>
1.76 rillig 8626: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8627: shared library, any needed symlinks, and run
1.136 dholland 8628: <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.75 rillig 8629: </li>
1.128 wiz 8630: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8631: the <code class="filename">.la</code>
8632: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8633: </ol></div>
8634: </div>
1.148 asau 8635: <div class="sect2">
1.75 rillig 8636: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8637: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8638: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8639: package Makefile. This will override the package's own libtool
8640: in most cases. For older libtool using packages, libtool is
8641: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8642: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8643: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8644: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8645: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8646: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8647: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8648: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8649: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8650: libraries built and installed, then use
8651: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8652: <p>If your package makes use of the platform-independent library
1.87 wiz 8653: for loading dynamic shared objects, that comes with libtool
8654: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8655: <p>Some packages use libtool incorrectly so that the package
8656: may not work or build in some circumstances. Some of the more
8657: common errors are:</p>
1.148 asau 8658: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8659: <li class="listitem">
1.75 rillig 8660: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8661: executable or library. This in itself isn't a problem if one of two things
8662: has been done:</p>
1.128 wiz 8663: <div class="orderedlist"><ol class="orderedlist" type="1">
8664: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8665: <code class="filename">libfoo.la</code>, not
8666: <code class="filename">foo.la</code></p></li>
1.128 wiz 8667: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8668: </ol></div>
8669: </li>
1.128 wiz 8670: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8671: The function lt_dlinit() should be called and the macro
8672: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8673: executables.</p></li>
1.75 rillig 8674: </ul></div>
8675: </div>
1.148 asau 8676: <div class="sect2">
1.75 rillig 8677: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8678: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8679: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8680: to regenerate the configure script and Makefile.in makefile
8681: templates, then they should be executed in a pre-configure
8682: target.</p>
1.75 rillig 8683: <p>For packages that need only autoconf:</p>
8684: <pre class="programlisting">
1.100 rillig 8685: AUTOCONF_REQD= 2.50 # if default version is not good enough
8686: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8687: ...
1.1 grant 8688:
1.100 rillig 8689: pre-configure:
8690: cd ${WRKSRC} && autoconf
1.1 grant 8691:
1.100 rillig 8692: ...
1.87 wiz 8693: </pre>
1.75 rillig 8694: <p>and for packages that need automake and autoconf:</p>
8695: <pre class="programlisting">
1.100 rillig 8696: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8697: USE_TOOLS+= automake # use "automake14" for automake-1.4
8698: ...
8699:
8700: pre-configure:
8701: set -e; cd ${WRKSRC}; \
8702: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8703:
1.100 rillig 8704: ...
1.87 wiz 8705: </pre>
1.75 rillig 8706: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8707: require GNU Make.</p>
1.75 rillig 8708: <p>There are times when the configure process makes
1.87 wiz 8709: additional changes to the generated files, which then causes
8710: the build process to try to re-execute the automake sequence.
8711: This is prevented by touching various files in the configure
8712: stage. If this causes problems with your package you can set
8713: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8714: Makefile.</p>
1.75 rillig 8715: </div>
8716: </div>
1.148 asau 8717: <div class="sect1">
1.75 rillig 8718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8719: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148 asau 8720: <div class="sect2">
1.87 wiz 8721: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8722: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8723: <p>Compilers for the C, C++, and Fortran languages comes with
8724: the NetBSD base system. By default, pkgsrc assumes that a package
8725: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8726: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8727: <p>To declare which language's compiler a package needs, set
8728: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8729: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8730: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8731: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8732: written in C++, usually need a C compiler for the configure
8733: phase.</p>
8734: </div>
1.148 asau 8735: <div class="sect2">
1.87 wiz 8736: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8737: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8738: <p>If a program is written in Java, use the Java framework in
8739: pkgsrc. The package must include
8740: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8741: provides the following variables:</p>
1.148 asau 8742: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8743: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8744: dependency on the JDK is added. If
1.128 wiz 8745: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8746: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8747: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8748: JDK.</p></li>
1.128 wiz 8749: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8750: a package needs a Java2 implementation. The supported values
1.128 wiz 8751: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8752: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8753: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8754: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8755: above. This variable is not set by default.</p></li>
1.130 wiz 8756: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8757: automatically set to the runtime location of the used Java
8758: implementation dependency. It may be used to set
8759: <code class="varname">JAVA_HOME</code> to a good value if the program
8760: needs this variable to be defined.
8761: </p></li>
1.87 wiz 8762: </ul></div>
8763: </div>
1.148 asau 8764: <div class="sect2">
1.87 wiz 8765: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8766: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8767: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8768: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8769: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8770: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8771: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8772: that you want adjusted. Every occurrence of
8773: <code class="filename">*/bin/perl</code> will be replaced with the full
8774: path to the perl executable.</p>
8775: <p>If a particular version of perl is needed, set the
8776: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8777: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8778: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, “Packages installing perl modules”</a> for information
1.87 wiz 8779: about handling perl modules.</p>
8780: </div>
1.148 asau 8781: <div class="sect2">
1.87 wiz 8782: <div class="titlepage"><div><div><h3 class="title">
1.147 wiz 8783: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8784: <p><code class="varname">REPLACE_SH</code>,
8785: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8786: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8787: hash bangs in files. Please use the appropriate one, prefering
8788: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
8789: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8790: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8791: </div>
1.148 asau 8792: <div class="sect2">
1.147 wiz 8793: <div class="titlepage"><div><div><h3 class="title">
8794: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 8795: <p>Currently, there is no special handling for other languages
8796: in pkgsrc. If a compiler package provides a
8797: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8798: just add a (build) dependency on the appropriate compiler
8799: package.</p>
8800: </div>
8801: </div>
1.148 asau 8802: <div class="sect1">
1.87 wiz 8803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8804: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8805: <p>The most common failures when building a package are that
8806: some platforms do not provide certain header files, functions or
8807: libraries, or they provide the functions in a library that the
8808: original package author didn't know. To work around this, you
8809: can rewrite the source code in most cases so that it does not
8810: use the missing functions or provides a replacement function.</p>
1.148 asau 8811: <div class="sect2">
1.77 rillig 8812: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8813: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8814: <p>If a package already comes with a GNU configure script, the
8815: preferred way to fix the build failure is to change the
8816: configure script, not the code. In the other cases, you can
8817: utilize the C preprocessor, which defines certain macros
8818: depending on the operating system and hardware architecture it
8819: compiles for. These macros can be queried using for example
8820: <code class="varname">#if defined(__i386)</code>. Almost every operating
8821: system, hardware architecture and compiler has its own macro.
8822: For example, if the macros <code class="varname">__GNUC__</code>,
8823: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8824: are all defined, you know that you are using NetBSD on an i386
8825: compatible CPU, and your compiler is GCC.</p>
8826: <p>The list of the following macros for hardware and
8827: operating system depends on the compiler that is used. For
8828: example, if you want to conditionally compile code on Solaris,
8829: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8830: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8831: <div class="sect3">
1.75 rillig 8832: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8833: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 8834: <p>To distinguish between 4.4 BSD-derived systems and the
8835: rest of the world, you should use the following code.</p>
8836: <pre class="programlisting">
1.100 rillig 8837: #include <sys/param.h>
8838: #if (defined(BSD) && BSD >= 199306)
8839: /* BSD-specific code goes here */
8840: #else
8841: /* non-BSD-specific code goes here */
8842: #endif
1.75 rillig 8843: </pre>
1.77 rillig 8844: <p>If this distinction is not fine enough, you can also test
8845: for the following macros.</p>
1.75 rillig 8846: <pre class="programlisting">
1.151 obache 8847: Cygwin __CYGWIN__
8848: DragonFly __DragonFly__
1.100 rillig 8849: FreeBSD __FreeBSD__
1.151 obache 8850: Haiku __HAIKU__
1.100 rillig 8851: Interix __INTERIX
8852: IRIX __sgi (TODO: get a definite source for this)
8853: Linux linux, __linux, __linux__
1.151 obache 8854: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8855: Minix3 __minix
1.100 rillig 8856: NetBSD __NetBSD__
8857: OpenBSD __OpenBSD__
8858: Solaris sun, __sun
1.75 rillig 8859: </pre>
8860: </div>
1.148 asau 8861: <div class="sect3">
1.75 rillig 8862: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8863: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 8864: <pre class="programlisting">
1.100 rillig 8865: i386 i386, __i386, __i386__
8866: MIPS __mips
8867: SPARC sparc, __sparc
1.75 rillig 8868: </pre>
8869: </div>
1.148 asau 8870: <div class="sect3">
1.75 rillig 8871: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8872: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 8873: <pre class="programlisting">
1.100 rillig 8874: GCC __GNUC__ (major version), __GNUC_MINOR__
8875: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8876: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8877: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8878: </pre>
8879: </div>
8880: </div>
1.148 asau 8881: <div class="sect2">
1.78 rillig 8882: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8883: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8884: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8885: combinations of compiler version and architecture and almost
8886: always relation to optimisation being enabled. Common symptoms
8887: are gcc internal errors or never finishing compiling a
1.78 rillig 8888: file.</p>
8889: <p>Typically, a workaround involves testing the
8890: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8891: optimisation for that combination of file,
8892: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8893: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8894: number of examples.</p>
8895: </div>
1.148 asau 8896: <div class="sect2">
1.78 rillig 8897: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 8898: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8899: </h3></div></div></div>
1.92 rillig 8900: <p>This error message often means that a package did not
1.78 rillig 8901: link to a shared library it needs. The following functions are
8902: known to cause this error message over and over.</p>
8903: <div class="informaltable">
8904: <a name="undefined-reference-functions"></a><table border="1">
8905: <colgroup>
8906: <col>
8907: <col>
8908: <col>
8909: </colgroup>
8910: <thead><tr>
8911: <th>Function</th>
8912: <th>Library</th>
8913: <th>Affected platforms</th>
8914: </tr></thead>
8915: <tbody>
8916: <tr>
8917: <td>accept, bind, connect</td>
8918: <td>-lsocket</td>
8919: <td>Solaris</td>
8920: </tr>
8921: <tr>
8922: <td>crypt</td>
8923: <td>-lcrypt</td>
8924: <td>DragonFly, NetBSD</td>
8925: </tr>
8926: <tr>
8927: <td>dlopen, dlsym</td>
8928: <td>-ldl</td>
8929: <td>Linux</td>
8930: </tr>
8931: <tr>
8932: <td>gethost*</td>
8933: <td>-lnsl</td>
8934: <td>Solaris</td>
8935: </tr>
8936: <tr>
8937: <td>inet_aton</td>
8938: <td>-lresolv</td>
8939: <td>Solaris</td>
8940: </tr>
8941: <tr>
8942: <td>nanosleep, sem_*, timer_*</td>
8943: <td>-lrt</td>
8944: <td>Solaris</td>
8945: </tr>
8946: <tr>
8947: <td>openpty</td>
8948: <td>-lutil</td>
8949: <td>Linux</td>
8950: </tr>
8951: </tbody>
8952: </table>
8953: </div>
8954: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8955: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8956: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8957: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8958: bmake</strong></span>.</p>
1.148 asau 8959: <div class="sect3">
1.92 rillig 8960: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8961: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8962: <p>When you are using the SunPro compiler, there is another
8963: possibility. That compiler cannot handle the following code:</p>
8964: <pre class="programlisting">
1.100 rillig 8965: extern int extern_func(int);
1.93 rillig 8966:
1.100 rillig 8967: static inline int
8968: inline_func(int x)
8969: {
1.92 rillig 8970: return extern_func(x);
1.100 rillig 8971: }
1.93 rillig 8972:
1.100 rillig 8973: int main(void)
8974: {
1.92 rillig 8975: return 0;
1.100 rillig 8976: }
1.92 rillig 8977: </pre>
8978: <p>It generates the code for <code class="function">inline_func</code> even if
8979: that function is never used. This code then refers to
8980: <code class="function">extern_func</code>, which can usually not be resolved. To
8981: solve this problem you can try to tell the package to disable inlining
8982: of functions.</p>
8983: </div>
1.87 wiz 8984: </div>
1.148 asau 8985: <div class="sect2">
1.87 wiz 8986: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8987: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8988: <p>Sometimes packages fail to build because the compiler runs
8989: into an operating system specific soft limit. With the
8990: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8991: to unlimit the resources. Currently, the allowed values are
1.128 wiz 8992: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8993: Setting this variable is similar to running the shell builtin
1.110 hubertf 8994: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8995: segment size or maximum stack size of a process, respectively, to
8996: their hard limits.</p>
1.78 rillig 8997: </div>
1.75 rillig 8998: </div>
1.148 asau 8999: <div class="sect1">
1.75 rillig 9000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9001: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 9002: <div class="sect2">
1.75 rillig 9003: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9004: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 9005: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 9006: with some operating systems cannot create more than one
9007: directory at a time. As such, you should call
9008: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9009: <pre class="programlisting">
1.100 rillig 9010: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9011: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 9012: </pre>
1.128 wiz 9013: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
9014: dir2</code></span>”</span> to the
1.87 wiz 9015: <code class="varname">INSTALLATION_DIRS</code> variable, which will
9016: automatically do the right thing.</p>
1.75 rillig 9017: </div>
1.148 asau 9018: <div class="sect2">
1.75 rillig 9019: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9020: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 9021: <p>In general, documentation should be installed into
1.87 wiz 9022: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9023: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
9024: includes the version number of the package).</p>
1.84 wiz 9025: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 9026: directory where HTML documentation is installed with the
1.128 wiz 9027: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 9028: is needed because otherwise the documentation ends up in
9029: <code class="filename">${PREFIX}/share/doc/html</code> or other
9030: places.</p>
9031: <p>An exception to the above is that library API documentation
1.91 rillig 9032: generated with the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87 wiz 9033: browsers (devhelp) should be left at their default location, which
9034: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9035: documentation can be recognized from files ending in
9036: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9037: (It is also acceptable to install such files in
9038: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9039: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9040: <code class="filename">.devhelp*</code> file must be directly in that
9041: directory then, no additional subdirectory level is allowed in
9042: this case. This is usually achieved by using
1.128 wiz 9043: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 9044: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9045: though.)</p>
1.75 rillig 9046: </div>
1.148 asau 9047: <div class="sect2">
1.75 rillig 9048: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9049: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 9050: <p>Certain packages, most of them in the games category, install
1.87 wiz 9051: a score file that allows all users on the system to record their
9052: highscores. In order for this to work, the binaries need to be
9053: installed setgid and the score files owned by the appropriate
1.142 wiz 9054: group and/or owner (traditionally the "games" user/group). Set
9055: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 9056: following variables, documented in more detail in
9057: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 9058: behaviour: <code class="varname">GAMEDATAMODE</code>,
9059: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
9060: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.114 jmcneill 9061: <p>A package should therefore never hard code file ownership or
1.87 wiz 9062: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
9063: <code class="varname">INSTALL_GAME_DATA</code> to set these
9064: correctly.</p>
1.75 rillig 9065: </div>
1.148 asau 9066: <div class="sect2">
1.75 rillig 9067: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9068: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 9069: <p><code class="varname">DESTDIR</code> support means that a package
9070: installs into a staging directory, not the final location of the
9071: files. Then a binary package is created which can be used for
9072: installation as usual. There are two ways: Either the package must
1.128 wiz 9073: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9074: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 9075: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9076: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145 wiz 9077: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
9078: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
9079: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9080: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 9081: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9082: the inclusion.</p></li>
1.128 wiz 9083: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 9084: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 9085: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 9086: automatically. Many manual rules and pre/post-install often are
9087: incorrect; fix them.</p></li>
1.128 wiz 9088: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 9089: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 9090: <li class="listitem"><p>In general, packages should support
1.103 wiz 9091: <code class="varname">UNPRIVILEGED</code> to be able to use
9092: DESTDIR.</p></li>
9093: </ul></div>
9094: </div>
1.148 asau 9095: <div class="sect2">
1.103 wiz 9096: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9097: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 9098: <p>Your package may also contain scripts with hardcoded paths to
9099: other interpreters besides (or as well as) perl. To correct the
9100: full pathname to the script interpreter, you need to set the
9101: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 9102: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 9103: <pre class="programlisting">
1.100 rillig 9104: REPLACE_INTERPRETER+= tcl
9105: REPLACE.tcl.old= .*/bin/tclsh
9106: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9107: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9108: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 9109: </pre>
1.148 asau 9110: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9111: <h3 class="title">Note</h3>
9112: <p>Before March 2006, these variables were called
1.87 wiz 9113: <code class="varname">_REPLACE.*</code> and
9114: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 9115: </div>
9116: </div>
1.148 asau 9117: <div class="sect2">
1.75 rillig 9118: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9119: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 9120: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 9121: the Makefile fragment
9122: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 9123: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 9124: configuration for such modules as well as various hooks to tune
9125: this configuration. See comments in this file for
9126: details.</p>
1.75 rillig 9127: <p>Perl5 modules will install into different places depending
1.87 wiz 9128: on the version of perl used during the build process. To
9129: address this, pkgsrc will append lines to the
9130: <code class="filename">PLIST</code> corresponding to the files listed in
9131: the installed <code class="filename">.packlist</code> file generated by
9132: most perl5 modules. This is invoked by defining
9133: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 9134: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9135: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9136: e.g.:</p>
1.75 rillig 9137: <pre class="programlisting">
1.153 wiz 9138: PERL5_PACKLIST= auto/Pg/.packlist
1.87 wiz 9139: </pre>
1.153 wiz 9140: <p>The perl5 config variables
9141: <code class="varname">installarchlib</code>,
9142: <code class="varname">installscript</code>,
9143: <code class="varname">installvendorbin</code>,
9144: <code class="varname">installvendorscript</code>,
9145: <code class="varname">installvendorarch</code>,
9146: <code class="varname">installvendorlib</code>,
9147: <code class="varname">installvendorman1dir</code>, and
9148: <code class="varname">installvendorman3dir</code> represent those
9149: locations in which components of perl5 modules may be installed,
9150: provided as variable with uppercase and prefixed with
9151: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9152: and may be used by perl5 packages that don't have a packlist.
9153: These variables are also substituted for in the
9154: <code class="filename">PLIST</code> as uppercase prefixed with
9155: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 9156: </div>
1.148 asau 9157: <div class="sect2">
1.75 rillig 9158: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9159: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 9160: <p>Some packages install info files or use the
1.128 wiz 9161: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 9162: commands. <code class="varname">INFO_FILES</code> should be defined in
9163: the package Makefile so that <code class="filename">INSTALL</code> and
9164: <code class="filename">DEINSTALL</code> scripts will be generated to
9165: handle registration of the info files in the Info directory
1.128 wiz 9166: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 9167: files registration is either provided by the system, or by a
9168: special purpose package automatically added as dependency if
9169: needed.</p>
1.75 rillig 9170: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 9171: <code class="filename">${PREFIX}</code> where info files are primarily
9172: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 9173: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 9174: <p>The info files for the package should be listed in the
1.87 wiz 9175: package <code class="filename">PLIST</code>; however any split info files
9176: need not be listed.</p>
1.128 wiz 9177: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9178: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 9179: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 9180: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 9181: should be noted with the <code class="varname">TEXINFO_REQD</code>
9182: variable in the package <code class="filename">Makefile</code>. By
9183: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 9184: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 9185: does not match the required minimum, a build dependency on the
1.91 rillig 9186: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87 wiz 9187: be added automatically.</p>
1.75 rillig 9188: <p>The build and installation process of the software provided
1.87 wiz 9189: by the package should not use the
1.110 hubertf 9190: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 9191: info files is the task of the package
9192: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 9193: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 9194: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 9195: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9196: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 9197: in <code class="varname">PATH</code>.</p>
1.110 hubertf 9198: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 9199: no effect except the logging of a message. The script overriding
1.110 hubertf 9200: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 9201: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 9202: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 9203: </div>
1.148 asau 9204: <div class="sect2">
1.75 rillig 9205: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9206: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 9207: <p>All packages that install manual pages should install them
1.87 wiz 9208: into the same directory, so that there is one common place to look
9209: for them. In pkgsrc, this place is
9210: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9211: should be used in packages. The default for
9212: <code class="varname">PKGMANDIR</code> is
1.128 wiz 9213: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9214: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 9215: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9216: <h3 class="title">Note</h3>
1.87 wiz 9217: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9218: is far from complete.</p>
1.75 rillig 9219: </div>
1.81 rillig 9220: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 9221: <code class="filename">man/</code> as the top level directory for the man
9222: page file entries, and the pkgsrc framework will convert as
9223: needed. In all other places, the correct
9224: <code class="varname">PKGMANDIR</code> must be used.</p>
9225: <p>Packages that are
9226: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 9227: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 9228: <code class="filename">./configure</code>
9229: --mandir switch to set where the man pages should be installed.
9230: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9231: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9232: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9233: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 9234: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 9235: Or if the <code class="filename">./configure</code> script uses
9236: a non-standard use of --mandir, you can set
9237: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 9238: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.87 wiz 9239: information on installation of compressed manual pages.</p>
1.75 rillig 9240: </div>
1.148 asau 9241: <div class="sect2">
1.75 rillig 9242: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 9243: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 9244: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 9245: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 9246: you need to take some extra steps to make sure they get registered
9247: in the database:</p>
1.128 wiz 9248: <div class="orderedlist"><ol class="orderedlist" type="1">
9249: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 9250: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 9251: takes care of rebuilding the GConf database at installation and
1.87 wiz 9252: deinstallation time, and tells the package where to install
1.107 rillig 9253: GConf data files using some standard configure arguments. It
1.87 wiz 9254: also disallows any access to the database directly from the
9255: package.</p></li>
1.128 wiz 9256: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 9257: <code class="filename">.schemas</code> files under
9258: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9259: installed under <code class="filename">${PREFIX}/etc</code>, you will
9260: need to manually patch the package.</p></li>
1.128 wiz 9261: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 9262: directory, as they will be handled automatically. See
1.110 hubertf 9263: <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.128 wiz 9264: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 9265: your <code class="filename">Makefile</code> with a list of all
9266: <code class="filename">.schemas</code> files installed by the package, if
9267: any. Names must not contain any directories in them.</p></li>
1.128 wiz 9268: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 9269: your <code class="filename">Makefile</code> with a
9270: list of all <code class="filename">.entries</code> files installed by the
9271: package, if any. Names must not contain any directories in
9272: them.</p></li>
1.75 rillig 9273: </ol></div>
9274: </div>
1.148 asau 9275: <div class="sect2">
1.75 rillig 9276: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 9277: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 9278: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 9279: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 9280: get registered in the database:</p>
1.128 wiz 9281: <div class="orderedlist"><ol class="orderedlist" type="1">
9282: <li class="listitem"><p>Include
1.119 mishka 9283: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9284: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 9285: takes care of rebuilding the scrollkeeper database at
9286: installation and deinstallation time, and disallows any access
9287: to it directly from the package.</p></li>
1.128 wiz 9288: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9289: <code class="filename">libdata/scrollkeeper</code> directory, as they
9290: will be handled automatically.</p></li>
1.128 wiz 9291: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 9292: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9293: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 9294: </ol></div>
9295: </div>
1.148 asau 9296: <div class="sect2">
1.75 rillig 9297: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9298: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9299: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9300: the fonts database in the directory where they get installed at
9301: installation and deinstallation time. This can be automatically
9302: done by using the pkginstall framework.</p>
1.75 rillig 9303: <p>You can list the directories where fonts are installed in the
1.87 wiz 9304: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9305: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9306: <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.87 wiz 9307: Also make sure that the database file
9308: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9309: <p>Note that you should not create new directories for fonts;
1.87 wiz 9310: instead use the standard ones to avoid that the user needs to
9311: manually configure his X server to find them.</p>
1.75 rillig 9312: </div>
1.148 asau 9313: <div class="sect2">
1.75 rillig 9314: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9315: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9316: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9317: take some extra steps to get them registered in the GTK2 database
9318: properly:</p>
1.128 wiz 9319: <div class="orderedlist"><ol class="orderedlist" type="1">
9320: <li class="listitem"><p>Include
1.87 wiz 9321: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9322: <code class="filename">buildlink3.mk</code> file. This takes care of
9323: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 9324: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 9325: your package installs GTK2 immodules.</p></li>
1.128 wiz 9326: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 9327: GTK2 loaders.</p></li>
1.128 wiz 9328: <li class="listitem">
1.87 wiz 9329: <p>Patch the package to not touch any of the GTK2
9330: databases directly. These are:</p>
1.148 asau 9331: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9332: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9333: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9334: </ul></div>
9335: </li>
1.128 wiz 9336: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 9337: any entries under the <code class="filename">libdata/gtk-2.0</code>
9338: directory, as they will be handled automatically.</p></li>
1.75 rillig 9339: </ol></div>
9340: </div>
1.148 asau 9341: <div class="sect2">
1.75 rillig 9342: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9343: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9344: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9345: registered in system-wide catalogs (like DTDs, sub-catalogs,
9346: etc.), you need to take some extra steps:</p>
1.128 wiz 9347: <div class="orderedlist"><ol class="orderedlist" type="1">
9348: <li class="listitem"><p>Include
1.87 wiz 9349: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9350: your <code class="filename">Makefile</code>, which takes care of
9351: registering those files in system-wide catalogs at
9352: installation and deinstallation time.</p></li>
1.128 wiz 9353: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9354: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9355: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9356: any XML catalogs installed by the package.</p></li>
1.128 wiz 9357: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9358: to be added to the SGML catalog. These come in groups of
9359: three strings; see xmlcatmgr(1) for more information
9360: (specifically, arguments recognized by the 'add' action).
9361: Note that you will normally not use this variable.</p></li>
1.128 wiz 9362: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9363: to be added to the XML catalog. These come in groups of three
9364: strings; see xmlcatmgr(1) for more information (specifically,
9365: arguments recognized by the 'add' action). Note that you will
9366: normally not use this variable.</p></li>
1.75 rillig 9367: </ol></div>
9368: </div>
1.148 asau 9369: <div class="sect2">
1.75 rillig 9370: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9371: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9372: <p>If a package provides extensions to the MIME database by
1.87 wiz 9373: installing <code class="filename">.xml</code> files inside
9374: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9375: need to take some extra steps to ensure that the database is kept
9376: consistent with respect to these new files:</p>
1.128 wiz 9377: <div class="orderedlist"><ol class="orderedlist" type="1">
9378: <li class="listitem"><p>Include
1.87 wiz 9379: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9380: (avoid using the <code class="filename">buildlink3.mk</code> file from
9381: this same directory, which is reserved for inclusion from
9382: other <code class="filename">buildlink3.mk</code> files). It takes
9383: care of rebuilding the MIME database at installation and
9384: deinstallation time, and disallows any access to it directly
9385: from the package.</p></li>
1.128 wiz 9386: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9387: <code class="filename">share/mime</code> directory,
9388: <span class="emphasis"><em>except</em></span> for files saved under
9389: <code class="filename">share/mime/packages</code>. The former are
9390: handled automatically by
9391: the update-mime-database program, but the latter are
9392: package-dependent and must be removed by the package that
9393: installed them in the first place.</p></li>
1.128 wiz 9394: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9395: from the PLIST. They will be handled by the shared-mime-info
9396: package.</p></li>
1.75 rillig 9397: </ol></div>
9398: </div>
1.148 asau 9399: <div class="sect2">
1.75 rillig 9400: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9401: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9402: <p>If a package uses intltool during its build, add
9403: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9404: which forces it to use the intltool package provided by pkgsrc,
9405: instead of the one bundled with the distribution file.</p>
1.75 rillig 9406: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9407: latest available version; this way, the package benefits of any
9408: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9409: </div>
1.148 asau 9410: <div class="sect2">
1.75 rillig 9411: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9412: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9413: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9414: the startup directory by default, but you can enable it, by adding
9415: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9416: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9417: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9418: it will automatically remove the scripts when the package is
9419: deinstalled.</p>
1.75 rillig 9420: </div>
1.148 asau 9421: <div class="sect2">
1.75 rillig 9422: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9423: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9424: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9425: the <code class="filename">ls-R</code> database of the tree needs to be
9426: updated.</p>
1.148 asau 9427: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9428: <h3 class="title">Note</h3>
1.125 wiz 9429: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9430: packages should install files
1.125 wiz 9431: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9432: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9433: </div>
1.128 wiz 9434: <div class="orderedlist"><ol class="orderedlist" type="1">
9435: <li class="listitem"><p>Include
1.125 wiz 9436: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9437: takes care of rebuilding the <code class="filename">ls-R</code>
9438: database at installation and deinstallation time.</p></li>
1.128 wiz 9439: <li class="listitem">
1.75 rillig 9440: <p>If your package installs files into a texmf
1.87 wiz 9441: tree other than the one
1.125 wiz 9442: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9443: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9444: trees that need database update.</p>
1.75 rillig 9445: <p>If your package also installs font map files that need
1.110 hubertf 9446: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9447: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9448: set <code class="varname">TEX_MAP_FILES</code> and/or
9449: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9450: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9451: be run automatically at installation/deinstallation to
9452: enable/disable font map files for TeX output
9453: drivers.</p>
1.75 rillig 9454: </li>
1.128 wiz 9455: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9456: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9457: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9458: </ol></div>
9459: </div>
1.148 asau 9460: <div class="sect2">
1.85 jmmv 9461: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9462: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9463: emulation</h3></div></div></div>
9464: <p>There are some packages that provide libraries and
9465: executables for running binaries from a one operating system
9466: on a different one (if the latter supports it). One example
9467: is running Linux binaries on NetBSD.</p>
1.91 rillig 9468: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87 wiz 9469: helps in extracting and packaging Linux rpm packages.</p>
9470: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9471: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9472: if all libraries for each installed executable can be found by
9473: the dynamic linker. Since the standard dynamic linker is run,
9474: this fails for emulation packages, because the libraries used
9475: by the emulation are not in the standard directories.</p>
9476: </div>
1.148 asau 9477: <div class="sect2">
1.87 wiz 9478: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9479: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9480: <p>If a package installs images under the
1.87 wiz 9481: <code class="filename">share/icons/hicolor</code> and/or updates the
9482: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9483: database, you need to take some extra steps to make sure that the
9484: shared theme directory is handled appropriately and that the cache
9485: database is rebuilt:</p>
1.128 wiz 9486: <div class="orderedlist"><ol class="orderedlist" type="1">
9487: <li class="listitem"><p>Include
1.87 wiz 9488: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 9489: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9490: entry that refers to the theme cache.</p></li>
1.128 wiz 9491: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9492: directories from the <code class="filename">share/icons/hicolor</code>
9493: hierarchy because they will be handled automatically.</p></li>
9494: </ol></div>
9495: <p>The best way to verify that the PLIST is correct with
9496: respect to the last two points is to regenerate it using
1.110 hubertf 9497: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9498: </div>
1.148 asau 9499: <div class="sect2">
1.85 jmmv 9500: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9501: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9502: <p>If a package installs <code class="filename">.desktop</code> files
9503: under <code class="filename">share/applications</code> and these include
1.159 rodent 9504: MIME information (MimeType key), you need to take extra steps to
9505: ensure that they are registered into the MIME database:</p>
1.128 wiz 9506: <div class="orderedlist"><ol class="orderedlist" type="1">
9507: <li class="listitem"><p>Include
1.85 jmmv 9508: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 9509: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9510: <code class="filename">share/applications/mimeinfo.cache</code> file.
9511: It will be handled automatically.</p></li>
9512: </ol></div>
9513: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9514: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9515: print-PLIST</strong></span>.</p>
1.75 rillig 9516: </div>
9517: </div>
1.148 asau 9518: <div class="sect1">
1.87 wiz 9519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9520: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9521: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9522: immediately. In this case, one can plainly mark a package as broken. For
9523: this, one just sets the variable <code class="varname">BROKEN</code> to the
9524: reason why the package is broken (similar to the
9525: <code class="varname">RESTRICTED</code> variable). A user trying to build
9526: the package will immediately be shown this message, and the build
9527: will not be even tried.</p>
9528: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9529: intervals.</p>
9530: </div>
1.75 rillig 9531: </div>
1.148 asau 9532: <div class="chapter">
1.75 rillig 9533: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9534: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9535: <p>To check out all the gotchas when building a package, here are
9536: the steps that I do in order to get a package working. Please note
9537: this is basically the same as what was explained in the previous
9538: sections, only with some debugging aids.</p>
1.148 asau 9539: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9540: <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>
9541: <li class="listitem">
1.91 rillig 9542: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88 wiz 9543: create a directory for a new package, change into it, then run
1.110 hubertf 9544: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9545: <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>
9546: <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>
9547: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9548: </li>
1.128 wiz 9549: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9550: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9551: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9552: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9553: configure step to the package's
9554: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 9555: <li class="listitem">
1.75 rillig 9556: <p>Make the package compile, doing multiple rounds of</p>
9557: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9558: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9559: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9560: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9561: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9562: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9563: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9564: <p>Doing this step as non-root user will ensure that no files
9565: are modified that shouldn't be, especially during the build
1.110 hubertf 9566: phase. <span class="command"><strong>mkpatches</strong></span>,
9567: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91 rillig 9568: from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88 wiz 9569: package.</p>
1.75 rillig 9570: </li>
1.128 wiz 9571: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9572: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9573: <li class="listitem">
1.76 rillig 9574: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9575: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9576: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9577: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9578: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9579: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9580: <p>You usually need to be <code class="username">root</code> to do
9581: this. Look if there are any files left:</p>
1.75 rillig 9582: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9583: <p>If this reveals any files that are missing in
1.88 wiz 9584: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9585: </li>
1.128 wiz 9586: <li class="listitem">
1.88 wiz 9587: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9588: package again and make a binary package:</p>
1.75 rillig 9589: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9590: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9591: </li>
1.128 wiz 9592: <li class="listitem">
1.75 rillig 9593: <p>Delete the installed package:</p>
1.88 wiz 9594: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75 rillig 9595: </li>
1.128 wiz 9596: <li class="listitem">
1.110 hubertf 9597: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9598: command, which shouldn't find anything now:</p>
1.75 rillig 9599: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9600: </li>
1.128 wiz 9601: <li class="listitem">
1.75 rillig 9602: <p>Reinstall the binary package:</p>
1.93 rillig 9603: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75 rillig 9604: </li>
1.128 wiz 9605: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9606: <li class="listitem">
1.110 hubertf 9607: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88 wiz 9608: reports:</p>
1.75 rillig 9609: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9610: </li>
1.128 wiz 9611: <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.75 rillig 9612: </ul></div>
9613: </div>
1.148 asau 9614: <div class="chapter">
1.75 rillig 9615: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9616: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9617: <div class="toc">
9618: <p><b>Table of Contents</b></p>
9619: <dl>
1.106 rillig 9620: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9621: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9622: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140 wiz 9623: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 9624: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9625: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9626: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9627: </dl>
9628: </div>
1.148 asau 9629: <div class="sect1">
1.75 rillig 9630: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9631: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9632: <p>Our policy is that we accept binaries only from pkgsrc
9633: developers to guarantee that the packages don't contain any
9634: trojan horses etc. This is not to annoy anyone but rather to
9635: protect our users! You're still free to put up your home-made
9636: binary packages and tell the world where to get them. NetBSD
9637: developers doing bulk builds and wanting to upload them please
1.110 hubertf 9638: see <a class="xref" href="#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, “Uploading results of a bulk build”</a>.</p>
1.75 rillig 9639: </div>
1.148 asau 9640: <div class="sect1">
1.75 rillig 9641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9642: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9643: <p>First, check that your package is complete, compiles and
1.110 hubertf 9644: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.136 dholland 9645: 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.82 rillig 9646: archive that contains all files that make up the package.
1.87 wiz 9647: Finally, send this package to the pkgsrc bug tracking system,
1.136 dholland 9648: 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.87 wiz 9649: that, go to the web page
1.110 hubertf 9650: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124 snj 9651: which contains some instructions and a link to a form where you
9652: can submit packages. The
9653: <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
9654: also available as a substitute for either of the above two tools.
9655: </p>
1.87 wiz 9656: <p>In the form of the problem report, the category should be
1.128 wiz 9657: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9658: and version number, and the description field should contain a
9659: short description of your package (contents of the COMMENT
9660: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9661: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9662: <p>If you want to submit several packages, please send a
9663: separate PR for each one, it's easier for us to track things
9664: that way.</p>
9665: <p>Alternatively, you can also import new packages into
1.128 wiz 9666: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9667: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9668: for details.</p>
9669: </div>
1.148 asau 9670: <div class="sect1">
1.75 rillig 9671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9672: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9673: <p>Please note all package additions, updates, moves, and
1.93 rillig 9674: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9675: important to keep this file up to date and conforming to the
9676: existing format, because it will be used by scripts to
1.110 hubertf 9677: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9678: sites. Additionally, check the
1.76 rillig 9679: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9680: for the package you updated or removed, in case it was mentioned
9681: there.</p>
9682: <p>When the <code class="varname">PKGREVISION</code> of a package is
9683: bumped, the change should appear in
1.93 rillig 9684: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9685: related or otherwise relevant. Mass bumps that result from a
9686: dependency being updated should not be mentioned. In all other
9687: cases it's the developer's decision.</p>
9688: <p>There is a make target that helps in creating proper
1.110 hubertf 9689: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9690: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9691: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9692: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9693: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9694: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9695: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9696: For new packages, or package moves or removals, set the
9697: <code class="varname">CTYPE</code> variable on the command line to "Added",
9698: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9699: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9700: not the same as your NetBSD login name. The target also automatically
9701: removes possibly existing entries for the package in the
9702: <code class="filename">TODO</code> file. Don't forget to commit
9703: the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
1.126 jakllsch 9704: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9705: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9706: makes the cvs commands use the main repository.
9707: </p>
1.75 rillig 9708: </div>
1.148 asau 9709: <div class="sect1">
1.75 rillig 9710: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140 wiz 9711: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9712: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9713: access to the pkgsrc repository.</p>
9714: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9715: Start by adding the directory and then files in the directory. Don't
9716: forget to add the new package to the category's
9717: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9718: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9719: <pre class="programlisting">
9720: <code class="prompt">$</code> cd .../pkgsrc/category
9721: <code class="prompt">$</code> cvs add pkgname
9722: <code class="prompt">$</code> cd pkgname
9723: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9724: <code class="prompt">$</code> cvs add patches/p*
9725: <code class="prompt">$</code> cvs status | less
1.141 wiz 9726: <code class="prompt">$</code> cvs commit
1.140 wiz 9727: <code class="prompt">$</code> cd ..
9728: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9729: <code class="prompt">$</code> cvs commit Makefile
1.140 wiz 9730: </pre>
1.87 wiz 9731: <p>The commit message of the initial import should include part of the
1.76 rillig 9732: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9733: what the package is/does.</p>
1.140 wiz 9734: <p>Also mention the new package in
9735: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9736: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9737: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9738: </div>
1.148 asau 9739: <div class="sect1">
1.75 rillig 9740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9741: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9742: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9743: changes between old and new versions into the commit log when updating
1.87 wiz 9744: a package. There are various reasons for this:</p>
1.148 asau 9745: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9746: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9747: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9748: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9749: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9750: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9751: repository is very useful for people who read the pkgsrc-changes mailing
9752: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9753: the package.</p></li>
1.75 rillig 9754: </ul></div>
1.87 wiz 9755: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9756: has been released, it should not automatically be upgraded in the CVS
9757: repository. We prefer to be conservative in the packages that are
9758: included in pkgsrc - development or beta packages are not really the
9759: best thing for most places in which pkgsrc is used. Please use your
9760: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9761: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9762: </div>
1.148 asau 9763: <div class="sect1">
1.75 rillig 9764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9765: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9766: <p>Renaming packages is not recommended.</p>
9767: <p>When renaming packages, be sure to fix any references to old name
9768: in other Makefiles, options, buildlink files, etc.</p>
9769: <p>Also When renaming a package, please define
9770: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9771: pattern(s) of the previous package name.
9772: This may be repeated for multiple renames.
9773: The new package would be an exact replacement.
9774: </p>
1.128 wiz 9775: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9776: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9777: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9778: not be an exact replacement but is a suggestion for the replaced
9779: functionality.</p>
9780: </div>
1.148 asau 9781: <div class="sect1">
1.122 reed 9782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9783: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9784: <p>It is preferred that packages are not renamed or moved, but if needed
9785: please follow these steps.
9786: </p>
1.128 wiz 9787: <div class="orderedlist"><ol class="orderedlist" type="1">
9788: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9789: <li class="listitem">
1.75 rillig 9790: <p>Remove all CVS dirs.</p>
1.87 wiz 9791: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9792: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87 wiz 9793: <p>and use that for further work.</p>
1.75 rillig 9794: </li>
1.128 wiz 9795: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9796: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9797: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9798: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9799: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9800: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9801: for doing an update using pkgsrc building; for example, it can
1.136 dholland 9802: 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.122 reed 9803: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9804: new <code class="varname">PKGPATH</code> for that moved package. Note that
9805: it may have multiple matches, so the tool should also check on the
9806: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9807: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9808: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9809: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9810: place.</p></li>
1.128 wiz 9811: <li class="listitem">
1.75 rillig 9812: <p>Check if any package depends on it:
9813: </p>
9814: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9815: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9816: </li>
1.128 wiz 9817: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9818: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9819: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9820: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9821: <li class="listitem">
1.75 rillig 9822: <p>Commit the changed and removed files:</p>
9823: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87 wiz 9824: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9825: </li>
9826: </ol></div>
9827: </div>
9828: </div>
1.148 asau 9829: <div class="chapter">
1.75 rillig 9830: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9831: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9832: <p>This section contains the answers to questions that may
9833: arise when you are writing a package. If you don't find your
9834: question answered here, first have a look in the other chapters,
9835: and if you still don't have the answer, ask on the
9836: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9837: <div class="qandaset">
1.172 ! wiz 9838: <a name="idm72967616"></a><dl>
1.106 rillig 9839: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9840: MAKEFLAGS, .MAKEFLAGS and
9841: MAKE_FLAGS?</a>
9842: </dt>
1.106 rillig 9843: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9844: MAKE, GMAKE and
9845: MAKE_PROGRAM?</a>
9846: </dt>
1.106 rillig 9847: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9848: CC, PKG_CC and
9849: PKGSRC_COMPILER?</a>
9850: </dt>
1.106 rillig 9851: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9852: BUILDLINK_LDFLAGS,
9853: BUILDLINK_LDADD and
9854: BUILDLINK_LIBS?</a>
9855: </dt>
1.106 rillig 9856: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9857: VARNAME=BUILDLINK_PREFIX.foo
9858: say it's empty?</a>
9859: </dt>
1.106 rillig 9860: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9861: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9862: don't understand the := inside
9863: it.</a>
9864: </dt>
1.106 rillig 9865: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9866: developers?</a>
9867: </dt>
1.106 rillig 9868: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9869: documentation?</a>
9870: </dt>
1.106 rillig 9871: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9872: do?</a>
9873: </dt>
1.75 rillig 9874: </dl>
1.148 asau 9875: <table border="0" style="width: 100%;">
9876: <colgroup>
1.75 rillig 9877: <col align="left" width="1%">
1.128 wiz 9878: <col>
1.148 asau 9879: </colgroup>
1.75 rillig 9880: <tbody>
1.148 asau 9881: <tr class="question">
1.75 rillig 9882: <td align="left" valign="top">
1.172 ! wiz 9883: <a name="devfaq.makeflags"></a><a name="idm72967232"></a><p><b>22.1.</b></p>
1.75 rillig 9884: </td>
9885: <td align="left" valign="top"><p>What is the difference between
9886: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9887: <code class="varname">MAKE_FLAGS</code>?</p></td>
9888: </tr>
9889: <tr class="answer">
1.91 rillig 9890: <td align="left" valign="top"></td>
1.75 rillig 9891: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.136 dholland 9892: 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.75 rillig 9893: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9894: the <code class="varname">MAKE_PROGRAM</code> when building the
9895: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9896: </tr>
1.148 asau 9897: <tr class="question">
1.75 rillig 9898: <td align="left" valign="top">
1.172 ! wiz 9899: <a name="devfaq.make"></a><a name="idm72963136"></a><p><b>22.2.</b></p>
1.75 rillig 9900: </td>
9901: <td align="left" valign="top"><p>What is the difference between
9902: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9903: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9904: </tr>
9905: <tr class="answer">
1.91 rillig 9906: <td align="left" valign="top"></td>
1.75 rillig 9907: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.136 dholland 9908: <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.75 rillig 9909: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9910: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9911: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9912: Make program that is used for building the
9913: package.</p></td>
9914: </tr>
1.148 asau 9915: <tr class="question">
1.75 rillig 9916: <td align="left" valign="top">
1.172 ! wiz 9917: <a name="devfaq.cc"></a><a name="idm72958784"></a><p><b>22.3.</b></p>
1.75 rillig 9918: </td>
9919: <td align="left" valign="top"><p>What is the difference between
9920: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9921: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9922: </tr>
9923: <tr class="answer">
1.91 rillig 9924: <td align="left" valign="top"></td>
1.75 rillig 9925: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9926: compiler, which can be configured by the pkgsrc user.
9927: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9928: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9929: path to a compiler, but the type of compiler that should be
1.76 rillig 9930: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9931: information about the latter variable.</p></td>
9932: </tr>
1.148 asau 9933: <tr class="question">
1.75 rillig 9934: <td align="left" valign="top">
1.172 ! wiz 9935: <a name="devfaq.bl3flags"></a><a name="idm72954560"></a><p><b>22.4.</b></p>
1.75 rillig 9936: </td>
9937: <td align="left" valign="top"><p>What is the difference between
9938: <code class="varname">BUILDLINK_LDFLAGS</code>,
9939: <code class="varname">BUILDLINK_LDADD</code> and
9940: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9941: </tr>
9942: <tr class="answer">
1.91 rillig 9943: <td align="left" valign="top"></td>
1.75 rillig 9944: <td align="left" valign="top"><p>[FIXME]</p></td>
9945: </tr>
1.148 asau 9946: <tr class="question">
1.75 rillig 9947: <td align="left" valign="top">
1.172 ! wiz 9948: <a name="devfaq.bl3prefix"></a><a name="idm72952384"></a><p><b>22.5.</b></p>
1.75 rillig 9949: </td>
1.110 hubertf 9950: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9951: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9952: say it's empty?</p></td>
9953: </tr>
9954: <tr class="answer">
1.91 rillig 9955: <td align="left" valign="top"></td>
1.75 rillig 9956: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9957: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9958: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9959: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9960: command.</p></td>
9961: </tr>
1.148 asau 9962: <tr class="question">
1.78 rillig 9963: <td align="left" valign="top">
1.172 ! wiz 9964: <a name="devfaq.master_sites"></a><a name="idm72949184"></a><p><b>22.6.</b></p>
1.78 rillig 9965: </td>
9966: <td align="left" valign="top"><p>What does
9967: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9968: don't understand the <code class="literal">:=</code> inside
9969: it.</p></td>
9970: </tr>
9971: <tr class="answer">
1.91 rillig 9972: <td align="left" valign="top"></td>
1.78 rillig 9973: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9974: assignment operator, like you might expect at first sight.
9975: Instead, it is a degenerate form of
9976: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.136 dholland 9977: 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.78 rillig 9978: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9979: case of <code class="varname">MASTER_SITE_*</code>,
9980: <em class="replaceable"><code>old_string</code></em> is the empty string and
9981: <em class="replaceable"><code>new_string</code></em> is
9982: <code class="literal">package/</code>. That's where the
9983: <code class="literal">:</code> and the <code class="literal">=</code> fall
9984: together.</p></td>
9985: </tr>
1.148 asau 9986: <tr class="question">
1.78 rillig 9987: <td align="left" valign="top">
1.172 ! wiz 9988: <a name="devfaq.mailinglists"></a><a name="idm72932928"></a><p><b>22.7.</b></p>
1.78 rillig 9989: </td>
9990: <td align="left" valign="top"><p>Which mailing lists are there for package
9991: developers?</p></td>
9992: </tr>
9993: <tr class="answer">
1.91 rillig 9994: <td align="left" valign="top"></td>
1.148 asau 9995: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9996: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78 rillig 9997: <dd><p>This is a list for technical discussions related
9998: to pkgsrc development, e.g. soliciting feedback for changes to
9999: pkgsrc infrastructure, proposed new features, questions related
10000: to porting pkgsrc to a new platform, advice for maintaining a
10001: package, patches that affect many packages, help requests moved
10002: from pkgsrc-users when an infrastructure bug is found,
10003: etc.</p></dd>
1.110 hubertf 10004: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78 rillig 10005: <dd><p>All bug reports in category "pkg" sent with
1.136 dholland 10006: <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.78 rillig 10007: directly; use one of the other mailing
10008: lists.</p></dd>
10009: </dl></div></td>
10010: </tr>
1.148 asau 10011: <tr class="question">
1.80 rillig 10012: <td align="left" valign="top">
1.172 ! wiz 10013: <a name="devfaq.documentation"></a><a name="idm72929216"></a><p><b>22.8.</b></p>
1.80 rillig 10014: </td>
10015: <td align="left" valign="top"><p>Where is the pkgsrc
10016: documentation?</p></td>
10017: </tr>
10018: <tr class="answer">
1.91 rillig 10019: <td align="left" valign="top"></td>
1.80 rillig 10020: <td align="left" valign="top">
10021: <p>There are many places where you can find
10022: documentation about pkgsrc:</p>
1.148 asau 10023: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10024: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 10025: of chapters that explain large parts of pkgsrc, but some
10026: chapters tend to be outdated. Which ones they are is hard to
10027: say.</p></li>
1.128 wiz 10028: <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.80 rillig 10029: about certain features, announcements of new parts of the pkgsrc
10030: infrastructure and sometimes even announcements that a certain
10031: feature has been marked as obsolete. The benefit here is that
10032: each message has a date appended to it.</p></li>
1.128 wiz 10033: <li class="listitem"><p>Many of the files in the
1.80 rillig 10034: <code class="filename">mk/</code> directory start with a comment that
10035: describes the purpose of the file and how it can be used by the
1.92 rillig 10036: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 10037: documentation is to run <span class="command"><strong>bmake
1.92 rillig 10038: help</strong></span>.</p></li>
1.128 wiz 10039: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 10040: information, but they tend to be highly abbreviated, especially
10041: for actions that occur often. Some contain a detailed
10042: description of what has changed, but they are geared towards the
10043: other pkgsrc developers, not towards an average pkgsrc user.
10044: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10045: don't know what has been before, these messages may not be worth
10046: too much to you.</p></li>
1.128 wiz 10047: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10048: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 10049: mind of the developer who wrote the code. To get this
1.110 hubertf 10050: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 10051: to see who has written it and ask on the
10052: <code class="literal">tech-pkg</code> mailing list, so that others can
10053: find your questions later (see above). To be sure that the
10054: developer in charge reads the mail, you may CC him or
10055: her.</p></li>
10056: </ul></div>
10057: </td>
10058: </tr>
1.148 asau 10059: <tr class="question">
1.92 rillig 10060: <td align="left" valign="top">
1.172 ! wiz 10061: <a name="devfaq.too-much-time"></a><a name="idm72922688"></a><p><b>22.9.</b></p>
1.92 rillig 10062: </td>
10063: <td align="left" valign="top"><p>I have a little time to kill. What shall I
10064: do?</p></td>
10065: </tr>
10066: <tr class="answer">
10067: <td align="left" valign="top"></td>
10068: <td align="left" valign="top">
1.93 rillig 10069: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 10070: anyway.</p>
1.148 asau 10071: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10072: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92 rillig 10073: <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
10074: will tell you about newer versions of installed packages that are
10075: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 10076: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 10077: — it contains a list of suggested new packages and a list of
1.92 rillig 10078: cleanups and enhancements for pkgsrc that would be nice to
10079: have.</p></li>
1.128 wiz 10080: <li class="listitem"><p>Review packages for which review was requested on
1.110 hubertf 10081: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92 rillig 10082: mailing list.</p></li>
10083: </ul></div>
10084: </td>
10085: </tr>
1.75 rillig 10086: </tbody>
10087: </table>
10088: </div>
10089: </div>
1.148 asau 10090: <div class="chapter">
1.85 jmmv 10091: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10092: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 10093: <div class="toc">
10094: <p><b>Table of Contents</b></p>
10095: <dl>
1.106 rillig 10096: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
10097: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
10098: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
10099: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 10100: </dl>
10101: </div>
1.110 hubertf 10102: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 10103: site</a>:</p>
10104: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
10105: environment, an intuitive and attractive desktop for users, and the
10106: GNOME development platform, an extensive framework for building
10107: applications that integrate into the rest of the desktop.</p></blockquote></div>
10108: <p>pkgsrc provides a seamless way to automatically build and install
10109: a complete GNOME environment <span class="emphasis"><em>under many different
10110: platforms</em></span>. We can say with confidence that pkgsrc is one of
10111: the most advanced build and packaging systems for GNOME due to its
10112: included technologies buildlink3, the wrappers and tools framework and
10113: automatic configuration file management. Lots of efforts are put into
10114: achieving a completely clean deinstallation of installed software
10115: components.</p>
1.110 hubertf 10116: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 10117: the above also means that great efforts are put into making GNOME work
1.110 hubertf 10118: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 10119: pkgsrc as its preferred packaging system, contributing lots of
10120: portability fixes to make GNOME build and install under it.</p>
10121: <p>This chapter is aimed at pkgsrc developers and other people
10122: interested in helping our GNOME porting and packaging efforts. It
10123: provides instructions on how to manage the existing packages and some
10124: important information regarding their internals.</p>
1.148 asau 10125: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 10126: <h3 class="title">We need your help!</h3>
10127: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
10128: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 10129: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 10130: work</a> list! There is still a long way to go to get a
10131: fully-functional GNOME desktop under NetBSD and we need your help to
10132: achieve it!</p>
10133: </div>
1.148 asau 10134: <div class="sect1">
1.85 jmmv 10135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10136: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 10137: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 asau 10138: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10139: <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.85 jmmv 10140: the core GNOME desktop environment. It only includes the necessary
10141: bits to get it to boot correctly, although it may lack important
10142: functionality for daily operation. The idea behind this package is
10143: to let end users build their own configurations on top of this one,
10144: first installing this meta package to achieve a functional setup and
10145: then adding individual applications.</p></li>
1.128 wiz 10146: <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.85 jmmv 10147: complete installation of the GNOME platform and desktop as defined
10148: by the GNOME project; this is based on the components distributed in
10149: the <code class="filename">platform/x.y/x.y.z/sources</code> and
10150: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
10151: official FTP server. Developer-only tools found in those
10152: directories are not installed unless required by some other
10153: component to work properly. Similarly, packages from the bindings
10154: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
10155: in unless required as a dependency for an end-user component. This
1.91 rillig 10156: 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.128 wiz 10157: <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.85 jmmv 10158: Installs all the tools required to build a GNOME component when
10159: fetched from the CVS repository. These are required to let the
1.110 hubertf 10160: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 10161: </ul></div>
10162: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
10163: sorted in a way that eases updates: a package may depend on other
10164: packages listed before it but not on any listed after it. It is very
10165: important to keep this order to ease updates so... <span class="emphasis"><em>do not
10166: change it to alphabetical sorting!</em></span></p>
10167: </div>
1.148 asau 10168: <div class="sect1">
1.85 jmmv 10169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10170: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 10171: <p>Almost all GNOME applications are written in C and use a common
10172: set of tools as their build system. Things get different with the new
10173: bindings to other languages (such as Python), but the following will
10174: give you a general idea on the minimum required tools:</p>
1.148 asau 10175: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10176: <li class="listitem">
1.85 jmmv 10177: <p>Almost all GNOME applications use the GNU Autotools as their
10178: build system. As a general rule you will need to tell this to your
10179: package:</p>
1.100 rillig 10180: <pre class="programlisting">
10181: GNU_CONFIGURE=yes
1.85 jmmv 10182: USE_LIBTOOL=yes
1.100 rillig 10183: USE_TOOLS+=gmake
10184: </pre>
1.85 jmmv 10185: </li>
1.128 wiz 10186: <li class="listitem">
1.85 jmmv 10187: <p>If the package uses pkg-config to detect dependencies, add this
10188: tool to the list of required utilities:</p>
10189: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 10190: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85 jmmv 10191: the end of the build process to ensure that you did not miss to
10192: specify any dependency in your package and that the version
10193: requirements are all correct.</p>
10194: </li>
1.128 wiz 10195: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 10196: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 10197: to handle dependencies and to force the package to use the latest
10198: available version.</p></li>
1.128 wiz 10199: <li class="listitem">
1.85 jmmv 10200: <p>If the package uses gtk-doc (a documentation generation
10201: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
10202: tool is rather big and the distfile should come with pregenerated
10203: documentation anyway; if it does not, it is a bug that you ought to
10204: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 10205: the default):</p>
10206: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
10207: <p>The default location of installed HTML files
10208: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
10209: and should not be changed unless the package insists on installing
10210: them somewhere else. Otherwise programs as
1.110 hubertf 10211: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 10212: do that with an entry similar to:</p>
10213: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 10214: </li>
10215: </ul></div>
10216: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
10217: files under the installation prefix to maintain databases. In this
10218: context, shared means that those exact same directories and files are
10219: used among several different packages, leading to conflicts in the
10220: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
10221: handle the most common cases, so you have to forget about using
10222: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
10223: omitting shared files from them. If you find yourself doing those,
10224: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
10225: <p>The following table lists the common situations that result in
10226: using shared directories or files. For each of them, the appropriate
10227: solution is given. After applying the solution be sure to
10228: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 10229: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 10230: <div class="table">
1.106 rillig 10231: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 10232: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 10233: <colgroup>
10234: <col>
10235: <col>
10236: </colgroup>
10237: <thead><tr>
10238: <th>If the package...</th>
10239: <th>Then...</th>
10240: </tr></thead>
10241: <tbody>
10242: <tr>
10243: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 10244: <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.85 jmmv 10245: </tr>
10246: <tr>
10247: <td>Installs icons under the
10248: <code class="filename">share/icons/hicolor</code> hierarchy or updates
10249: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 10250: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.85 jmmv 10251: </tr>
10252: <tr>
10253: <td>Installs files under
10254: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 10255: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.85 jmmv 10256: </tr>
10257: <tr>
10258: <td>Installs <code class="filename">.desktop</code> files under
10259: <code class="filename">share/applications</code> and these include MIME
10260: information.</td>
1.110 hubertf 10261: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, “Packages installing desktop files”</a>.</td>
1.85 jmmv 10262: </tr>
10263: </tbody>
1.91 rillig 10264: </table></div>
1.85 jmmv 10265: </div>
1.91 rillig 10266: <br class="table-break">
1.85 jmmv 10267: </div>
1.148 asau 10268: <div class="sect1">
1.85 jmmv 10269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10270: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 10271: <p>When seeing GNOME as a whole, there are two kinds of
10272: updates:</p>
1.148 asau 10273: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 10274: <dt><span class="term">Major update</span></dt>
10275: <dd>
10276: <p>Given that there is still a very long way for GNOME 3 (if it
10277: ever appears), we consider a major update one that goes from a
10278: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10279: where <code class="literal">Y</code> is even and greater than
10280: <code class="literal">X</code>. These are hard to achieve because they
10281: introduce lots of changes in the components' code and almost all
10282: GNOME distfiles are updated to newer versions. Some of them can
10283: even break API and ABI compatibility with the previous major
10284: version series. As a result, the update needs to be done all at
10285: once to minimize breakage.</p>
10286: <p>A major update typically consists of around 80 package
10287: updates and the addition of some new ones.</p>
10288: </dd>
10289: <dt><span class="term">Minor update</span></dt>
10290: <dd>
10291: <p>We consider a minor update one that goes from a
10292: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10293: one where <code class="literal">Y</code> is greater than
10294: <code class="literal">X</code>. These are easy to achieve because they do
10295: not update all GNOME components, can be done in an incremental way
10296: and do not break API nor ABI compatibility.</p>
10297: <p>A minor update typically consists of around 50 package
10298: updates, although the numbers here may vary a lot.</p>
10299: </dd>
10300: </dl></div>
10301: <p>In order to update the GNOME components in pkgsrc to a new stable
10302: release (either major or minor), the following steps should be
10303: followed:</p>
1.128 wiz 10304: <div class="orderedlist"><ol class="orderedlist" type="1">
10305: <li class="listitem">
1.85 jmmv 10306: <p>Get a list of all the tarballs that form the new release by
10307: using the following commands. These will leave the full list of the
1.120 snj 10308: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 10309: file:</p>
1.88 wiz 10310: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10311: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10312: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 10313: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10314: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10315: awk '{ print $9 }' >>list.txt</code></strong></pre>
10316: </li>
1.128 wiz 10317: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 10318: bump their version to the release you are updating them to. The
10319: three meta packages should be always consistent with versioning.
10320: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10321: in them.</p></li>
1.128 wiz 10322: <li class="listitem">
1.85 jmmv 10323: <p>For each meta package, update all its
10324: <code class="varname">DEPENDS</code> lines to match the latest versions as
10325: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10326: newer version (even if found in the FTP) because the meta packages
10327: are supposed to list the exact versions that form a specific GNOME
10328: release. Exceptions are permitted here if a newer version solves a
10329: serious issue in the overall desktop experience; these typically
10330: come in the form of a revision bump in pkgsrc, not in newer versions
10331: from the developers.</p>
10332: <p>Packages not listed in the <code class="filename">list.txt</code> file
10333: should be updated to the latest version available (if found in
10334: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 10335: GNU Autotools in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.85 jmmv 10336: </li>
1.128 wiz 10337: <li class="listitem">
1.85 jmmv 10338: <p>Generate a patch from the modified meta packages and extract the
10339: list of "new" lines. This will provide you an outline on what
10340: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10341: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.85 jmmv 10342: </li>
1.128 wiz 10343: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 10344: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 10345: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 10346: of <code class="filename">todo.txt</code> and update the packages listed in
10347: it in order. For major desktop updates none of these should be
1.93 rillig 10348: committed until the entire set is completed because there are chances
1.85 jmmv 10349: of breaking not-yet-updated packages.</p></li>
1.128 wiz 10350: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 10351: the tree one by one with appropriate log messages. At the end,
10352: commit the three meta package updates and all the corresponding
10353: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10354: <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>
10355: </ol></div>
10356: </div>
1.148 asau 10357: <div class="sect1">
1.85 jmmv 10358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10359: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10360: <p>GNOME is a very big component in pkgsrc which approaches 100
10361: packages. Please, it is very important that you always, always,
10362: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10363: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, “Feedback to the author”</a>). This is the only way to get
1.85 jmmv 10364: their attention on portability issues and to ensure that future versions
10365: can be built out-of-the box on NetBSD. The less custom patches in
10366: pkgsrc, the easier further updates are. Those developers in charge of
10367: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10368: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85 jmmv 10369: Bugzilla</a>. Not all components use these to track bugs, but most
10370: of them do. Do not be short on your reports: always provide detailed
10371: explanations of the current failure, how it can be improved to achieve
10372: maximum portability and, if at all possible, provide a patch against CVS
10373: head. The more verbose you are, the higher chances of your patch being
10374: accepted.</p>
10375: <p>Also, please avoid using preprocessor magic to fix portability
10376: issues. While the FreeBSD GNOME people are doing a great job in porting
10377: GNOME to their operating system, the official GNOME sources are now
10378: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10379: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10380: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 10381: details.</p>
10382: </div>
10383: </div>
1.75 rillig 10384: </div>
1.148 asau 10385: <div class="part">
1.75 rillig 10386: <div class="titlepage"><div><div><h1 class="title">
10387: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10388: <div class="partintro">
1.75 rillig 10389: <div></div>
10390: <p>This part of the guide deals with everything
10391: from the infrastructure that is behind the interfaces described
10392: in the developer's guide. A casual package maintainer should not
10393: need anything from this part.</p>
10394: <div class="toc">
10395: <p><b>Table of Contents</b></p>
10396: <dl>
1.106 rillig 10397: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10398: <dd><dl>
1.106 rillig 10399: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10400: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10401: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10402: <dd><dl>
1.106 rillig 10403: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10404: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10405: </dl></dd>
1.106 rillig 10406: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10407: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10408: <dd><dl>
1.106 rillig 10409: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10410: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 10411: </dl></dd>
1.106 rillig 10412: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10413: <dd><dl>
1.128 wiz 10414: <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>
10415: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10416: </dl></dd>
10417: </dl></dd>
1.106 rillig 10418: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10419: <dd><dl>
1.106 rillig 10420: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10421: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10422: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10423: <dd><dl>
1.106 rillig 10424: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10425: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10426: </dl></dd>
10427: </dl></dd>
1.106 rillig 10428: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10429: <dd><dl>
1.106 rillig 10430: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10431: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10432: </dl></dd>
10433: </dl>
10434: </div>
10435: </div>
1.148 asau 10436: <div class="chapter">
1.75 rillig 10437: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10438: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10439: <div class="toc">
10440: <p><b>Table of Contents</b></p>
10441: <dl>
1.106 rillig 10442: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10443: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10444: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10445: <dd><dl>
1.106 rillig 10446: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10447: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10448: </dl></dd>
1.106 rillig 10449: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10450: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10451: <dd><dl>
1.106 rillig 10452: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10453: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 10454: </dl></dd>
1.106 rillig 10455: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10456: <dd><dl>
1.128 wiz 10457: <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>
10458: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10459: </dl></dd>
10460: </dl>
10461: </div>
10462: <p>The pkgsrc infrastructure consists of many small Makefile
10463: fragments. Each such fragment needs a properly specified
10464: interface. This chapter explains how such an interface looks
10465: like.</p>
1.148 asau 10466: <div class="sect1">
1.75 rillig 10467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10468: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10469: <p>Whenever a variable is defined in the pkgsrc
10470: infrastructure, the location and the way of definition provide
10471: much information about the intended use of that variable.
10472: Additionally, more documentation may be found in a header
10473: comment or in this pkgsrc guide.</p>
10474: <p>A special file is
10475: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10476: variables that are intended to be user-defined. They are either
10477: defined using the <code class="literal">?=</code> operator or they are
10478: left undefined because defining them to anything would
1.128 wiz 10479: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10480: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10481: file.</p>
10482: <p>Outside this file, the following conventions apply:
10483: Variables that are defined using the <code class="literal">?=</code>
10484: operator may be overridden by a package.</p>
10485: <p>Variables that are defined using the <code class="literal">=</code>
10486: operator may be used read-only at run-time.</p>
10487: <p>Variables whose name starts with an underscore must not be
10488: accessed outside the pkgsrc infrastructure at all. They may
10489: change without further notice.</p>
1.148 asau 10490: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10491: <h3 class="title">Note</h3>
10492: <p>These conventions are currently not applied
10493: consistently to the complete pkgsrc
10494: infrastructure.</p>
10495: </div>
10496: </div>
1.148 asau 10497: <div class="sect1">
1.81 rillig 10498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10499: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10500: <p>All variables that contain lists of things should default
10501: to being empty. Two examples that do not follow this rule are
10502: <code class="varname">USE_LANGUAGES</code> and
10503: <code class="varname">DISTFILES</code>. These variables cannot simply be
10504: modified using the <code class="literal">+=</code> operator in package
10505: <code class="filename">Makefile</code>s (or other files included by
10506: them), since there is no guarantee whether the variable is
10507: already set or not, and what its value is. In the case of
1.128 wiz 10508: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10509: the default value and just define it as in the following
10510: example.</p>
10511: <pre class="programlisting">
1.100 rillig 10512: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10513: </pre>
10514: <p>Because of the selection of this default value, the same
10515: value appears in many package Makefiles. Similarly for
10516: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10517: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10518: doesn't stand out. Nevertheless it is mentioned in many
10519: files.</p>
10520: </div>
1.148 asau 10521: <div class="sect1">
1.81 rillig 10522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10523: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148 asau 10524: <div class="sect2">
1.75 rillig 10525: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10526: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10527: <p>Variable evaluation takes place either at load time or at
10528: runtime, depending on the context in which they occur. The
10529: contexts where variables are evaluated at load time are:</p>
1.148 asau 10530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10531: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10532: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10533: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10534: <code class="literal">.for</code>,</p></li>
1.128 wiz 10535: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10536: </ul></div>
10537: <p>A special exception are references to the iteration
10538: variables of <code class="literal">.for</code> loops, which are expanded
10539: inline, no matter in which context they appear.</p>
10540: <p>As the values of variables may change during load time,
10541: care must be taken not to evaluate them by accident. Typical
10542: examples for variables that should not be evaluated at load time
10543: are <code class="varname">DEPENDS</code> and
10544: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10545: clear, here is an example:</p>
10546: <pre class="programlisting">
1.100 rillig 10547: CONFIGURE_ARGS= # none
10548: CFLAGS= -O
10549: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10550:
1.100 rillig 10551: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10552:
1.100 rillig 10553: CFLAGS+= -Wall
1.75 rillig 10554: </pre>
10555: <p>This code shows how the use of the <code class="literal">:=</code>
10556: operator can quickly lead to unexpected results. The first
10557: paragraph is fairly common code. The second paragraph evaluates
10558: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10559: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10560: <code class="literal">-Wall</code> is appended to the
10561: <code class="varname">CFLAGS</code>, but this addition will not appear in
10562: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10563: paragraphs from above typically occur in completely unrelated
10564: files.</p>
10565: </div>
1.148 asau 10566: <div class="sect2">
1.75 rillig 10567: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10568: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10569: <p>After all the files have been loaded, the values of the
10570: variables cannot be changed anymore. Variables that are used in
10571: the shell commands are expanded at this point.</p>
10572: </div>
10573: </div>
1.148 asau 10574: <div class="sect1">
1.75 rillig 10575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10576: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10577: <p>There are many ways in which the definition and use of a
10578: variable can be restricted in order to detect bugs and
10579: violations of the (mostly unwritten) policies. See the
10580: <code class="literal">pkglint</code> developer's documentation for further
10581: details.</p>
10582: </div>
1.148 asau 10583: <div class="sect1">
1.78 rillig 10584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10585: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10586: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10587: of the following classes. Cases where a file falls into more
10588: than one class should be avoided as it often leads to subtle
10589: bugs.</p>
1.148 asau 10590: <div class="sect2">
1.75 rillig 10591: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10592: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10593: <p>In a traditional imperative programming language some of
1.76 rillig 10594: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10595: procedures. They take some input parameters and—after
10596: inclusion—provide a result in output parameters. Since all
1.76 rillig 10597: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10598: care must be taken not to use parameter names that have already
10599: another meaning. For example, <code class="varname">PKGNAME</code> is a
10600: bad choice for a parameter name.</p>
10601: <p>Procedures are completely evaluated at preprocessing time.
10602: That is, when calling a procedure all input parameters must be
10603: completely resolvable. For example,
10604: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10605: parameter since it is very likely that further text will be
10606: added after calling the procedure, which would effectively apply
10607: the procedure to only a part of the variable. Also, references
10608: to other variables wit will be modified after calling the
10609: procedure.</p>
10610: <p>A procedure can declare its output parameters either as
10611: suitable for use in preprocessing directives or as only
10612: available at runtime. The latter alternative is for variables
10613: that contain references to other runtime variables.</p>
10614: <p>Procedures shall be written such that it is possible to
10615: call the procedure more than once. That is, the file must not
10616: contain multiple-inclusion guards.</p>
10617: <p>Examples for procedures are
1.76 rillig 10618: <code class="filename">mk/bsd.options.mk</code> and
10619: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10620: that the parameters are evaluated at load time, they should be
10621: assigned using the <code class="literal">:=</code> operator, which should
10622: be used only for this purpose.</p>
10623: </div>
1.148 asau 10624: <div class="sect2">
1.75 rillig 10625: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10626: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10627: <p>Action files take some input parameters and may define
10628: runtime variables. They shall not define loadtime variables.
10629: There are action files that are included implicitly by the
10630: pkgsrc infrastructure, while other must be included
10631: explicitly.</p>
10632: <p>An example for action files is
1.76 rillig 10633: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10634: </div>
10635: </div>
1.148 asau 10636: <div class="sect1">
1.81 rillig 10637: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10638: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10639: <p>Package <code class="filename">Makefile</code>s usually consist of
10640: a set of variable definitions, and include the file
10641: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10642: Before that, they may also include various other
10643: <code class="filename">*.mk</code> files if they need to query the
10644: availability of certain features like the type of compiler or
10645: the X11 implementation. Due to the heavy use of preprocessor
10646: directives like <code class="literal">.if</code> and
10647: <code class="literal">.for</code>, the order in which the files are loaded
10648: matters.</p>
10649: <p>This section describes at which point the various files
10650: are loaded and gives reasons for that order.</p>
1.148 asau 10651: <div class="sect2">
1.81 rillig 10652: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10653: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10654: </h3></div></div></div>
10655: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10656: is to define some essential variables like
10657: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10658: <code class="varname">MACHINE_ARCH</code>.</p>
10659: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10660: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104 rillig 10661: After that, those variables
1.81 rillig 10662: that have not been overridden by the user are loaded from
10663: <code class="filename">mk/defaults/mk.conf</code>.</p>
10664: <p>After the user settings, the system settings and platform
10665: settings are loaded, which may override the user
10666: settings.</p>
10667: <p>Then, the tool definitions are loaded. The tool wrappers
10668: are not yet in effect. This only happens when building a
10669: package, so the proper variables must be used instead of the
10670: direct tool names.</p>
10671: <p>As the last steps, some essential variables from the
10672: wrapper and the package system flavor are loaded, as well as the
10673: variables that have been cached in earlier phases of a package
10674: build.</p>
10675: </div>
1.148 asau 10676: <div class="sect2">
1.81 rillig 10677: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10678: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10679: </h3></div></div></div>
1.81 rillig 10680: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10681: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10682: loaded, which fill default values for those variables that have
1.93 rillig 10683: not been defined by the package. These variables may later
1.81 rillig 10684: be used even in unrelated files.</p>
10685: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10686: provides the target <code class="literal">error-check</code> that is added
10687: as a special dependency to all other targets that use
10688: <code class="varname">DELAYED_ERROR_MSG</code> or
10689: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10690: <p>Then, the package-specific hacks from
10691: <code class="filename">hacks.mk</code> are included.</p>
10692: <p>Then, various other files follow. Most of them don't have
10693: any dependencies on what they need to have included before or
10694: after them, though some do.</p>
10695: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10696: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10697: restricts the use of these variables to all the files that have
10698: been included before. Appearances in later files will be
10699: silently ignored.</p>
10700: <p>Then, the files for the main targets are included, in the
10701: order of later execution, though the actual order should not
10702: matter.</p>
10703: <p>At last, some more files are included that don't set any
10704: interesting variables but rather just define make targets to be
10705: executed.</p>
10706: </div>
10707: </div>
1.75 rillig 10708: </div>
1.148 asau 10709: <div class="chapter">
1.75 rillig 10710: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10711: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10712: <div class="toc">
10713: <p><b>Table of Contents</b></p>
10714: <dl>
1.106 rillig 10715: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10716: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10717: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10718: <dd><dl>
1.106 rillig 10719: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10720: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10721: </dl></dd>
10722: </dl>
10723: </div>
10724: <p>The pkgsrc infrastructure consists of a large codebase,
10725: and there are many corners where every little bit of a file is
10726: well thought out, making pkgsrc likely to fail as soon as
10727: anything is changed near those parts. To prevent most changes
10728: from breaking anything, a suite of regression tests should go
10729: along with every important part of the pkgsrc infrastructure.
10730: This chapter describes how regression tests work in pkgsrc and
10731: how you can add new tests.</p>
1.148 asau 10732: <div class="sect1">
1.75 rillig 10733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10734: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10735: <p></p>
10736: </div>
1.148 asau 10737: <div class="sect1">
1.75 rillig 10738: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10739: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10740: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110 hubertf 10741: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10742: can simply run that command, which will run all tests in the
1.76 rillig 10743: <code class="filename">regress</code> category.</p>
1.75 rillig 10744: </div>
1.148 asau 10745: <div class="sect1">
1.75 rillig 10746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10747: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10748: <p>Every directory in the <code class="filename">regress</code>
10749: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10750: is considered a regression test. This file is a shell program
1.110 hubertf 10751: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10752: The following functions can be overridden to suit your
10753: needs.</p>
1.148 asau 10754: <div class="sect2">
1.75 rillig 10755: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10756: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10757: <p>These functions do not take any parameters. They are all
1.128 wiz 10758: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10759: to check the exitcodes of any commands you run in the
10760: test.</p>
1.148 asau 10761: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10762: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10763: <dd><p>This function prepares the environment for the
10764: test. By default it does nothing.</p></dd>
10765: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10766: <dd><p>This function runs the actual test. By default,
10767: it calls <code class="varname">TEST_MAKE</code> with the arguments
10768: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10769: error messages into the file
10770: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10771: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10772: <dd><p>This function is run after the test and is
10773: typically used to compare the actual output from the one that is
10774: expected. It can make use of the various helper functions from
10775: the next section.</p></dd>
10776: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10777: <dd><p>This function cleans everything up after the
10778: test has been run. By default it does nothing.</p></dd>
10779: </dl></div>
10780: </div>
1.148 asau 10781: <div class="sect2">
1.75 rillig 10782: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10783: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148 asau 10784: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10785: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10786: <dd><p>This function compares the exitcode of the
1.110 hubertf 10787: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10788: If they differ, the test will fail.</p></dd>
10789: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10790: <dd><p>This function checks for each of its parameters
1.110 hubertf 10791: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10792: extended regular expression. If it does not, the test will
10793: fail.</p></dd>
10794: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10795: <dd><p>This function checks for each of its parameters
1.110 hubertf 10796: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10797: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10798: If any of the regular expressions matches, the test will
10799: fail.</p></dd>
10800: </dl></div>
10801: </div>
10802: </div>
10803: </div>
1.148 asau 10804: <div class="chapter">
1.75 rillig 10805: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10806: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10807: <div class="toc">
10808: <p><b>Table of Contents</b></p>
10809: <dl>
1.106 rillig 10810: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10811: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10812: </dl>
10813: </div>
10814: <p>The pkgsrc system has already been ported to many
10815: operating systems, hardware architectures and compilers. This
10816: chapter explains the necessary steps to make pkgsrc even more
10817: portable.</p>
1.148 asau 10818: <div class="sect1">
1.75 rillig 10819: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10820: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10821: <p>To port pkgsrc to a new operating system (called
10822: <code class="literal">MyOS</code> in this example), you need to touch the
10823: following files:</p>
1.148 asau 10824: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10825: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75 rillig 10826: <dd><p>This file contains some basic definitions, for
10827: example the name of the C
10828: compiler.</p></dd>
1.76 rillig 10829: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10830: <dd><p>Insert code that defines the variables
10831: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10832: <code class="varname">LOWER_OS_VERSION</code>,
10833: <code class="varname">LOWER_VENDOR</code>,
10834: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10835: <code class="varname">APPEND_ELF</code>, and the other variables that
10836: appear in this file.</p></dd>
1.93 rillig 10837: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10838: <dd><p>This file contains the platform-specific
10839: definitions that are used by pkgsrc. Start by copying one of the
10840: other files and edit it to your
10841: needs.</p></dd>
1.93 rillig 10842: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10843: <dd><p>This file contains a list of directories,
10844: together with their permission bits and ownership. These
10845: directories will be created automatically with every package
1.98 wiz 10846: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10847: be removed.</p></dd>
1.93 rillig 10848: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10849: <dd><p>Just copy one of the pre-existing x11.dist files
10850: to your
1.76 rillig 10851: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10852: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10853: <dd><p>On some operating systems, the tools that are
10854: provided with the base system are not good enough for pkgsrc.
1.136 dholland 10855: 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.75 rillig 10856: narrow limit on the line length they can process. Therefore
10857: pkgsrc brings its own tools, which can be enabled
10858: here.</p></dd>
1.93 rillig 10859: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10860: <dd><p>This file defines the paths to all the tools
10861: that are needed by one or the other package in pkgsrc, as well
10862: as by pkgsrc itself. Find out where these tools are on your
10863: platform and add them.</p></dd>
10864: </dl></div>
10865: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10866: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75 rillig 10867: </div>
1.148 asau 10868: <div class="sect1">
1.75 rillig 10869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10870: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10871: <p>TODO</p>
10872: </div>
10873: </div>
10874: </div>
1.148 asau 10875: <div class="appendix">
10876: <div class="titlepage"><div><div><h1 class="title">
10877: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10878: <div class="toc">
10879: <p><b>Table of Contents</b></p>
10880: <dl>
10881: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10882: <dd><dl>
10883: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10884: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10885: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10886: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75 rillig 10887: </dl></dd>
10888: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10889: </dl>
10890: </div>
10891: <p>We checked to find a piece of software that wasn't in the packages
10892: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10893: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10894: present in the tree is beyond us, but it's useful for the purposes of
10895: this exercise.</p>
1.148 asau 10896: <div class="sect1">
1.75 rillig 10897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10898: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10899: <div class="sect2">
1.75 rillig 10900: <div class="titlepage"><div><div><h3 class="title">
10901: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10902: <pre class="programlisting">
1.100 rillig 10903: # $NetBSD$
10904: #
1.1 grant 10905:
1.100 rillig 10906: DISTNAME= bison-1.25
10907: CATEGORIES= devel
10908: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10909:
1.136 dholland 10910: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 10911: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10912: COMMENT= GNU yacc clone
1.1 grant 10913:
1.100 rillig 10914: GNU_CONFIGURE= yes
1.152 wiz 10915: INFO_FILES= yes
1.1 grant 10916:
1.100 rillig 10917: .include "../../mk/bsd.pkg.mk"
1.1 grant 10918: </pre>
1.75 rillig 10919: </div>
1.148 asau 10920: <div class="sect2">
1.75 rillig 10921: <div class="titlepage"><div><div><h3 class="title">
10922: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10923: <pre class="programlisting">
1.100 rillig 10924: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.136 dholland 10925: 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.100 rillig 10926: of the NetBSD source tree is beyond me.
1.1 grant 10927: </pre>
1.75 rillig 10928: </div>
1.148 asau 10929: <div class="sect2">
1.75 rillig 10930: <div class="titlepage"><div><div><h3 class="title">
10931: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10932: <pre class="programlisting">
1.100 rillig 10933: @comment $NetBSD$
10934: bin/bison
10935: man/man1/bison.1.gz
10936: share/bison.simple
10937: share/bison.hairy
1.1 grant 10938: </pre>
1.75 rillig 10939: </div>
1.148 asau 10940: <div class="sect2">
1.75 rillig 10941: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10942: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10943: </h3></div></div></div>
1.75 rillig 10944: <p>The NetBSD package system comes with
1.91 rillig 10945: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 10946: which helps to check the contents of these
10947: files. After installation it is quite easy to use, just change to the
10948: directory of the package you wish to examine and execute
1.110 hubertf 10949: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10950: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10951: looks fine.</pre>
10952: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10953: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10954: -Wall</strong></span> for a very thorough check.</p>
10955: </div>
10956: </div>
1.148 asau 10957: <div class="sect1">
1.75 rillig 10958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10959: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10960: <p>Create the directory where the package lives,
10961: plus any auxiliary directories:</p>
10962: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10963: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10964: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10965: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10966: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10967: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.75 rillig 10968: then continue with fetching the distfile:</p>
10969: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10970: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10971: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10972: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10973: ftp: Error retrieving file: 500 Internal error
10974:
10975: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10976: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10977: ftp: Error retrieving file: 500 Internal error
10978:
10979: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10980: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10981: Successfully retrieved file.</pre>
10982: <p>Generate the checksum of the distfile into
1.76 rillig 10983: <code class="filename">distinfo</code>:</p>
1.88 wiz 10984: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10985: <p>Now compile:</p>
10986: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10987: >> Checksum OK for bison-1.25.tar.gz.
10988: ===> Extracting for bison-1.25
10989: ===> Patching for bison-1.25
10990: ===> Ignoring empty patch directory
10991: ===> Configuring for bison-1.25
10992: creating cache ./config.cache
10993: checking for gcc... cc
10994: checking whether we are using GNU C... yes
10995: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10996: checking how to run the C preprocessor... cc -E
10997: checking for minix/config.h... no
10998: checking for POSIXized ISC... no
10999: checking whether cross-compiling... no
11000: checking for ANSI C header files... yes
11001: checking for string.h... yes
11002: checking for stdlib.h... yes
11003: checking for memory.h... yes
11004: checking for working const... yes
11005: checking for working alloca.h... no
11006: checking for alloca... yes
11007: checking for strerror... yes
11008: updating cache ./config.cache
11009: creating ./config.status
11010: creating Makefile
11011: ===> Building for bison-1.25
11012: 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
11013: 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
11014: 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
11015: 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
11016: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 11017: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
1.1 grant 11018: 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
11019: 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
11020: 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
11021: 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
11022: 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
11023: 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
11024: 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
11025: 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
11026: 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
11027: 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
11028: 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
11029: 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
11030: 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
11031: 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
11032: 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
11033: 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
11034: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
11035: rm -f bison.s1
1.75 rillig 11036: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
11037: <p>Everything seems OK, so install the files:</p>
11038: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 11039: >> Checksum OK for bison-1.25.tar.gz.
11040: ===> Installing for bison-1.25
11041: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
11042: rm -f /usr/pkg/bin/bison
11043: cd /usr/pkg/share; rm -f bison.simple bison.hairy
11044: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
11045: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11046: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11047: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11048: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11049: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 11050: ===> Registering installation for bison-1.25</pre>
11051: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 11052: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 11053: binary package, do this now:</p>
11054: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 11055: >> Checksum OK for bison-1.25.tar.gz.
11056: ===> Building package for bison-1.25
11057: Creating package bison-1.25.tgz
11058: Registering depends:.
1.75 rillig 11059: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11060: <p>Now that you don't need the source and object files
11061: any more, clean up:</p>
11062: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11063: ===> Cleaning for bison-1.25</pre>
11064: </div>
11065: </div>
1.148 asau 11066: <div class="appendix">
11067: <div class="titlepage"><div><div><h1 class="title">
11068: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 11069: <div class="toc">
11070: <p><b>Table of Contents</b></p>
11071: <dl>
11072: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
11073: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
11074: </dl>
11075: </div>
1.148 asau 11076: <div class="sect1">
1.75 rillig 11077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11078: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
11079: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 11080: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11081: => figlet221.tar.gz doesn't seem to exist on this system.
11082: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11083: => [172219 bytes]
11084: Connected to ftp.plig.net.
11085: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11086: 331 Guest login ok, send your complete e-mail address as password.
11087: 230-You are user #5 of 500 simultaneous users allowed.
11088: 230-
1.68 rillig 11089: 230- ___ _ _ _
11090: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 11091: 230- | _| _| . |_| . | | | . |_| . | _| . |
11092: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11093: 230- |_| |_| |___| |___|
11094: 230-
11095: 230-** Welcome to ftp.plig.org **
11096: 230-
11097: 230-Please note that all transfers from this FTP site are logged. If you
11098: 230-do not like this, please disconnect now.
11099: 230-
1.120 snj 11100: 230-This archive is available via
1.1 grant 11101: 230-
11102: 230-HTTP: http://ftp.plig.org/
11103: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11104: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11105: 230-
11106: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 11107: 230-mirrored to ftp-admin@plig.org.
1.1 grant 11108: 230-
11109: 230-
11110: 230 Logged in anonymously.
11111: Remote system type is UNIX.
11112: Using binary mode to transfer files.
11113: 200 Type okay.
11114: 250 "/pub" is new cwd.
11115: 250-"/pub/figlet" is new cwd.
11116: 250-
11117: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 11118: 250-
1.75 rillig 11119: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 11120: 250-
11121: 250-The official FIGlet web page is:
1.75 rillig 11122: 250- http://www.figlet.org/
1.1 grant 11123: 250-
11124: 250-If you have questions, please mailto:info@figlet.org. If you want to
11125: 250-contribute a font or something else, you can email us.
1.68 rillig 11126: 250
1.1 grant 11127: 250 "/pub/figlet/program" is new cwd.
11128: 250 "/pub/figlet/program/unix" is new cwd.
11129: local: figlet221.tar.gz remote: figlet221.tar.gz
11130: 502 Unimplemented command.
11131: 227 Entering Passive Mode (195,40,6,41,246,104)
11132: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11133: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11134: 226 Transfer completed.
11135: 172219 bytes received in 00:02 (75.99 KB/s)
11136: 221 Goodbye.
11137: => Checksum OK for figlet221.tar.gz.
11138: ===> Extracting for figlet-2.2.1nb2
11139: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11140: ===> Patching for figlet-2.2.1nb2
11141: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11142: ===> Overriding tools for figlet-2.2.1nb2
11143: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11144: ===> Configuring for figlet-2.2.1nb2
11145: ===> Building for figlet-2.2.1nb2
11146: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11147: chmod a+x figlet
11148: gcc -O2 -o chkfont chkfont.c
11149: => Unwrapping files-to-be-installed.
1.14 xtraeme 11150: <code class="prompt">#</code>
1.75 rillig 11151: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 11152: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11153: ===> Installing for figlet-2.2.1nb2
11154: install -d -o root -g wheel -m 755 /usr/pkg/bin
11155: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11156: mkdir -p /usr/pkg/share/figlet
11157: cp figlet /usr/pkg/bin
11158: cp chkfont /usr/pkg/bin
11159: chmod 555 figlist showfigfonts
11160: cp figlist /usr/pkg/bin
11161: cp showfigfonts /usr/pkg/bin
11162: cp fonts/*.flf /usr/pkg/share/figlet
11163: cp fonts/*.flc /usr/pkg/share/figlet
11164: cp figlet.6 /usr/pkg/man/man6
11165: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 11166: <code class="prompt">#</code></pre>
11167: </div>
1.148 asau 11168: <div class="sect1">
1.75 rillig 11169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11170: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
11171: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 11172: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11173: ===> Packaging figlet-2.2.1nb2
11174: ===> Building binary package for figlet-2.2.1nb2
11175: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11176: Using SrcDir value of /usr/pkg
1.68 rillig 11177: Registering depends:.
1.75 rillig 11178: <code class="prompt">#</code></pre>
11179: </div>
11180: </div>
1.148 asau 11181: <div class="appendix">
11182: <div class="titlepage"><div><div><h1 class="title">
11183: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 11184: <div class="toc">
11185: <p><b>Table of Contents</b></p>
11186: <dl>
1.128 wiz 11187: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11188: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11189: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11190: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11191: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
11192: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11193: source packages</a></span></dt>
11194: </dl>
11195: </div>
11196: <p>As in other big projects, the directory layout of pkgsrc
11197: is quite complex for newbies. This chapter explains where you
11198: find things on the FTP server. The base directory on
1.110 hubertf 11199: <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89 rillig 11200: On other servers it may be different, but inside this directory,
11201: everything should look the same, no matter on which server you
11202: are. This directory contains some subdirectories, which are
11203: explained below.</p>
1.148 asau 11204: <div class="sect1">
1.76 rillig 11205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11206: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 11207: <p>The directory <code class="filename">distfiles</code> contains lots
11208: of archive files from all pkgsrc packages, which are mirrored
11209: here. The subdirectories are called after their package names
11210: and are used when the distributed files have names that don't
11211: explicitly contain a version number or are otherwise too generic
11212: (for example <code class="filename">release.tar.gz</code>).</p>
11213: </div>
1.148 asau 11214: <div class="sect1">
1.76 rillig 11215: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11216: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 11217: <p>This directory contains things that individual pkgsrc
11218: developers find worth publishing.</p>
11219: </div>
1.148 asau 11220: <div class="sect1">
1.76 rillig 11221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11222: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 11223: <p>This directory contains binary packages for the various
11224: platforms that are supported by pkgsrc.
11225: 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.148 asau 11226: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 11227: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 11228: operating system for which the packages have been built. The
1.110 hubertf 11229: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 11230: command, so it may differ from the one you are used to
11231: hear.</p></li>
1.128 wiz 11232: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 11233: architecture of the platform for which the packages have been
1.110 hubertf 11234: built. It also includes the <code class="varname">ABI</code> (Application
11235: Binary Interface) for platforms that have several of
11236: them.</p></li>
1.128 wiz 11237: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 11238: the operating system. For version numbers that change often (for
11239: example NetBSD-current), the often-changing part should be
11240: replaced with an <code class="literal">x</code>, for example
11241: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 11242: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 11243: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 11244: for a stable branch, or <code class="literal">head</code> for packages
11245: built from the HEAD branch. The latter should only be used when
11246: the packages are updated on a regular basis. Otherwise the date
11247: from checking out pkgsrc should be appended, for example
11248: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 11249: </ul></div>
11250: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11251: can quickly click through the directories on the
11252: server and find the best binary packages for their machines. Since they
11253: usually know the operating system and the hardware architecture, OPSYS
11254: and ARCH are placed first. After these choices, they can select the
11255: best combination of OSVERSION and TAG together, since it is usually the
11256: case that packages stay compatible between different version of the
11257: operating system.</p>
11258: <p>In each of these directories, there is a
11259: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 11260: <code class="filename">All</code> which contains all binary packages.
11261: Besides that, there are various category directories that
11262: contain symbolic links to the real binary packages.</p>
11263: </div>
1.148 asau 11264: <div class="sect1">
1.76 rillig 11265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11266: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11267: <p>Here are the reports from bulk builds, for those who want
11268: to fix packages that didn't build on some of the platforms. The
1.128 wiz 11269: 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.108 rillig 11270: </div>
1.148 asau 11271: <div class="sect1">
1.108 rillig 11272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11273: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
11274: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11275: source packages</h2></div></div></div>
1.128 wiz 11276: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11277: that is the files that define how to create binary packages from
11278: source archives.</p>
11279: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11280: snapshot of the CVS repository, which is updated regularly. The
11281: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11282: directory, ready to be downloaded as a whole.</p>
1.76 rillig 11283: <p>In the directories for the quarterly branches, there is an
11284: additional file called
1.126 jakllsch 11285: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.76 rillig 11286: which contains the state of pkgsrc when it was branched.</p>
11287: </div>
1.75 rillig 11288: </div>
1.148 asau 11289: <div class="appendix">
11290: <div class="titlepage"><div><div><h1 class="title">
11291: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 11292: <div class="toc">
11293: <p><b>Table of Contents</b></p>
11294: <dl>
1.79 rillig 11295: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 11296: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11297: </dl>
11298: </div>
1.79 rillig 11299: <p>This section contains information on editing the pkgsrc
11300: guide itself.</p>
1.148 asau 11301: <div class="sect1">
1.75 rillig 11302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 11303: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11304: <p>The pkgsrc guide's source code is stored in
11305: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11306: are created from it:</p>
1.148 asau 11307: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 11308: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11309: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
11310: <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>
11311: <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.79 rillig 11312: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 11313: <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.79 rillig 11314: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 11315: </ul></div>
11316: </div>
1.148 asau 11317: <div class="sect1">
1.75 rillig 11318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11319: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 11320: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 11321: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 11322: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 11323: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 11324: documentation) installed. These are automatically installed when
11325: 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.148 asau 11326: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 11327: right directory. All further steps will take place
11328: here.</p></li>
1.148 asau 11329: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 11330: <code class="filename">files/</code>.</p></li>
1.148 asau 11331: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 11332: guide for valid XML and to build the final output files. If you
11333: get any errors at this stage, you can just edit the files, as
11334: there are only symbolic links in the working directory, pointing
11335: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 11336: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 11337: commit)</strong></span></p></li>
1.148 asau 11338: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 11339: regenerate the output files with the proper RCS
11340: Ids.</p></li>
1.148 asau 11341: <li class="step">
1.110 hubertf 11342: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 11343: commit the files in both <code class="filename">pkgsrc/doc</code> and
11344: <code class="filename">htdocs</code>.</p>
1.148 asau 11345: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 11346: <h3 class="title">Note</h3>
11347: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 11348: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11349: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 11350: directory.</p>
11351: </div>
11352: </li>
1.79 rillig 11353: </ol></div>
1.75 rillig 11354: </div>
11355: </div>
11356: </div></body>
1.1 grant 11357: </html>
CVSweb <webmaster@jp.NetBSD.org>