Annotation of pkgsrc/doc/pkgsrc.html, revision 1.148
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>
67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</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>
82: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
83: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
84: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
85: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
86: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
87: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
88: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 89: </dl></dd>
90: </dl></dd>
91: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
92: <dd><dl>
93: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
94: <dd><dl>
95: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
96: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 97: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
98: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
99: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
100: <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>
101: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
102: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 103: </dl></dd>
104: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
105: <dd><dl>
106: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
107: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
108: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
109: </dl></dd>
110: </dl></dd>
111: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
112: <dd><dl>
113: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
114: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 115: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 116: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 117: <dd><dl>
1.103 wiz 118: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 119: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
120: <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 121: </dl></dd>
1.103 wiz 122: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
123: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 124: </dl></dd>
125: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
126: <dd><dl>
127: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
128: <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 129: </dl></dd>
130: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
131: builds)</a></span></dt>
1.75 rillig 132: <dd><dl>
1.106 rillig 133: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
134: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
135: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
136: <dd><dl>
137: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
138: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
139: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
140: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
141: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
142: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
143: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
144: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
145: </dl></dd>
146: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 147: <dd><dl>
148: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
149: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
150: </dl></dd>
1.106 rillig 151: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
152: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
153: </dl></dd>
154: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
155: <dd><dl>
1.128 wiz 156: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
157: <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 158: </dl></dd>
159: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
160: <dd><dl>
161: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
162: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
163: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
164: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
165: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
166: <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>
167: <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 168: <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 169: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.128 wiz 170: <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
171: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
172: <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 173: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
174: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
175: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.128 wiz 176: <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 177: <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 178: <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 179: </dl></dd>
180: </dl></dd>
181: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
182: <dd><dl>
1.106 rillig 183: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 184: <dd><dl>
1.106 rillig 185: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 186: <dd><dl>
1.106 rillig 187: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
188: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 189: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 190: </dl></dd>
1.106 rillig 191: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
192: <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>
193: </dl></dd>
194: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
195: <dd><dl>
1.128 wiz 196: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
197: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 198: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
199: <dd><dl>
200: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
201: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
202: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
203: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
204: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
205: </dl></dd>
206: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
207: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
208: <dd><dl>
209: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
210: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
211: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
212: </dl></dd>
1.128 wiz 213: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
214: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 215: </dl></dd>
1.128 wiz 216: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 217: <dd><dl>
218: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 219: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 220: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
221: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
222: <dd><dl>
223: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
224: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
225: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
226: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
227: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
228: </dl></dd>
229: </dl></dd>
230: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
231: <dd><dl>
232: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 233: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
234: <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 235: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
236: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 237: <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 238: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
239: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
240: </dl></dd>
241: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
242: <dd><dl>
243: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 244: <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 245: <dd><dl>
246: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 247: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
248: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
249: and
250: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
251: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 252: </dl></dd>
1.128 wiz 253: <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 254: <dd><dl>
1.128 wiz 255: <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 256: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
257: </dl></dd>
258: </dl></dd>
259: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
260: <dd><dl>
261: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
262: <dd><dl>
263: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
264: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
265: </dl></dd>
266: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
267: <dd><dl>
1.128 wiz 268: <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 269: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
270: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
271: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
272: </dl></dd>
273: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
274: <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>
275: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
276: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
277: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
278: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
279: <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>
280: </dl></dd>
281: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
282: <dd><dl>
283: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 284: <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 285: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 286: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 287: </dl></dd>
288: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
289: <dd><dl>
290: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
291: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
292: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
293: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 294: <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 295: <dd><dl>
296: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
297: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
298: </dl></dd>
1.128 wiz 299: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
300: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
301: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
302: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
303: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
304: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
305: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
306: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
307: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
308: <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 309: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
310: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
311: </dl></dd>
312: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
315: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
316: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
317: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
318: </dl></dd>
319: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
320: <dd><dl>
321: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
322: <dd><dl>
323: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 324: <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 325: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
326: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
327: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
328: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
329: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
330: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
331: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
332: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
333: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
334: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
335: </dl></dd>
1.128 wiz 336: <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 337: <dd><dl>
338: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
339: <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>
340: </dl></dd>
1.128 wiz 341: <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 342: <dd><dl>
343: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
344: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
345: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
346: </dl></dd>
347: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
348: <dd><dl>
349: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
350: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
351: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 352: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
353: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 354: </dl></dd>
1.128 wiz 355: <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 356: <dd><dl>
357: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
358: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 359: <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 360: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
361: </dl></dd>
1.128 wiz 362: <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 363: <dd><dl>
364: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
365: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
366: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
367: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
368: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
369: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
370: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
371: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 372: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 373: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 374: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
375: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
376: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
377: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
378: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
379: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
380: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
381: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 382: emulation</a></span></dt>
1.106 rillig 383: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
384: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 385: </dl></dd>
1.106 rillig 386: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 387: </dl></dd>
1.106 rillig 388: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
389: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 390: <dd><dl>
1.106 rillig 391: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
392: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
393: <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 394: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 395: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 396: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
397: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 398: </dl></dd>
399: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
400: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
401: <dd><dl>
402: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
403: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
404: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
405: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 406: </dl></dd>
1.75 rillig 407: </dl></dd>
408: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
409: <dd><dl>
1.106 rillig 410: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 411: <dd><dl>
1.106 rillig 412: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
413: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
414: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 415: <dd><dl>
1.106 rillig 416: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
417: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 418: </dl></dd>
1.106 rillig 419: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
420: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 421: <dd><dl>
1.106 rillig 422: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
423: <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 424: </dl></dd>
1.106 rillig 425: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 426: <dd><dl>
1.128 wiz 427: <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>
428: <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 429: </dl></dd>
430: </dl></dd>
1.106 rillig 431: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 432: <dd><dl>
1.106 rillig 433: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
434: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
435: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 436: <dd><dl>
1.106 rillig 437: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
438: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 439: </dl></dd>
440: </dl></dd>
1.106 rillig 441: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 442: <dd><dl>
1.106 rillig 443: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
444: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 445: </dl></dd>
446: </dl></dd>
447: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
448: <dd><dl>
449: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
450: <dd><dl>
451: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
452: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
453: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 454: <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 455: </dl></dd>
456: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
457: </dl></dd>
458: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
459: <dd><dl>
460: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
461: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
462: </dl></dd>
1.76 rillig 463: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
464: <dd><dl>
1.128 wiz 465: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
466: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
467: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
468: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
469: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
470: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 471: source packages</a></span></dt>
472: </dl></dd>
1.75 rillig 473: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
474: <dd><dl>
1.79 rillig 475: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 476: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
477: </dl></dd>
478: </dl>
479: </div>
1.82 rillig 480: <div class="list-of-tables">
481: <p><b>List of Tables</b></p>
482: <dl>
483: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
484: </dt>
1.106 rillig 485: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 486: </dt>
1.106 rillig 487: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 488: </dt>
1.82 rillig 489: </dl>
490: </div>
1.148 ! asau 491: <div class="chapter">
! 492: <div class="titlepage"><div><div><h1 class="title">
! 493: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 494: <div class="toc">
495: <p><b>Table of Contents</b></p>
496: <dl>
497: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 498: <dd><dl>
499: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
500: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
501: </dl></dd>
1.75 rillig 502: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
503: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 504: <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 505: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
506: </dl>
507: </div>
1.148 ! asau 508: <div class="sect1">
1.75 rillig 509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
510: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 511: <p>There is a lot of software freely available for Unix-based
512: systems, which is usually available in form of the source code. Before
513: such software can be used, it needs to be configured to the local
514: system, compiled and installed, and this is exactly what The NetBSD
515: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
516: to handle binary packages, so that not every user has to build the
517: packages for himself, which is a time-costly task.</p>
1.75 rillig 518: <p>pkgsrc currently contains several thousand packages,
519: including:</p>
1.148 ! asau 520: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 521: <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 522: web server</p></li>
1.128 wiz 523: <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 524: web browser</p></li>
1.128 wiz 525: <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 526: Desktop Environment</p></li>
1.128 wiz 527: <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 528: Desktop Environment</p></li>
529: </ul></div>
530: <p>...just to name a few.</p>
531: <p>pkgsrc has built-in support for handling varying dependencies,
532: such as pthreads and X11, and extended features such as IPv6 support on
533: a range of platforms.</p>
1.148 ! asau 534: <div class="sect2">
1.82 rillig 535: <div class="titlepage"><div><div><h3 class="title">
536: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
537: <p>
538: pkgsrc provides the following key features:
539: </p>
1.148 ! asau 540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 541: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 542: and installation of binary packages. The source and latest
543: patches are retrieved from a master or mirror download site, checksum
544: verified, then built on your system. Support for binary-only
545: distributions is available for both native platforms and NetBSD
546: emulated platforms.</p></li>
1.128 wiz 547: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 548: including binaries, libraries, man pages and other
549: documentation.</p></li>
1.128 wiz 550: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82 rillig 551: are handled automatically. The configuration files of various
552: packages are handled automatically during updates, so local changes
553: are preserved.</p></li>
1.128 wiz 554: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 555: consists of highly portable code. This allows the greatest speed of
1.132 spz 556: development when porting to a new platform. This portability also
1.82 rillig 557: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
558: platforms</em></span>.</p></li>
1.128 wiz 559: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 560: international encryption requirements and build-time options for a
561: large number of packages are all set in a simple, central
562: configuration file.</p></li>
1.128 wiz 563: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 564: freely available under a BSD license, so you may extend and adapt
565: pkgsrc to your needs. Support for local packages and patches is
566: available right out of the box, so you can configure it specifically
567: for your environment.</p></li>
568: </ul></div>
1.91 rillig 569: <p>The following principles are basic to pkgsrc:</p>
1.148 ! asau 570: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 571: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 572: — That means, if a package contains bugs, it's better to find
1.91 rillig 573: them and to complain about them rather than to just install the package
574: and hope that it works. There are numerous checks in pkgsrc that try to
575: 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
576: of shell scripts), and post-installation checks (installed files,
577: references to shared libraries, script interpreters).</p></li>
1.128 wiz 578: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 579: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 580: pkgsrc has been ported to many operating systems. Care is taken that
581: packages behave the same on all platforms.</p></li>
582: </ul></div>
1.82 rillig 583: </div>
1.148 ! asau 584: <div class="sect2">
1.82 rillig 585: <div class="titlepage"><div><div><h3 class="title">
586: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
587: <p>pkgsrc consists of both a source distribution and a binary
588: distribution for these operating systems. After retrieving the required
589: source or binaries, you can be up and running with pkgsrc in just
590: minutes!</p>
1.75 rillig 591: <p>pkgsrc was derived from FreeBSD's ports system, and
592: initially developed for NetBSD only. Since then, pkgsrc has
593: grown a lot, and now supports the following platforms:</p>
1.82 rillig 594: <div class="table">
595: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 596: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 597: <colgroup>
598: <col>
599: <col>
600: </colgroup>
601: <thead><tr>
602: <th>Platform</th>
603: <th>Date Support Added</th>
604: </tr></thead>
605: <tbody>
606: <tr>
1.110 hubertf 607: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 608: <td align="center">Aug 1997</td>
609: </tr>
610: <tr>
1.110 hubertf 611: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 612: <td align="center">Mar 1999</td>
613: </tr>
614: <tr>
1.110 hubertf 615: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 616: <td align="center">Jun 1999</td>
617: </tr>
618: <tr>
619: <td>
1.110 hubertf 620: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
621: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 622: </td>
623: <td align="center">Oct 2001</td>
624: </tr>
625: <tr>
1.110 hubertf 626: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 627: <td align="center">Nov 2002</td>
628: </tr>
629: <tr>
1.110 hubertf 630: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 631: <td align="center">Nov 2002</td>
632: </tr>
633: <tr>
1.110 hubertf 634: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 635: <td align="center">Dec 2002</td>
636: </tr>
637: <tr>
638: <td>BSD/OS</td>
639: <td align="center">Dec 2003</td>
640: </tr>
641: <tr>
1.110 hubertf 642: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 643: <td align="center">Dec 2003</td>
644: </tr>
645: <tr>
646: <td>
1.110 hubertf 647: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 648: (Microsoft Windows Services for Unix)
649: </td>
650: <td align="center">Mar 2004</td>
651: </tr>
652: <tr>
1.110 hubertf 653: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 654: <td align="center">Oct 2004</td>
655: </tr>
656: <tr>
1.110 hubertf 657: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 658: <td align="center">Nov 2004</td>
659: </tr>
1.98 wiz 660: <tr>
1.110 hubertf 661: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 662: <td align="center">Apr 2007</td>
663: </tr>
1.128 wiz 664: <tr>
665: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
666: <td align="center">Sep 2010</td>
667: </tr>
1.82 rillig 668: </tbody>
1.91 rillig 669: </table></div>
1.82 rillig 670: </div>
1.91 rillig 671: <br class="table-break">
1.82 rillig 672: </div>
1.75 rillig 673: </div>
1.148 ! asau 674: <div class="sect1">
1.75 rillig 675: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
676: <a name="overview"></a>1.2. Overview</h2></div></div></div>
677: <p>This document is divided into three parts. The first,
1.110 hubertf 678: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 679: describes how one can use one of the packages in the Package
680: Collection, either by installing a precompiled binary package,
1.93 rillig 681: or by building one's own copy using the NetBSD package system.
1.110 hubertf 682: 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 683: package so it can be easily built by other NetBSD users without
684: knowing about the package's building details. The third part,
1.110 hubertf 685: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 686: is intended for those who want to understand how pkgsrc is
687: implemented.</p>
688: <p>This document is available in various formats:
1.110 hubertf 689: <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 690: </div>
1.148 ! asau 691: <div class="sect1">
1.75 rillig 692: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
693: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 694: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
695: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 696: terminology used within this document.</p>
1.148 ! asau 697: <div class="variablelist"><dl class="variablelist">
1.75 rillig 698: <dt><span class="term">Package</span></dt>
699: <dd><p>A set of files and building instructions
700: that describe what's necessary
701: to build a certain piece of software using
702: pkgsrc. Packages are traditionally stored under
1.76 rillig 703: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 704: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 705: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 706: is part of the NetBSD operating system and can be bootstrapped
707: to run on non-NetBSD operating systems as well. It handles
708: building (compiling), installing, and removing of
709: packages.</p></dd>
1.75 rillig 710: <dt><span class="term">Distfile</span></dt>
711: <dd><p>This term describes the file or files that are
712: provided by the author of the piece of software to
713: distribute his work. All the changes necessary to build on
714: NetBSD are reflected in the corresponding package. Usually
715: the distfile is in the form of a compressed tar-archive,
716: but other types are possible, too. Distfiles are usually
717: stored below
1.76 rillig 718: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 719: <dt><span class="term">Port</span></dt>
720: <dd><p>This is the term used by FreeBSD and OpenBSD people
721: for what we call a package.
1.128 wiz 722: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 723: architecture.</p></dd>
724: <dt><span class="term">Precompiled/binary package</span></dt>
725: <dd>
726: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 727: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 728: file so it can be installed on machines of the same
729: machine architecture without the need to
730: recompile. Packages are usually generated in
1.76 rillig 731: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 732: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 733: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 734: especially in the context of precompiled packages.</p>
735: </dd>
736: <dt><span class="term">Program</span></dt>
1.88 wiz 737: <dd><p>The piece of software to be installed which will be
738: constructed from all the files in the distfile by the
739: actions defined in the corresponding package.</p></dd>
1.75 rillig 740: </dl></div>
1.148 ! asau 741: <div class="sect2">
1.75 rillig 742: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 743: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 ! asau 744: <div class="variablelist"><dl class="variablelist">
1.75 rillig 745: <dt><span class="term">pkgsrc users</span></dt>
746: <dd>
747: <p>The
748: pkgsrc users are people who use the packages provided by pkgsrc.
749: Typically they are system administrators. The people using the
1.128 wiz 750: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
751: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 752: <p>There are two kinds of pkgsrc users: Some only want to
753: install pre-built binary packages. Others build the pkgsrc
754: packages from source, either for installing them directly or for
1.110 hubertf 755: 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 756: documentation.</p>
757: </dd>
758: <dt><span class="term">package maintainers</span></dt>
759: <dd><p>A
1.110 hubertf 760: 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 761: <dt><span class="term">infrastructure developers</span></dt>
762: <dd><p>These people are involved in all those files
1.76 rillig 763: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 764: 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 765: too.</p></dd>
766: </dl></div>
767: </div>
768: </div>
1.148 ! asau 769: <div class="sect1">
1.75 rillig 770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
771: <a name="typography"></a>1.4. Typography</h2></div></div></div>
772: <p>When giving examples for commands, shell prompts are used to
773: show if the command should/can be issued as root, or if
1.128 wiz 774: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.75 rillig 775: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
776: shell prompt, assuming they use the C-shell or tcsh.</p>
777: </div>
778: </div>
1.148 ! asau 779: <div class="part">
1.75 rillig 780: <div class="titlepage"><div><div><h1 class="title">
781: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
782: <div class="toc">
783: <p><b>Table of Contents</b></p>
784: <dl>
785: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
786: <dd><dl>
787: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
788: <dd><dl>
789: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.128 wiz 790: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 791: </dl></dd>
792: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
793: <dd><dl>
794: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
795: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
796: </dl></dd>
797: </dl></dd>
798: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
799: <dd><dl>
1.82 rillig 800: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
801: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
802: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
803: <dd><dl>
804: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
805: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
806: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
807: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
808: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
809: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
810: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 811: </dl></dd>
812: </dl></dd>
813: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
814: <dd><dl>
815: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
816: <dd><dl>
817: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
818: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 819: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
820: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
821: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
822: <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>
823: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
824: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 825: </dl></dd>
826: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
827: <dd><dl>
828: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
829: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
830: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
831: </dl></dd>
832: </dl></dd>
833: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
834: <dd><dl>
835: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
836: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 837: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 838: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 839: <dd><dl>
1.103 wiz 840: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 841: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
842: <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 843: </dl></dd>
1.103 wiz 844: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
845: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 846: </dl></dd>
847: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
848: <dd><dl>
849: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
850: <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 851: </dl></dd>
852: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
853: builds)</a></span></dt>
1.75 rillig 854: <dd><dl>
1.106 rillig 855: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
856: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
857: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
858: <dd><dl>
859: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
860: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
861: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
862: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
863: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
864: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
865: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
866: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
867: </dl></dd>
868: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 869: <dd><dl>
870: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
871: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
872: </dl></dd>
1.106 rillig 873: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
874: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
875: </dl></dd>
876: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
877: <dd><dl>
1.128 wiz 878: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
879: <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 880: </dl></dd>
881: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
882: <dd><dl>
883: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
884: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
885: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
886: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
887: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
888: <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>
889: <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 890: <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 891: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.128 wiz 892: <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
893: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
894: <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 895: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
896: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
897: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.128 wiz 898: <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 899: <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 900: <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 901: </dl></dd>
902: </dl>
903: </div>
1.148 ! asau 904: <div class="chapter">
1.75 rillig 905: <div class="titlepage"><div><div><h2 class="title">
906: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
907: <div class="toc">
908: <p><b>Table of Contents</b></p>
909: <dl>
910: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
911: <dd><dl>
912: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.128 wiz 913: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 914: </dl></dd>
915: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
916: <dd><dl>
917: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
918: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
919: </dl></dd>
920: </dl>
921: </div>
1.91 rillig 922: <p>Before you download and extract the files, you need to decide
923: where you want to extract them. When using pkgsrc as root user, pkgsrc
924: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
925: free to install the sources and binary packages wherever you want in
926: your filesystem, provided that the pathname does not contain white-space
927: or other characters that are interpreted specially by the shell and some
928: other programs. A safe bet is to use only letters, digits, underscores
929: and dashes.</p>
1.148 ! asau 930: <div class="sect1">
1.75 rillig 931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
932: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
933: <p>Before you download any pkgsrc files, you should decide
934: whether you want the <span class="emphasis"><em>current</em></span> branch or the
935: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
936: quarterly basis from the current branch and only gets modified
937: for security updates. The names of the stable branches are built
938: from the year and the quarter, for example
1.124 snj 939: <code class="literal">2009Q1</code>.</p>
1.75 rillig 940: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 941: want to download pkgsrc. You can get it as a tar file or via CVS.
942: Both ways are described here.</p>
1.148 ! asau 943: <div class="sect2">
1.75 rillig 944: <div class="titlepage"><div><div><h3 class="title">
945: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
946: <p>The primary download location for all pkgsrc files is
1.110 hubertf 947: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.75 rillig 948: number of subdirectories for different purposes, which are
1.110 hubertf 949: described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.75 rillig 950: <p>The tar file for the current branch is in the directory
1.110 hubertf 951: <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75 rillig 952: It is autogenerated daily.</p>
1.124 snj 953: <p>The tar file for the stable branch 2009Q1 is in the
954: directory <code class="filename">pkgsrc-2009Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2009Q1/pkgsrc-2009Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2009Q1.tar.gz</code></a>.</p>
1.112 weinem 955: <p>To download a pkgsrc stable tarball, run:</p>
956: <pre class="screen">
1.126 jakllsch 957: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz</code></strong></pre>
958: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 959: stable branch to be downloaded, for example,
1.128 wiz 960: <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span>.</p>
1.112 weinem 961: <p>Then, extract it with:</p>
1.126 jakllsch 962: <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 963: <p>This will create the directory <code class="filename">pkgsrc/</code>
964: in <code class="filename">/usr/</code> and all the package source will be
965: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
966: <p>To download pkgsrc-current, run:</p>
967: <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 968: </div>
1.148 ! asau 969: <div class="sect2">
1.75 rillig 970: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 971: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
972: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146 wiz 973: <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 974: </pre>
975: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
976: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span></p>
977: <p>This will create the directory <code class="filename">pkgsrc/</code>
978: in your <code class="filename">/usr/</code> directory and all the package source
979: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
980: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 981: <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 982: </pre>
1.136 dholland 983: <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 984: <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 985: <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 986: </pre>
987: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
988: For Bourne shells, you can set it in your <code class="filename">.profile</code>
989: or better globally in <code class="filename">/etc/profile</code>:</p>
990: <pre class="programlisting">
991: # set CVS remote shell command
992: CVS_RSH=ssh
993: export CVS_RSH
994: </pre>
995: <p>By default, CVS doesn't do things like most people would expect it to do.
996: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
997: in your home directory and saving the following lines to it.
998: This file will save you lots of headache and some bug reports, so we strongly recommend it.
999: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1000: <pre class="programlisting">
1001: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1002: cvs -q -z2
1.101 rillig 1003: checkout -P
1.103 wiz 1004: update -dP
1005: diff -upN
1.101 rillig 1006: rdiff -u
1.128 wiz 1007: release -d
1.101 rillig 1008: </pre>
1.75 rillig 1009: </div>
1010: </div>
1.148 ! asau 1011: <div class="sect1">
1.75 rillig 1012: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1013: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1014: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1015: (which also works if you have first installed it via a tar
1016: file). It saves bandwidth and hard disk activity, compared to
1017: downloading the tar file again.</p>
1.148 ! asau 1018: <div class="sect2">
1.75 rillig 1019: <div class="titlepage"><div><div><h3 class="title">
1020: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148 ! asau 1021: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1022: <h3 class="title">Warning</h3>
1.77 rillig 1023: <p>When updating from a tar file, you first need to
1024: completely remove the old pkgsrc directory. Otherwise those
1025: files that have been removed from pkgsrc in the mean time will
1026: not be removed on your local disk, resulting in inconsistencies.
1027: When removing the old files, any changes that you have done to
1028: the pkgsrc files will be lost after updating. Therefore updating
1029: via CVS is strongly recommended.</p>
1.75 rillig 1030: </div>
1.82 rillig 1031: <p>Note that by default the distfiles and the binary packages
1032: are saved in the pkgsrc tree, so don't forget to rescue them
1033: before updating. You can also configure pkgsrc to use other than
1034: the default directories by setting the
1035: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1036: 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 1037: <p>To update pkgsrc from a tar file, download the tar file as
1038: explained above. Then, make sure that you have not made any
1039: changes to the files in the pkgsrc directory. Remove the pkgsrc
1040: directory and extract the new tar file. Done.</p>
1041: </div>
1.148 ! asau 1042: <div class="sect2">
1.75 rillig 1043: <div class="titlepage"><div><div><h3 class="title">
1044: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132 spz 1045: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1046: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1047: </pre>
1048: <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>
1049: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1050: </pre>
1.148 ! asau 1051: <div class="sect3">
1.75 rillig 1052: <div class="titlepage"><div><div><h4 class="title">
1053: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1054: <p>When updating pkgsrc, the CVS program keeps track of the
1055: branch you selected. But if you, for whatever reason, want to
1056: switch from the stable branch to the current one, you can do it
1.128 wiz 1057: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1058: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1059: back to the stable branch, add the
1.128 wiz 1060: <span class="quote">“<span class="quote">-rpkgsrc-2009Q3</span>”</span> option.</p>
1.75 rillig 1061: </div>
1.148 ! asau 1062: <div class="sect3">
1.75 rillig 1063: <div class="titlepage"><div><div><h4 class="title">
1064: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1065: <p>When you update pkgsrc, the CVS program will only touch
1066: those files that are registered in the CVS repository. That
1067: means that any packages that you created on your own will stay
1068: unmodified. If you change files that are managed by CVS, later
1069: updates will try to merge your changes with those that have been
1070: done by others. See the CVS manual, chapter
1.128 wiz 1071: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1072: </div>
1073: </div>
1074: </div>
1075: </div>
1.148 ! asau 1076: <div class="chapter">
1.75 rillig 1077: <div class="titlepage"><div><div><h2 class="title">
1078: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1079: <div class="toc">
1080: <p><b>Table of Contents</b></p>
1081: <dl>
1.82 rillig 1082: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1083: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1084: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1085: <dd><dl>
1086: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1087: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1088: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1089: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1090: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1091: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1092: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1093: </dl></dd>
1094: </dl>
1095: </div>
1.148 ! asau 1096: <div class="sect1">
1.75 rillig 1097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1098: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1099: <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 1100: </div>
1.148 ! asau 1101: <div class="sect1">
1.82 rillig 1102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1103: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1104: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1105: <pre class="screen">
1106: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1107: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1108: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1109: </pre>
1.110 hubertf 1110: <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.87 wiz 1111: pkgsrc before bootstrapping. The given
1.110 hubertf 1112: <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.87 wiz 1113: <code class="filename">/usr/pkg</code> for the
1114: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1115: and <code class="filename">/var/db/pkg</code> for the package database
1116: directory where pkgsrc will do its internal bookkeeping.
1117: However, these can also be set using command-line
1118: arguments.</p>
1.148 ! asau 1119: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1120: <h3 class="title">Note</h3>
1.110 hubertf 1121: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1122: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1123: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1124: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1125: </div>
1126: </div>
1.148 ! asau 1127: <div class="sect1">
1.75 rillig 1128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1129: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1130: <p>Here are some platform-specific notes you should be aware of.</p>
1.148 ! asau 1131: <div class="sect2">
1.75 rillig 1132: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1133: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.148 ! asau 1134: <p>Darwin 5.x and up are supported.</p>
! 1135: <p>Before you start, you need to download and install
! 1136: the Mac OS X Developer Tools from Apple's Developer Connection.
! 1137: This requires (free) membership. See
1.126 jakllsch 1138: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148 ! asau 1139: for details. Also, make sure you install X11 (an optional
! 1140: package included with the Developer Tools) if you intend
! 1141: to build packages that use the X11 Window System.
! 1142: (If you don't want or need the full Xcode GUI,
! 1143: download and install Command Line Tools for Xcode.)</p>
1.75 rillig 1144: </div>
1.148 ! asau 1145: <div class="sect2">
1.75 rillig 1146: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1147: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.136 dholland 1148: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87 wiz 1149: other versions may work.</p>
1.75 rillig 1150: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1151: with the FreeBSD userland tools. There are several steps:</p>
1.128 wiz 1152: <div class="orderedlist"><ol class="orderedlist" type="1">
1153: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 1154: <code class="filename">/var/db/pkg</code>. It is therefore
1155: recommended that you choose a different location (e.g.
1156: <code class="filename">/usr/pkgdb</code>) by
1157: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1158: <li class="listitem">
1.75 rillig 1159: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1160: good idea to move them out of the way to avoid confusion, e.g.</p>
1161: <pre class="screen">
1162: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1163: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1164: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1165: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1166: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1167: </pre>
1.75 rillig 1168: </li>
1.128 wiz 1169: <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 1170: <code class="filename">/etc/mk.conf.example</code> file
1171: when you use the bootstrap script.</p></li>
1.75 rillig 1172: </ol></div>
1173: </div>
1.148 ! asau 1174: <div class="sect2">
1.75 rillig 1175: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1176: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1177: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1178: providing a Unix-like environment with a tighter kernel integration than
1179: available with Cygwin. It is part of the Windows Services for Unix
1180: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1181: (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 1182: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1183: are not officially supported. (The main difference in 3.0/3.1 is lack
1184: of pthreads, but other parts of libc may also be lacking.)</p>
1.129 wiz 1185: <p>Services for Unix Applications (aka SUA) is an integrated
1186: component of Windows Server 2003 R2 (5.2), Windows Vista and
1187: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1188: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1189: 6.1 (64bit) subsystems have been tested. Other versions may
1190: work as well. The Interix 5.x subsystem has not yet been tested
1191: with pkgsrc.</p>
1.148 ! asau 1192: <div class="sect3">
1.75 rillig 1193: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1194: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1195: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1196: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148 ! asau 1197: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1198: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1199: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1200: <li class="listitem"><p>Remote Connectivity</p></li>
1201: <li class="listitem"><p>Interix SDK</p></li>
1.75 rillig 1202: </ul></div>
1203: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1204: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1205: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1206: pkgsrc (or from a binary package).</p>
1.75 rillig 1207: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1208: not need to be installed, but Remote Connectivity itself should be
1209: installed in order to have a working inetd.</p>
1.75 rillig 1210: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1211: behavior for Interix programs, and whether to make pathnames default to
1212: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1213: enabled. (Without case-sensitivity, a large number of packages including
1214: perl will not build.)</p>
1.75 rillig 1215: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1216: works (via the Data Execution Prevention feature). In order to use
1217: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1218: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1219: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1220: support contract; however, Debian Interix Port has made most Interix
1221: 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 1222: <p>In addition to the hotfix noted above, it may be necessary to
1223: disable Data Execution Prevention entirely to make Interix functional.
1224: This may happen only with certain types of CPUs; the cause is not fully
1225: understood at this time. If gcc or other applications still segfault
1226: repeatedly after installing one of the hotfixes note above, the
1227: following option can be added to the appropriate "boot.ini" line on the
1228: Windows boot drive: /NoExecute=AlwaysOff
1229: (WARNING, this will disable DEP completely, which may be a security
1230: risk if applications are often run as a user in the Administrators
1231: group!)</p>
1.75 rillig 1232: </div>
1.148 ! asau 1233: <div class="sect3">
1.75 rillig 1234: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1235: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75 rillig 1236: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1237: with pkgsrc, note the following things.</p>
1.148 ! asau 1238: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1239: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1240: Windows Services for UNIX, then click Change. In the installer, choose
1241: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 wiz 1242: <li class="listitem">
1.75 rillig 1243: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1244: change the following registry key:</p>
1.75 rillig 1245: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1246: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1247: </li>
1.128 wiz 1248: <li class="listitem">
1.75 rillig 1249: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1250: following registry key:</p>
1.75 rillig 1251: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1252: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1253: </li>
1254: </ul></div>
1255: </div>
1.148 ! asau 1256: <div class="sect3">
1.75 rillig 1257: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1258: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1259: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1260: running "pkg_add") must be a member of the local Administrators
1261: group. Such a user must also be used to run the bootstrap. This is
1262: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1263: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1264: automatically complain if this is not the case. This ensures that
1265: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1266: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1267: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1268: NOT be used in conjunction with pkgsrc. If you choose to use them at
1269: the same time as the pkgsrc packages, ensure that you use the proper
1270: pkg_* tools for each type of binary package.</p>
1.75 rillig 1271: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1272: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1273: don't have a termcap/terminfo entry for it, but the following .termcap
1274: entry provides adequate emulation in most cases:</p>
1.75 rillig 1275: <pre class="programlisting">
1.100 rillig 1276: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1277: </pre>
1.75 rillig 1278: </div>
1.148 ! asau 1279: <div class="sect3">
1.75 rillig 1280: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1281: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1282: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1283: for a full Unix-like platform, it has some drawbacks that should
1284: be noted for those desiring to make the most of Interix.</p>
1.148 ! asau 1285: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1286: <li class="listitem">
1.75 rillig 1287: <p><span class="strong"><strong>X11:</strong></span></p>
1288: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1289: and can run X11 based applications, but it does
1290: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1291: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1292: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1293: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1294: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1295: and the free X11 server included with
1.110 hubertf 1296: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1297: </li>
1.128 wiz 1298: <li class="listitem">
1.75 rillig 1299: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1300: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1301: Win32 applications, it does not currently support various X11
1302: protocol extensions for acceleration (such as MIT-SHM or DGA).
1303: Most interactive applications to a local X server will run
1304: reasonably fast, but full motion video and other graphics
1305: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1306: </li>
1.128 wiz 1307: <li class="listitem">
1.75 rillig 1308: <p><span class="strong"><strong>Audio:</strong></span></p>
1309: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1310: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1311: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1312: <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 1313: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1314: server component. To output audio via an Interix host, the
1.91 rillig 1315: <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 1316: must also be installed.</p>
1.75 rillig 1317: </li>
1.128 wiz 1318: <li class="listitem">
1.75 rillig 1319: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1320: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1321: is not currently possible to access CD/DVD drives, USB devices,
1322: or SCSI devices through non-filesystem means. Among other things,
1323: this makes it impossible to use Interix directly for CD/DVD
1324: burning.</p>
1.75 rillig 1325: </li>
1.128 wiz 1326: <li class="listitem">
1.75 rillig 1327: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1328: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1329: drives are also not directly accessible in Interix. However,
1330: support is in work to make tape drive access possible by using
1331: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1332: esound server).</p>
1.75 rillig 1333: </li>
1334: </ul></div>
1335: </div>
1.148 ! asau 1336: <div class="sect3">
1.75 rillig 1337: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1338: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1339: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1340: Windows system; any member of the local Administrators group will
1341: suffice. However, some packages currently assume that the user
1342: named "root" is the privileged user. To accommodate these, you
1343: may create such a user; make sure it is in the local group
1344: Administrators (or your language equivalent).</p>
1.110 hubertf 1345: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1346: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1347: time being, install packages as the local Administrator (or
1348: your language equivalent), or run the following command after
1349: installing a package to work around the issue:</p>
1.75 rillig 1350: <pre class="screen">
1.87 wiz 1351: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1352: </pre>
1.75 rillig 1353: </div>
1354: </div>
1.148 ! asau 1355: <div class="sect2">
1.75 rillig 1356: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1357: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1358: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1359: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1360: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1361: 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 1362: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.136 dholland 1363: 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 1364: etc.</p>
1.86 schwarz 1365: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1366: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1367: you start out using "abi=n32", that's what all your packages will be built
1368: with.</p>
1369: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1370: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1371: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1372: try to link n32 object files with lib64 or vice versa. Check your
1373: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1374: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1375: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1376: as it appears that IRIX linker occasionally runs into issues when trying to
1377: link over a network-mounted file system.</p>
1.75 rillig 1378: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1379: as imake(1), but you may want to set some options depending on your local
1380: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1381: course, your compiler's man pages for details.</p>
1.75 rillig 1382: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1383:
1.87 wiz 1384: </p>
1.75 rillig 1385: <pre class="programlisting">
1.100 rillig 1386: PKGSRC_COMPILER= mipspro
1.87 wiz 1387: </pre>
1.75 rillig 1388: <p>
1.1 grant 1389:
1.110 hubertf 1390: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1391: are using gcc and may end up passing invalid flags to the compiler. Note that
1392: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1393: default.</p>
1.75 rillig 1394: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1395: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1396: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1397: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1398: '--preserve-path' flag.</p>
1.75 rillig 1399: </div>
1.148 ! asau 1400: <div class="sect2">
1.75 rillig 1401: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1402: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1403: <p>Some versions of Linux (for example Debian GNU/Linux) need
1404: either libtermcap or libcurses (libncurses). Installing the
1405: distributions libncurses-dev package (or equivalent) should fix
1406: the problem.</p>
1407: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1408: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1409: i386 have been tested.</p>
1.75 rillig 1410: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1411: directory:</p>
1.75 rillig 1412: <pre class="programlisting">
1.138 wiz 1413: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87 wiz 1414: </pre>
1.148 ! asau 1415: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1416: <h3 class="title">Note</h3>
1.138 wiz 1417: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1418: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1419: <p>For icc 10.1 neither of these appears to be necessary.</p>
1420: </div>
1421: <p>Use a value for ICCBASE that corresponds to the directory
1422: where icc is installed. After bootstrapping, set
1423: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137 wiz 1424: <pre class="programlisting">
1.138 wiz 1425: ICCBASE= /opt/intel/cc/10.1.008
1.87 wiz 1426: </pre>
1.138 wiz 1427: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1428: <code class="filename">/opt/intel_cc_80</code>. This is the default
1429: install directory for icc 8.0. If you are using a more recent
1430: version, be sure to set the correct path explicitly.
1431: </p>
1.75 rillig 1432: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1433: provided by icc, so binaries can be run on other systems which do not
1434: have the shared libraries installed.</p>
1435: <p>Libtool, however, extracts a list of libraries from the
1.136 dholland 1436: <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 1437: records it, throwing away the -Bstatic and -Bdynamic options
1438: interspersed between the libraries. This means that
1439: libtool-linked C++ shared libraries will have a runtime
1440: dependency on the icc libraries until this is fixed in
1441: libtool.</p>
1.75 rillig 1442: </div>
1.148 ! asau 1443: <div class="sect2">
1.75 rillig 1444: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1445: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.136 dholland 1446: <p>OpenBSD 5.1 has been tested and supported,
1447: other versions may work.</p>
1.75 rillig 1448: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1449: with the OpenBSD userland tools. There are several steps:</p>
1.128 wiz 1450: <div class="orderedlist"><ol class="orderedlist" type="1">
1451: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 1452: <code class="filename">/var/db/pkg</code>. It is therefore
1453: recommended that you choose a different location (e.g.
1454: <code class="filename">/usr/pkgdb</code>) by
1455: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1456: <li class="listitem">
1.75 rillig 1457: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1458: good idea to move them out of the way to avoid confusion, e.g.</p>
1459: <pre class="screen">
1460: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1461: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1462: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1463: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1464: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1465: </pre>
1.75 rillig 1466: </li>
1.128 wiz 1467: <li class="listitem">
1.110 hubertf 1468: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1469: <code class="filename">/etc/mk.conf.example</code> file
1470: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1471: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1472: as well. You can work around this by enclosing all the pkgsrc-specific parts
1473: of the file with:</p>
1474: <pre class="programlisting">
1.100 rillig 1475: .ifdef BSD_PKG_MK
1476: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1477: .else
1478: # OpenBSD stuff
1479: .endif
1.87 wiz 1480: </pre>
1.75 rillig 1481: </li>
1482: </ol></div>
1483: </div>
1.148 ! asau 1484: <div class="sect2">
1.75 rillig 1485: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1486: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.142 wiz 1487: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1488: You will need a working C compiler. Both gcc 4.5.3 and
1.87 wiz 1489: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1490: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1491: process and to build packages.</p>
1.148 ! asau 1492: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1493: <li class="listitem"><p>SUNWsprot</p></li>
1494: <li class="listitem"><p>SUNWarc</p></li>
1495: <li class="listitem"><p>SUNWbtool</p></li>
1496: <li class="listitem"><p>SUNWtoo</p></li>
1497: <li class="listitem"><p>SUNWlibm</p></li>
1.75 rillig 1498: </ul></div>
1.78 rillig 1499: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1500: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1501: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1502: your $prefix are in your <code class="varname">PATH</code>. This includes
1503: <code class="filename">/usr/ccs/{bin,lib}</code>
1504: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148 ! asau 1505: <div class="sect3">
1.75 rillig 1506: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1507: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1508: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1509: for building all packages.</p>
1.75 rillig 1510: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1511: then either build gcc from
1.142 wiz 1512: <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 1513: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1514: <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 1515: </div>
1.148 ! asau 1516: <div class="sect3">
1.75 rillig 1517: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1518: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1519: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1520: 5.0)</p>
1.148 ! asau 1521: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1522: <li class="listitem"><p>SPROcc
1.87 wiz 1523: - Sun WorkShop Compiler C 5.0</p></li>
1.128 wiz 1524: <li class="listitem"><p>SPROcpl
1.87 wiz 1525: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 wiz 1526: <li class="listitem"><p>SPROild
1.87 wiz 1527: - Sun WorkShop Incremental Linker</p></li>
1.128 wiz 1528: <li class="listitem"><p>SPROlang
1.87 wiz 1529: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1530: </ul></div>
1.96 rillig 1531: <p>You should set the following variables in your
1.110 hubertf 1532: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1533: <pre class="programlisting">
1.100 rillig 1534: CC= cc
1535: CXX= CC
1536: CPP= cc -E
1537: CXXCPP= CC -E
1.96 rillig 1538: </pre>
1.148 ! asau 1539: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1540: <h3 class="title">Note</h3>
1541: <p>The <code class="varname">CPP</code> setting might break some
1542: packages that use the C preprocessor for processing things other
1543: than C source code.</p>
1544: </div>
1.75 rillig 1545: </div>
1.148 ! asau 1546: <div class="sect3">
1.75 rillig 1547: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1548: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1549: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1550: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1551: <pre class="programlisting">
1.100 rillig 1552: PKGSRC_COMPILER= sunpro
1553: ABI= 64
1.96 rillig 1554: </pre>
1.148 ! asau 1555: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1556: <h3 class="title">Note</h3>
1557: <p>This setting has been tested for the SPARC
1558: architecture. Intel and AMD machines need some more
1559: work.</p>
1560: </div>
1.75 rillig 1561: </div>
1.148 ! asau 1562: <div class="sect3">
1.75 rillig 1563: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1564: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110 hubertf 1565: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1566: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1567: The workaround is to use another shell for the configure
1.91 rillig 1568: 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 1569: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1570: <pre class="programlisting">
1.100 rillig 1571: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1572: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1573: </pre>
1.91 rillig 1574: <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 1575: </div>
1576: </div>
1577: </div>
1578: </div>
1.148 ! asau 1579: <div class="chapter">
1.75 rillig 1580: <div class="titlepage"><div><div><h2 class="title">
1581: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1582: <div class="toc">
1583: <p><b>Table of Contents</b></p>
1584: <dl>
1585: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1586: <dd><dl>
1587: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1588: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1589: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1590: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1591: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1592: <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>
1593: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1594: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1595: </dl></dd>
1596: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1597: <dd><dl>
1598: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1599: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1600: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1601: </dl></dd>
1602: </dl>
1603: </div>
1604: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1605: is to only install the package tools and to use binary packages
1.128 wiz 1606: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1607: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1608: of pkgsrc, too. Then you are able to build your own packages,
1609: and you can still use binary packages from someone else.</p>
1.148 ! asau 1610: <div class="sect1">
1.75 rillig 1611: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1612: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1613: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1614: server and its mirrors, there are collections of binary packages,
1615: ready to be installed. These binary packages have been built using the
1616: default settings for the directories, that is:</p>
1.148 ! asau 1617: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1618: <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>
1619: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1620: <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 1621: </ul></div>
1622: <p>If you cannot use these directories for whatever reasons (maybe
1623: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1624: 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 1625: <div class="sect2">
1.75 rillig 1626: <div class="titlepage"><div><div><h3 class="title">
1627: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1628: <p>To install binary packages, you first need to know from where
1629: to get them. The first place where you should look is on the main
1.110 hubertf 1630: 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 1631: <p>This directory contains binary packages for multiple
1632: platforms. First, select your operating system. (Ignore the
1633: directories with version numbers attached to it, they just exist for
1634: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1635: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1636: <p>In this directory, you often find a file called
1637: <code class="filename">bootstrap.tar.gz</code> which contains the package
1638: management tools. If the file is missing, it is likely that your
1639: operating system already provides those tools. Download the file and
1640: extract it in the <code class="filename">/</code> directory. It will create
1641: the directories <code class="filename">/usr/pkg</code> (containing the tools
1642: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1643: (the database of installed packages).</p>
1.75 rillig 1644: </div>
1.148 ! asau 1645: <div class="sect2">
1.75 rillig 1646: <div class="titlepage"><div><div><h3 class="title">
1647: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1648: <p>In the directory from the last section, there is a
1649: subdirectory called <code class="filename">All</code>, which contains all the
1650: binary packages that are available for the platform, excluding those
1651: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1652: medium you are using).</p>
1.109 rillig 1653: <p>To install packages directly from an FTP or HTTP server, run
1654: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1655: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1656: <pre class="screen">
1657: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1658: <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>
1659: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1660: </pre>
1661: <p>Instead of URLs, you can also use local paths, for example if
1662: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1663: repository. If you want to install packages from multiple sources,
1664: you can separate them by a semicolon in
1665: <code class="varname">PKG_PATH</code>.</p>
1666: <p>After these preparations, installing a package is very
1667: easy:</p>
1668: <pre class="screen">
1669: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1670: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1671: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1672: </pre>
1.75 rillig 1673: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1674: package in question will be installed, too, assuming they are
1675: present where you install from.</p>
1.128 wiz 1676: <p>Adding packages might install vulnerable packages.
1677: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1678: regularly, especially after installing new packages, and verify
1679: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1680: <p>After you've installed packages, be sure to have
1.88 wiz 1681: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1682: <code class="varname">PATH</code> so you can actually start the just
1683: installed program.</p>
1.75 rillig 1684: </div>
1.148 ! asau 1685: <div class="sect2">
1.75 rillig 1686: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1687: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1688: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1689: installed from source code or from a binary package. The
1.110 hubertf 1690: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1691: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1692: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1693: name can be given with or without version number. Wildcards can
1694: also be used to deinstall a set of packages, for example
1695: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1696: so that the shell does not expand them before
1697: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1698: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1699: removes all the packages that require the package in question
1700: and then removes the package itself. For example:
1.82 rillig 1701:
1.88 wiz 1702: </p>
1.82 rillig 1703: <pre class="screen">
1.88 wiz 1704: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1705: </pre>
1.82 rillig 1706: <p>
1707:
1.88 wiz 1708: will remove jpeg and all the packages that used it; this allows
1709: upgrading the jpeg package.</p>
1.82 rillig 1710: </div>
1.148 ! asau 1711: <div class="sect2">
1.82 rillig 1712: <div class="titlepage"><div><div><h3 class="title">
1713: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1714: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1715: installed packages or binary package files.</p>
1.82 rillig 1716: </div>
1.148 ! asau 1717: <div class="sect2">
1.82 rillig 1718: <div class="titlepage"><div><div><h3 class="title">
1719: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1720: <p>
1.88 wiz 1721: The NetBSD Security-Officer and Packages Groups maintain a list of
1722: known security vulnerabilities to packages which are (or have been)
1723: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1724: 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 1725: </p>
1.82 rillig 1726: <p>
1.125 wiz 1727: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1728: this list can be downloaded
1729: automatically, and a security audit of all packages installed on a system
1730: can take place.
1731: </p>
1.82 rillig 1732: <p>
1.125 wiz 1733: There are two components to auditing. The first
1734: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1735: is for downloading
1.88 wiz 1736: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1737: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1738: installed packages are vulnerable. If a package is vulnerable, you
1739: will see output similar to the following:
1740: </p>
1.82 rillig 1741: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1742: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1743: <p>
1.125 wiz 1744: You may wish to have the
1.110 hubertf 1745: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1746: file downloaded daily so that
1747: it remains current. This may be done by adding an appropriate entry
1.136 dholland 1748: 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 1749: </p>
1750: <pre class="screen">
1751: # download vulnerabilities file
1752: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1753: </pre>
1754: <p>
1755: will update the vulnerability list every day at 3AM. You may wish to do
1756: this more often than once a day.
1757:
1758: In addition, you may wish to run the package audit from the daily
1759: security script. This may be accomplished by adding the following
1760: line to <code class="filename">/etc/security.local</code>:
1761: </p>
1762: <pre class="screen">
1763: /usr/sbin/pkg_admin audit
1764: </pre>
1765: <p>
1.88 wiz 1766: </p>
1.82 rillig 1767: </div>
1.148 ! asau 1768: <div class="sect2">
1.82 rillig 1769: <div class="titlepage"><div><div><h3 class="title">
1770: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1771: <p>
1.112 weinem 1772: 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 1773: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1774: argument to check if your packages are up-to-date, e.g.
1775: </p>
1776: <pre class="screen">
1777: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1778: ...
1.88 wiz 1779: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1780: </pre>
1.110 hubertf 1781: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1782: package on your system and rebuild any dependencies.
1783: </p>
1.82 rillig 1784: </div>
1.148 ! asau 1785: <div class="sect2">
1.82 rillig 1786: <div class="titlepage"><div><div><h3 class="title">
1787: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1788: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1789: administrative functions on the package system.</p>
1.82 rillig 1790: </div>
1.148 ! asau 1791: <div class="sect2">
1.82 rillig 1792: <div class="titlepage"><div><div><h3 class="title">
1793: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1794: <p>Please pay very careful attention to the warnings
1.136 dholland 1795: 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 1796: inherent dangers of installing binary packages which you did
1797: not create yourself, and the security holes that can be
1798: introduced onto your system by indiscriminate adding of such
1799: files.</p>
1.75 rillig 1800: <p>The same warning of course applies to every package you
1.88 wiz 1801: install from source when you haven't completely read and
1802: understood the source code of the package, the compiler that
1803: is used to build the package and all the other tools that are
1804: involved.</p>
1.75 rillig 1805: </div>
1806: </div>
1.148 ! asau 1807: <div class="sect1">
1.75 rillig 1808: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1809: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1810: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1811: directory now contains a set of packages, organized into
1812: categories. You can browse the online index of packages, or run
1.110 hubertf 1813: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1814: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 1815: 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 1816: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1817: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1818: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1819: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1820: different <code class="varname">LOCALBASE</code> definitions on the same
1821: system (inside a chroot is an exception). </p>
1822: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1823: 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 1824: instructions how to create your own packages.</p>
1.148 ! asau 1825: <div class="sect2">
1.75 rillig 1826: <div class="titlepage"><div><div><h3 class="title">
1827: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1828: <p>To build packages from source, you need a working C
1.88 wiz 1829: compiler. On NetBSD, you need to install the
1.128 wiz 1830: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1831: sets. If you want to build X11-related packages, the
1.128 wiz 1832: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1833: sets are required, too.</p>
1.75 rillig 1834: </div>
1.148 ! asau 1835: <div class="sect2">
1.75 rillig 1836: <div class="titlepage"><div><div><h3 class="title">
1837: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1838: <p>The first step for building a package is downloading the
1.88 wiz 1839: distfiles (i.e. the unmodified source). If they have not yet been
1840: downloaded, pkgsrc will fetch them automatically.</p>
1841: <p>If you have all files that you need in the
1842: <code class="filename">distfiles</code> directory,
1843: you don't need to connect. If the distfiles are on CD-ROM, you can
1844: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1845: </p>
1.82 rillig 1846: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1847: <p>
1.110 hubertf 1848: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1849: <p>By default a list of distribution sites will be randomly
1850: intermixed to prevent huge load on servers which holding popular
1851: packages (for example, SourceForge.net mirrors). Thus, every
1852: time when you need to fetch yet another distfile all the mirrors
1853: will be tried in new (random) order. You can turn this feature
1854: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1855: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1856: <p>You can overwrite some of the major distribution sites to
1857: fit to sites that are close to your own. By setting one or two
1858: variables you can modify the order in which the master sites are
1859: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1860: delimited list of domain suffixes.
1861: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1862: contains a whitespace delimited list of regular expressions. It
1863: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1864: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1865: some examples. This may save some of your bandwidth and
1866: time.</p>
1.75 rillig 1867: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1868: if you want to keep the settings, by editing the
1.110 hubertf 1869: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1870: and adding the definitions there.</p>
1.82 rillig 1871: <p>
1.88 wiz 1872: If a package depends on many other packages (such as
1.93 rillig 1873: <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 1874: alternate between periods of
1875: downloading source, and compiling. To ensure you have all the source
1876: downloaded initially you can run the command:
1877: </p>
1.82 rillig 1878: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1879: <p>
1.88 wiz 1880: which will output and run a set of shell commands to fetch the
1881: necessary files into the <code class="filename">distfiles</code> directory. You can
1882: also choose to download the files manually.
1883: </p>
1.75 rillig 1884: </div>
1.148 ! asau 1885: <div class="sect2">
1.75 rillig 1886: <div class="titlepage"><div><div><h3 class="title">
1887: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1888: <p>
1.88 wiz 1889: Once the software has downloaded, any patches will be applied, then it
1890: will be compiled for you. This may take some time depending on your
1891: computer, and how many other packages the software depends on and their
1892: compile time.
1893: </p>
1.148 ! asau 1894: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1895: <h3 class="title">Note</h3>
1896: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1897: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1898: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1899: </div>
1.87 wiz 1900: <p>For example, type</p>
1.88 wiz 1901: <pre class="screen">
1902: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1903: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1904: </pre>
1.75 rillig 1905: <p>at the shell prompt to build the various components of the
1.88 wiz 1906: package.</p>
1.82 rillig 1907: <p>The next stage is to actually install the newly compiled
1.88 wiz 1908: program onto your system. Do this by entering:
1.82 rillig 1909:
1.88 wiz 1910: </p>
1.82 rillig 1911: <pre class="screen">
1.88 wiz 1912: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1913: </pre>
1.82 rillig 1914: <p>
1915:
1.88 wiz 1916: while you are still in the directory for whatever package you
1917: are installing.</p>
1.82 rillig 1918: <p>Installing the package on your system may require you to
1.88 wiz 1919: be root. However, pkgsrc has a
1920: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1921: to only become root for the actual installation step.</p>
1.82 rillig 1922: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1923: You can now enter:
1.82 rillig 1924:
1.88 wiz 1925: </p>
1.82 rillig 1926: <pre class="screen">
1.88 wiz 1927: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1928: </pre>
1.82 rillig 1929: <p>
1930:
1.88 wiz 1931: to remove the compiled files in the work directory, as you shouldn't need
1932: them any more. If other packages were also added to your system
1933: (dependencies) to allow your program to compile, you can tidy these up
1934: also with the command:</p>
1.82 rillig 1935: <pre class="screen">
1.88 wiz 1936: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1937: </pre>
1.75 rillig 1938: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 1939: 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 1940: <p>The program is installed under the default root of the
1941: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1942: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1943: variable in your environment, and it will use that value as the
1944: root of your packages tree. So, to use
1945: <code class="filename">/usr/local</code>, set
1946: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1947: Please note that you should use a directory which is dedicated to
1948: packages and not shared with other programs (i.e., do not try and
1949: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1950: to add any of your own files or directories (such as
1951: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1952: <code class="filename">pkgsrc/</code>) below the
1953: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1954: conflicts between programs and other files installed by the
1955: package system and whatever else may have been installed
1956: there.</p>
1.110 hubertf 1957: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1958: alter some configuration options at build time. Have a look at
1959: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1960: of what will be set there by default. Environment variables such
1961: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1962: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1963: set them each time you want to use pkgsrc.</p>
1.128 wiz 1964: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1965: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1966: or being installed. This may be for debugging purposes, or out of
1967: simple curiosity. A number of utility values have been added to
1968: help with this.</p>
1.128 wiz 1969: <div class="orderedlist"><ol class="orderedlist" type="1">
1970: <li class="listitem">
1.136 dholland 1971: <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 1972: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1973: information will be displayed. For example,</p>
1.75 rillig 1974: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1975: <p>will show all the commands that are invoked, up to and
1.128 wiz 1976: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1977: </li>
1.128 wiz 1978: <li class="listitem">
1.136 dholland 1979: <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 1980: definition, then the <code class="varname">VARNAME</code> definition
1981: should be used, in conjunction with the show-var
1.136 dholland 1982: 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 1983: variable <code class="varname">LOCALBASE</code>:</p>
1984: <pre class="screen">
1985: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1986: /usr/pkg
1987: <code class="prompt">%</code>
1.88 wiz 1988: </pre>
1.75 rillig 1989: </li>
1990: </ol></div>
1991: <p>If you want to install a binary package that you've either
1.88 wiz 1992: created yourself (see next section), that you put into
1993: pkgsrc/packages manually or that is located on a remote FTP
1994: server, you can use the "bin-install" target. This target will
1.136 dholland 1995: 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 1996: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1997: sites searched is kept in the variable
1998: <code class="varname">BINPKG_SITES</code>, which defaults to
1.136 dholland 1999: 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 2000: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2001: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2002: details.</p>
2003: <p>A final word of warning: If you set up a system that has a
2004: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2005: set that before any packages are installed, as you cannot use
2006: several directories for the same purpose. Doing so will result in
2007: pkgsrc not being able to properly detect your installed packages,
2008: and fail miserably. Note also that precompiled binary packages are
2009: usually built with the default <code class="varname">LOCALBASE</code> of
2010: <code class="filename">/usr/pkg</code>, and that you should
2011: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2012: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2013: </div>
2014: </div>
2015: </div>
1.148 ! asau 2016: <div class="chapter">
1.75 rillig 2017: <div class="titlepage"><div><div><h2 class="title">
2018: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2019: <div class="toc">
2020: <p><b>Table of Contents</b></p>
2021: <dl>
2022: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2023: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2024: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2025: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2026: <dd><dl>
1.103 wiz 2027: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 2028: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2029: <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 2030: </dl></dd>
1.103 wiz 2031: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2032: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2033: </dl>
2034: </div>
1.104 rillig 2035: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2036: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2037: that file depends on the installation. On NetBSD, when you use
1.136 dholland 2038: <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 2039: <code class="filename">/etc/</code>. In all other cases the default location is
2040: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2041: bootstrap program to install the binary packages.</p>
2042: <p>During the bootstrap, an example configuration file is created. To
2043: use that, you have to create the directory
2044: <code class="filename">${PREFIX}/etc</code> and copy the example file
2045: there.</p>
2046: <p>The format of the configuration file is that of the usual
2047: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2048: is done by setting variables in this file. Note that you can define all
2049: kinds of variables, and no special error checking (for example for
2050: spelling mistakes) takes place, so you have to try it out to see if it
2051: works.</p>
1.148 ! asau 2052: <div class="sect1">
1.75 rillig 2053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2054: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2055: <p>In this section, you can find some variables that apply to all
1.89 rillig 2056: pkgsrc packages. A complete list of the variables that can be
2057: configured by the user is available in
2058: <code class="filename">mk/defaults/mk.conf</code>, together with some
2059: comments that describe each variable's intent.</p>
1.148 ! asau 2060: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2061: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2062: packages will be installed. The default is
1.76 rillig 2063: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2064: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 2065: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2066: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 2067: installed. The default is
1.76 rillig 2068: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 2069: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2070: X11 is installed on the system. The default is
1.76 rillig 2071: <code class="filename">/usr/X11R6</code>.</p></li>
1.128 wiz 2072: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2073: downloaded copies of the original source distributions used
2074: for building pkgsrc packages. The default is
1.76 rillig 2075: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 2076: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2077: database about installed packages is stored. The default is
2078: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 wiz 2079: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2080: If set, override the packages'
2081: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 2082: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2083: Backup location(s) for distribution files and patch files
2084: if not found locally or in
1.76 rillig 2085: <code class="filename">${MASTER_SITES}</code> or
2086: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2087: The defaults are
1.132 spz 2088: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2089: and
1.76 rillig 2090: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 2091: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2092: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2093: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 2094: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2095: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2096: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2097: List of acceptable licenses. License names are case-sensitive.
2098: Whenever you try to build a package whose license is not in this
2099: list, you will get an error message. If the license condition is
2100: simple enough, the error message will include specific
2101: instructions on how to change this variable.</p></li>
1.75 rillig 2102: </ul></div>
2103: </div>
1.148 ! asau 2104: <div class="sect1">
1.75 rillig 2105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2106: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2107: <p>XXX
2108: </p>
1.148 ! asau 2109: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2110: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2111: directory for the binary packages. The default is
1.76 rillig 2112: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 2113: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2114: The top level directory where, if defined, the separate
2115: working directories will get created, and symbolically
1.76 rillig 2116: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2117: This is useful for building packages on several
1.76 rillig 2118: architectures, then <code class="filename">${PKGSRCDIR}</code>
2119: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2120: is local to every architecture. (It should be noted that
2121: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2122: — it is an internal definition which refers to the
1.75 rillig 2123: root of the pkgsrc tree. It is possible to have many
2124: pkgsrc tree instances.)</p></li>
1.128 wiz 2125: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2126: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2127: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2128: information.</p></li>
1.128 wiz 2129: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2130: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2131: BSD-style Makefile. If this is not set,
2132: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2133: <code class="filename">/dev/null</code> to avoid picking up
2134: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 wiz 2135: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2136: By default, dependencies are only installed, and no binary
2137: package is created for them. You can set this variable to
2138: <code class="literal">package</code> to automatically create binary
2139: packages after installing dependencies.</p></li>
1.75 rillig 2140: </ul></div>
2141: </div>
1.148 ! asau 2142: <div class="sect1">
1.75 rillig 2143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2144: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.131 wiz 2145: <p>Most packages support installation into a
1.103 wiz 2146: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2147: to be built, before the actual filesystem is touched. DESTDIR
2148: support exists in two variations:</p>
1.148 ! asau 2149: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2150: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 2151: installation and packaging is still run as root.</p></li>
2152: <li class="listitem"><p>Full DESTDIR support can run the complete
2153: build, installation and packaging as normal user. Root
2154: privileges are only needed to add packages.</p></li>
2155: </ul></div>
2156: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2157: you can set
2158: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2159: so it's preferable to convert a package to DESTDIR instead.</p>
1.103 wiz 2160: <p>DESTDIR support changes the behaviour of various targets
2161: slightly. To install a package after building it, use
2162: <code class="literal">package-install</code>. <code class="literal">package</code> and
2163: <code class="literal">install</code> don't do that any
2164: longer. <code class="literal">package-install</code> can be used as
2165: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2166: will ask for the root password to install the package and fail,
2167: <code class="literal">package-install</code> will ask again.</p>
2168: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2169: clean</code></strong> needs to be run as root.</p>
1.118 imil 2170: <p>Considering the <code class="filename">foo/bar</code> package,
2171: DESTDIR full support can be tested using the following commands
2172:
2173: </p>
2174: <pre class="programlisting">
2175: <code class="prompt">$</code> id
2176: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2177: <code class="prompt">$</code> mkdir $HOME/packages
2178: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2179: </pre>
2180: <p>
2181:
2182: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2183: should be needed
2184:
2185: </p>
2186: <pre class="programlisting">
1.123 snj 2187: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.118 imil 2188: </pre>
2189: <p>
2190:
2191: Create a package without root privileges
2192:
2193: </p>
2194: <pre class="programlisting">
1.123 snj 2195: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.118 imil 2196: </pre>
2197: <p>
2198:
2199: For the following command, you must be able to gain root
1.136 dholland 2200: 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 2201:
2202: </p>
2203: <pre class="programlisting">
1.123 snj 2204: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.118 imil 2205: </pre>
2206: <p>
2207:
2208: Then, as a simple user
2209:
2210: </p>
2211: <pre class="programlisting">
2212: <code class="prompt">$</code> make clean
2213: </pre>
2214: <p>
2215:
2216: </p>
1.103 wiz 2217: </div>
1.148 ! asau 2218: <div class="sect1">
1.103 wiz 2219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2220: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 ! asau 2221: <div class="sect2">
1.78 rillig 2222: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2223: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2224: <p>By default, pkgsrc will use GCC to build packages. This may be
2225: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 ! asau 2226: <div class="variablelist"><dl class="variablelist">
1.89 rillig 2227: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2228: <dd>
2229: <p>This is a list of values specifying the chain of
2230: compilers to invoke when building packages. Valid values
2231: are:</p>
1.148 ! asau 2232: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2233: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2234: distributed C/C++ (chainable)</p></li>
1.128 wiz 2235: <li class="listitem"><p><code class="varname">ccache</code>:
1.89 rillig 2236: compiler cache (chainable)</p></li>
1.128 wiz 2237: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2238: GNU C/C++ Compiler</p></li>
1.128 wiz 2239: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2240: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.128 wiz 2241: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2242: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 2243: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2244: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2245: </ul></div>
2246: <p>The default is
1.128 wiz 2247: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 2248: <code class="varname">ccache</code> and/or
2249: <code class="varname">distcc</code> with an appropriate
2250: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 2251: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2252: variable should always be terminated with a value for
2253: a real compiler. Note that only one real compiler
1.128 wiz 2254: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2255: is not allowed).</p>
1.89 rillig 2256: </dd>
2257: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2258: <dd><p>This specifies the minimum version of GCC to use
2259: when building packages. If the system GCC doesn't
2260: satisfy this requirement, then pkgsrc will build and
2261: install one of the GCC packages to use instead.</p></dd>
2262: </dl></div>
2263: </div>
1.148 ! asau 2264: <div class="sect2">
1.89 rillig 2265: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2266: <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 2267: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2268: please make sure to use the <code class="literal">+=</code> operator
2269: instead of the <code class="literal">=</code> operator:</p>
2270: <pre class="programlisting">
1.100 rillig 2271: CFLAGS+= -your -flags
1.78 rillig 2272: </pre>
2273: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2274: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2275: need to add their own flags. You may want to take a look
2276: 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 2277: package if you're interested in optimization specifically
2278: for the current CPU. </p>
1.78 rillig 2279: </div>
1.148 ! asau 2280: <div class="sect2">
1.88 wiz 2281: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2282: <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 2283: <p>If you want to pass flags to the linker, both in the configure
2284: step and the build step, you can do this in two ways. Either set
2285: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2286: between the two is that <code class="varname">LIBS</code> will be appended to
2287: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2288: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2289: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2290: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2291: <code class="varname">CFLAGS</code>, if you do not wish to override these
2292: settings, use the <code class="literal">+=</code> operator:</p>
2293: <pre class="programlisting">
1.100 rillig 2294: LDFLAGS+= -your -linkerflags
1.88 wiz 2295: </pre>
2296: </div>
1.78 rillig 2297: </div>
1.148 ! asau 2298: <div class="sect1">
1.78 rillig 2299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2300: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2301: <p>XXX
2302: </p>
1.148 ! asau 2303: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2304: <li class="listitem">
1.75 rillig 2305: <p><code class="varname">PKG_DEVELOPER</code>:
2306: Run some sanity checks that package developers want:
2307: </p>
1.148 ! asau 2308: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2309: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2310: fuzz</p></li>
1.128 wiz 2311: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2312: binaries will find their shared libs.</p></li>
1.75 rillig 2313: </ul></div>
2314: <p>
1.87 wiz 2315: </p>
1.75 rillig 2316: </li>
1.128 wiz 2317: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 2318: of debugging output which is displayed whilst making and
2319: installing the package. The default value for this is 0,
2320: which will not display the commands as they are executed
2321: (normal, default, quiet operation); the value 1 will display
2322: all shell commands before their invocation, and the value 2
2323: will display both the shell commands before their invocation,
1.110 hubertf 2324: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2325: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2326: </ul></div>
2327: <p>
2328: </p>
2329: </div>
1.148 ! asau 2330: <div class="sect1">
1.75 rillig 2331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2332: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2333: <p>Some packages have build time options, usually to select
2334: between different dependencies, enable optional support for big
2335: dependencies or enable experimental features.</p>
1.75 rillig 2336: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2337: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2338: show-options</strong></span>, for example:</p>
1.75 rillig 2339: <pre class="programlisting">
2340: The following options are supported by this package:
2341: ssl Enable SSL support.
2342: Exactly one of the following gecko options is required:
2343: firefox Use firefox as gecko rendering engine.
2344: mozilla Use mozilla as gecko rendering engine.
2345: At most one of the following database options may be selected:
2346: mysql Enable support for MySQL database.
2347: pgsql Enable support for PostgreSQL database.
1.1 grant 2348:
1.75 rillig 2349: These options are enabled by default: firefox
2350: These options are currently enabled: mozilla ssl
1.1 grant 2351: </pre>
1.75 rillig 2352: <p>The following variables can be defined in
1.110 hubertf 2353: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2354: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2355: which can be used to select or disable options for all packages
2356: that support them, and
2357: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2358: which can be used to select or disable options specifically for
2359: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2360: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2361: are disabled. A few examples:</p>
1.75 rillig 2362: <pre class="screen">
1.110 hubertf 2363: <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 2364: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2365: PKG_OPTIONS.kdebase= debug -sasl
2366: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2367: <p>It is important to note that options that were specifically
1.120 snj 2368: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2369: you do not wish to include the option. If you are unsure you can view
2370: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2371: <p>The following settings are consulted in the order given, and
2372: the last setting that selects or disables an option is
2373: used:</p>
1.128 wiz 2374: <div class="orderedlist"><ol class="orderedlist" type="1">
2375: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2376: maintainer</p></li>
1.128 wiz 2377: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2378: variables (see below)</p></li>
1.128 wiz 2379: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2380: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2381: </ol></div>
2382: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2383: selected is used, all others are automatically disabled. If an
2384: option of the group is explicitly disabled, the previously
2385: selected option, if any, is used. It is an error if no option
2386: from a required group of options is selected, and building the
2387: package will fail.</p>
2388: <p>Before the options framework was introduced, build options
2389: were selected by setting a variable (often named
2390: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2391: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2392: transition to the options framework for the user, these legacy
2393: variables are converted to the appropriate options setting
2394: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2395: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2396: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2397: directly. Support for the legacy variables will be removed
2398: eventually.</p>
1.75 rillig 2399: </div>
2400: </div>
1.148 ! asau 2401: <div class="chapter">
1.75 rillig 2402: <div class="titlepage"><div><div><h2 class="title">
2403: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2404: <div class="toc">
2405: <p><b>Table of Contents</b></p>
2406: <dl>
2407: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2408: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2409: </dl>
2410: </div>
1.148 ! asau 2411: <div class="sect1">
1.75 rillig 2412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2413: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2414: <p>Once you have built and installed a package, you can create
2415: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.136 dholland 2416: 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 2417: the same package on a group of hosts and wasting CPU time. It also
2418: provides a simple means for others to install your package, should
2419: you distribute it.</p>
2420: <p>To create a binary package, change into the appropriate
1.110 hubertf 2421: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2422: package</strong></span>:</p>
2423: <pre class="screen">
2424: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2425: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2426: </pre>
2427: <p>This will build and install your package (if not already done),
2428: and then build a binary package from what was installed. You can
1.110 hubertf 2429: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2430: it. Binary packages are created by default in
2431: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2432: 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 2433: 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 2434: <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 2435: such a binary package.</p>
1.75 rillig 2436: </div>
1.148 ! asau 2437: <div class="sect1">
1.75 rillig 2438: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2439: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2440: <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 2441: </div>
2442: </div>
1.148 ! asau 2443: <div class="chapter">
1.106 rillig 2444: <div class="titlepage"><div><div><h2 class="title">
2445: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2446: builds)</h2></div></div></div>
2447: <div class="toc">
2448: <p><b>Table of Contents</b></p>
2449: <dl>
2450: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2451: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2452: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2453: <dd><dl>
2454: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2455: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2456: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2457: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2458: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2459: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2460: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2461: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2462: </dl></dd>
2463: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 2464: <dd><dl>
2465: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2466: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2467: </dl></dd>
1.106 rillig 2468: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2469: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2470: </dl>
2471: </div>
2472: <p>When you have multiple machines that should run the same packages,
2473: it is wasted time if they all build their packages themselves from
2474: source. There are two ways of getting a set of binary packages: The old
2475: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2476: system. This chapter describes how to set them up so that the packages
2477: are most likely to be usable later.</p>
1.148 ! asau 2478: <div class="sect1">
1.106 rillig 2479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2480: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2481: <p>Since a bulk build takes several days or even weeks to finish, you
2482: should think about the setup before you start everything. Pay attention
2483: to at least the following points:</p>
1.148 ! asau 2484: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2485: <li class="listitem">
1.106 rillig 2486: <p>If you want to upload the binary packages to
2487: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2488: packages:</p>
1.148 ! asau 2489: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2490: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.106 rillig 2491: by a NetBSD developer on a trusted machine (that is, where you and only
2492: you have root access).</p></li>
1.128 wiz 2493: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.124 snj 2494: the stable branches (like 2009Q1), so that users browsing the available
1.106 rillig 2495: collections can see at a glance how old the packages
2496: are.</p></li>
1.128 wiz 2497: <li class="listitem"><p>The packages must be built as root, since some packages
1.106 rillig 2498: require set-uid binaries at runtime, and creating those packages as
2499: unprivileged user doesn't work well at the moment.</p></li>
2500: </ul></div>
2501: </li>
1.128 wiz 2502: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.106 rillig 2503: your system. Most bulk builds run as root, so they should be run at least
2504: in a chroot environment or something even more restrictive, depending on
2505: what the operating system provides. There have been numerous cases where
2506: certain packages tried to install files outside the
2507: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2508: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2509: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2510: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2511: that you don't need any package during the build.</p></li>
2512: </ul></div>
2513: </div>
1.148 ! asau 2514: <div class="sect1">
1.106 rillig 2515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2516: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2517: <p>A complete bulk build requires lots of disk space. Some of the
2518: disk space can be read-only, some other must be writable. Some can be on
2519: remote filesystems (such as NFS) and some should be local. Some can be
2520: temporary filesystems, others must survive a sudden reboot.</p>
1.148 ! asau 2521: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2522: <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2523: <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2524: <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2525: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2526: <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2527: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.106 rillig 2528: </ul></div>
1.75 rillig 2529: </div>
1.148 ! asau 2530: <div class="sect1">
1.75 rillig 2531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2532: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.148 ! asau 2533: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.116 rillig 2534: <h3 class="title">Note</h3>
2535: <p>There are two ways of doing a bulk build. The old-style
1.128 wiz 2536: one and the new-style <span class="quote">“<span class="quote">pbulk</span>”</span>. The latter is the recommended
1.116 rillig 2537: way.</p>
1.106 rillig 2538: </div>
1.148 ! asau 2539: <div class="sect2">
1.75 rillig 2540: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2541: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.148 ! asau 2542: <div class="sect3">
1.75 rillig 2543: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2544: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93 rillig 2545: </h4></div></div></div>
1.76 rillig 2546: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2547: configuration file for bulk builds. You can configure how your
2548: copy of pkgsrc is kept up to date, how the distfiles are
2549: downloaded, how the packages are built and how the report is
2550: generated. You can find an annotated example file in
2551: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2552: it, copy <code class="filename">build.conf-example</code> to
2553: <code class="filename">build.conf</code> and edit it, following the
2554: comments in that file.</p>
1.75 rillig 2555: </div>
1.148 ! asau 2556: <div class="sect3">
1.75 rillig 2557: <div class="titlepage"><div><div><h4 class="title">
1.110 hubertf 2558: <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 2559: </h4></div></div></div>
1.110 hubertf 2560: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87 wiz 2561: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2562: details of the default settings. You will want to ensure that
2563: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.125 wiz 2564: As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.104 rillig 2565: completely bypasses the license check.</p>
1.87 wiz 2566: <pre class="programlisting">
1.100 rillig 2567: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2568: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2569: BSDSRCDIR= /usr/src
2570: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2571: OBJHOSTNAME?= yes # use work.`hostname`
2572: FAILOVER_FETCH= yes # insist on the correct checksum
2573: PKG_DEVELOPER?= yes
1.125 wiz 2574: SKIP_LICENSE_CHECK= yes
1.100 rillig 2575: </pre>
1.75 rillig 2576: <p>Some options that are especially useful for bulk builds
2577: can be found at the top lines of the file
1.76 rillig 2578: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2579: options of these are briefly described here.</p>
1.148 ! asau 2580: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2581: <li class="listitem"><p>If you are on a slow machine, you may want to
1.87 wiz 2582: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.128 wiz 2583: <span class="quote">“<span class="quote">no</span>”</span>.</p></li>
2584: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.87 wiz 2585: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2586: to the directory where all log files are created. Otherwise the
2587: log files are created in the pkgsrc directory.</p></li>
1.128 wiz 2588: <li class="listitem"><p>Another important variable is
1.87 wiz 2589: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2590: should be always available while building other
2591: packages.</p></li>
1.75 rillig 2592: </ul></div>
2593: <p>Some other options are scattered in the pkgsrc
2594: infrastructure:</p>
1.148 ! asau 2595: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2596: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2597: should be set to <code class="literal">yes</code>. The purpose of the
2598: bulk builds is creating binary packages, no matter if they
2599: are vulnerable or not. Leaving this variable unset would
2600: prevent the bulk build system from even trying to build
2601: them, so possible building errors would not show
2602: up.</p></li>
2603: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2604: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.128 wiz 2605: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed set of files
1.87 wiz 2606: matches the <code class="filename">PLIST</code>.</p></li>
1.128 wiz 2607: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2608: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.128 wiz 2609: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed
2610: <span class="quote">“<span class="quote">#!</span>”</span>-scripts will find their
1.87 wiz 2611: interpreter.</p></li>
1.128 wiz 2612: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2613: set to <span class="quote">“<span class="quote"><code class="literal">yes</code></span>”</span> to run each
1.91 rillig 2614: package's self-test before installing it. Note that some
1.128 wiz 2615: packages make heavy use of <span class="quote">“<span class="quote">good</span>”</span> random
1.91 rillig 2616: numbers, so you need to assure that the machine on which you
2617: are doing the bulk builds is not completely idle. Otherwise
2618: some test programs will seem to hang, while they are just
2619: waiting for new random data to be
2620: available.</p></li>
1.75 rillig 2621: </ul></div>
2622: </div>
1.148 ! asau 2623: <div class="sect3">
1.75 rillig 2624: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2625: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93 rillig 2626: </h4></div></div></div>
1.75 rillig 2627: <p>It is possible to configure the bulk build to perform
1.87 wiz 2628: certain site-specific tasks at the end of the pre-build
2629: stage. If the file
2630: <code class="filename">pre-build.local</code> exists in
2631: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.136 dholland 2632: (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 2633: stage. An example use of
2634: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2635: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2636: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2637: <p>to prevent the system from trying to build a particular package
1.87 wiz 2638: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2639: </div>
2640: </div>
1.148 ! asau 2641: <div class="sect2">
1.75 rillig 2642: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2643: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2644: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2645: deleted at the start of bulk builds, make sure your login
2646: shell is placed somewhere else. Either drop it into
2647: <code class="filename">/usr/local/bin</code> (and adjust your login
2648: shell in the passwd file), or (re-)install it via
1.136 dholland 2649: <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 2650: you can login after a reboot (remember that your current
2651: process won't die if the package is removed, you just can't
2652: start any new instances of the shell any more). Also, if you
2653: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2654: version of ssh for some reason, be sure to install ssh before
2655: starting it from <code class="filename">rc.local</code>:</p>
2656: <pre class="programlisting">
1.100 rillig 2657: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2658: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2659: /usr/pkg/etc/rc.d/sshd
2660: fi
2661: </pre>
1.75 rillig 2662: <p>Not doing so will result in you being not able to log in
1.87 wiz 2663: via ssh after the bulk build is finished or if the machine
2664: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2665: </div>
1.148 ! asau 2666: <div class="sect2">
1.75 rillig 2667: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2668: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75 rillig 2669: <p>Make sure you don't need any of the packages still
1.87 wiz 2670: installed.</p>
1.148 ! asau 2671: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 2672: <h3 class="title">Warning</h3>
1.99 rillig 2673: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2674: configuration files and some more files from
2675: <code class="filename">/var</code>, <code class="filename">/home</code> and
2676: possibly other locations will be removed! So don't run a bulk
2677: build with privileges that might harm your
2678: system.</em></span></p>
1.75 rillig 2679: </div>
2680: <p>Be sure to remove all other things that might
1.87 wiz 2681: interfere with builds, like some libs installed in
2682: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2683: <pre class="screen">
2684: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2685: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2686: </pre>
1.75 rillig 2687: <p>If for some reason your last build didn't complete (power
1.87 wiz 2688: failure, system panic, ...), you can continue it by
2689: running:</p>
1.75 rillig 2690: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2691: <p>At the end of the bulk build, you will get a summary via mail,
2692: and find build logs in the directory specified by
2693: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2694: file.</p>
1.75 rillig 2695: </div>
1.148 ! asau 2696: <div class="sect2">
1.75 rillig 2697: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2698: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75 rillig 2699: <p>The bulk builds consist of three steps:</p>
1.148 ! asau 2700: <div class="variablelist"><dl class="variablelist">
1.75 rillig 2701: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2702: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2703: cleans out any broken distfiles, and removes all
2704: packages installed.</p></dd>
1.75 rillig 2705: <dt><span class="term">2. the bulk build</span></dt>
1.128 wiz 2706: <dd><p>This is basically <span class="quote">“<span class="quote">make bulk-package</span>”</span> with
1.87 wiz 2707: an optimised order in which packages will be
2708: built. Packages that don't require other packages will
2709: be built first, and packages with many dependencies will
2710: be built later.</p></dd>
1.75 rillig 2711: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2712: <dd><p>Generates a report that's placed in the directory
2713: specified in the <code class="filename">build.conf</code> file
2714: named <code class="filename">broken.html</code>, a short version
2715: of that report will also be mailed to the build's
2716: admin.</p></dd>
1.75 rillig 2717: </dl></div>
1.87 wiz 2718: <p>During the build, a list of broken packages will be compiled
2719: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2720: <code class="filename">.../.broken.${MACHINE}</code> if
2721: <code class="varname">OBJMACHINE</code> is set), individual build logs
2722: of broken builds can be found in the package's
2723: directory. These files are used by the bulk-targets to mark
2724: broken builds to not waste time trying to rebuild them, and
2725: they can be used to debug these broken package builds
2726: later.</p>
1.75 rillig 2727: </div>
1.148 ! asau 2728: <div class="sect2">
1.75 rillig 2729: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2730: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75 rillig 2731: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2732: NetBSD 2.0/i386:</p>
1.148 ! asau 2733: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2734: <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
2735: <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
2736: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.87 wiz 2737: </ul></div>
2738: <p>Note that all pkgs will be de-installed as soon as they are
2739: turned into a binary package, and that sources are removed,
2740: so there is no excessively huge demand to disk
2741: space. Afterwards, if the package is needed again, it will
1.136 dholland 2742: 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 2743: there are no cycles wasted by recompiling.</p>
1.75 rillig 2744: </div>
1.148 ! asau 2745: <div class="sect2">
1.75 rillig 2746: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2747: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2748: <p>If you don't want all the packages nuked from a machine
2749: (rendering it useless for anything but pkg compiling), there
2750: is the possibility of doing the package bulk build inside a
2751: chroot environment.</p>
2752: <p>The first step is to set up a chroot sandbox,
2753: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2754: using null mounts, or manually.</p>
2755: <p>There is a shell script called
1.143 wiz 2756: <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 2757: up the sandbox environment using null mounts. It will also
2758: create a script called <code class="filename">sandbox</code> in the
2759: root of the sandbox environment, which will allow the null
1.110 hubertf 2760: mounts to be activated using the <span class="command"><strong>sandbox
1.87 wiz 2761: mount</strong></span> command and deactivated using the
1.110 hubertf 2762: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87 wiz 2763: <p>To set up a sandbox environment by hand, after extracting all
1.110 hubertf 2764: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87 wiz 2765: distribution DESTDIR=/usr/sandbox</strong></span> in
2766: <code class="filename">/usr/src/etc</code>, be sure the following items
2767: are present and properly configured:</p>
1.128 wiz 2768: <div class="procedure"><ol class="procedure" type="1">
1.148 ! asau 2769: <li class="step">
1.75 rillig 2770: <p>Kernel</p>
2771: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2772: </li>
1.148 ! asau 2773: <li class="step">
1.76 rillig 2774: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2775: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2776: </li>
1.148 ! asau 2777: <li class="step">
1.91 rillig 2778: <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 2779: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2780: </li>
1.148 ! asau 2781: <li class="step">
1.75 rillig 2782: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2783: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2784: </li>
1.148 ! asau 2785: <li class="step">
1.91 rillig 2786: <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 2787: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2788: </li>
1.148 ! asau 2789: <li class="step">
1.76 rillig 2790: <p><code class="filename">/usr/src</code> (system sources,
1.126 jakllsch 2791: e. g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html" target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
1.75 rillig 2792: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2793: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2794: </li>
1.148 ! asau 2795: <li class="step">
1.76 rillig 2796: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2797: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2798: </li>
1.148 ! asau 2799: <li class="step">
1.76 rillig 2800: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2801: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2802: </li>
1.148 ! asau 2803: <li class="step">
1.75 rillig 2804: <p>Checkout pkgsrc via cvs into
1.87 wiz 2805: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2806: <pre class="screen">
2807: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2808: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2809: </pre>
1.75 rillig 2810: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2811: you do development in, as this will likely cause problems!</p>
1.75 rillig 2812: </li>
1.148 ! asau 2813: <li class="step"><p>Make
1.87 wiz 2814: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2815: <code class="filename">.../distfiles</code> point somewhere
2816: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.148 ! asau 2817: <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>
! 2818: <li class="step"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2819: </ol></div>
2820: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2821: the build with the following steps:</p>
2822: <pre class="screen">
2823: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2824: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2825: </pre>
2826: <p>This will just jump inside the sandbox and start building. At
2827: the end of the build, mail will be sent with the results of
2828: the build. Created binary pkgs will be in
2829: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2830: (wherever that points/mounts to/from).</p>
1.75 rillig 2831: </div>
1.148 ! asau 2832: <div class="sect2">
1.75 rillig 2833: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2834: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2835: <p>In addition to building a complete set of all packages in
2836: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2837: may be used to build a subset of the packages contained in
2838: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.110 hubertf 2839: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.148 ! asau 2840: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2841: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
2842: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
2843: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
2844: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.75 rillig 2845: </ul></div>
1.87 wiz 2846: <p>will define the set of packages which should be built.
2847: The bulk build code will also include any packages which are
2848: needed as dependencies for the explicitly listed packages.</p>
2849: <p>One use of this is to do a bulk build with
2850: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2851: periodically to have a complete set of the binary packages
2852: needed for your site available without the overhead of
2853: building extra packages that are not needed.</p>
1.75 rillig 2854: </div>
1.148 ! asau 2855: <div class="sect2">
1.75 rillig 2856: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2857: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2858: <p>This section describes how pkgsrc developers can upload binary
2859: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2860: <p>If you would like to automatically create checksum files for the
2861: binary packages you intend to upload, remember to set
2862: <code class="varname">MKSUMS=yes</code> in your
2863: <code class="filename">mk/bulk/build.conf</code>.</p>
2864: <p>If you would like to PGP sign the checksum files (highly
2865: recommended!), remember to set
2866: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2867: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2868: your GPG password to sign the files before uploading everything.</p>
2869: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2870: set properly in your <code class="filename">mk/bulk/build.conf</code>
2871: file, i.e. adjust it to something like one of the following:</p>
1.132 spz 2872: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
2873: <p>Please use appropriate values for "20xxQy" (the branch),
2874: "a.b.c" (the OS version) and "arch" here. If your login on ftp.NetBSD.org
1.87 wiz 2875: is different from your local login, write your login directly
2876: into the variable, e.g. my local account is "feyrer", but for my
2877: login "hubertf", I use:</p>
1.132 spz 2878: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
1.87 wiz 2879: <p>A separate <code class="filename">upload</code> directory is used
2880: here to allow "closing" the directory during upload. To do
2881: so, run the following command on ftp.NetBSD.org next:</p>
1.132 spz 2882: <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 2883: <p>Before uploading the binary pkgs, ssh authentication needs
2884: to be set up. This example shows how to set up temporary keys
2885: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2886: (assuming that no keys should be present there usually):</p>
2887: <pre class="screen">
2888: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 2889: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
1.132 spz 2890: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t rsa</code></strong>
2891: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-rsa.pub</code></strong>
1.87 wiz 2892: </pre>
1.132 spz 2893: <p>Now take the output of <code class="filename">id-rsa.pub</code> and
1.87 wiz 2894: append it to your <code class="filename">~/.ssh/authorized_keys</code>
1.132 spz 2895: file on ftp.NetBSD.org. You should remove the key after the
1.87 wiz 2896: upload is done!</p>
2897: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 2898: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 2899: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2900: <p>Now after all this works, you can exit the sandbox and start
2901: the upload:</p>
2902: <pre class="screen">
2903: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 2904: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 2905: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2906: </pre>
1.136 dholland 2907: <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
2908: <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 2909: upload. The upload script will take care of not uploading
1.127 spz 2910: restricted packages.</p>
1.128 wiz 2911: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 2912: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 2913: Gdd:x! </pre>
2914: <p>Use whatever is needed to remove the key you've entered
2915: before! Last, move the uploaded packages out of the
2916: <code class="filename">upload</code> directory to have them accessible
2917: to everyone:</p>
2918: <pre class="screen">
1.132 spz 2919: nbftp% <strong class="userinput"><code>cd /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy</code></strong>
1.75 rillig 2920: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2921: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.132 spz 2922: nbftp% <strong class="userinput"><code>chgrp -R netbsd .</code></strong>
2923: nbftp% <strong class="userinput"><code>find . -type d | xargs chmod 775</code></strong>
1.87 wiz 2924: </pre>
1.75 rillig 2925: </div>
2926: </div>
1.148 ! asau 2927: <div class="sect1">
1.75 rillig 2928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2929: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2930: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 ! asau 2931: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2932: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2933: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2934: </ul></div>
1.148 ! asau 2935: <div class="sect2">
1.116 rillig 2936: <div class="titlepage"><div><div><h3 class="title">
2937: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
1.117 jnemeth 2938: <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 2939: <pre class="screen">
2940: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2941: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
2942: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
2943: </pre>
2944: <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 2945: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2946: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
2947: <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>
2948: <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>
2949: <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>
2950: <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 2951: </ul></div>
2952: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
2953: <pre class="screen">
2954: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
2955: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
2956: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
2957: </pre>
2958: <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>
2959: </div>
1.148 ! asau 2960: <div class="sect2">
1.106 rillig 2961: <div class="titlepage"><div><div><h3 class="title">
1.116 rillig 2962: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114 jmcneill 2963: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116 rillig 2964: <p>TODO: continue writing</p>
1.106 rillig 2965: </div>
2966: </div>
1.148 ! asau 2967: <div class="sect1">
1.106 rillig 2968: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2969: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2970: <p>After your pkgsrc bulk-build has completed, you may wish to
2971: create a CD-ROM set of the resulting binary packages to assist
2972: in installing packages on other machines. The
1.91 rillig 2973: <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 2974: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2975: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2976: way that keeps all the dependencies for a given package on the same
2977: CD as that package.</p>
1.148 ! asau 2978: <div class="sect2">
1.75 rillig 2979: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2980: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2981: <p>Complete documentation for cdpack is found in the cdpack(1)
2982: man page. The following short example assumes that the binary
2983: packages are left in
2984: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2985: sufficient disk space exists in <code class="filename">/u2</code> to
2986: hold the ISO 9660 images.</p>
2987: <pre class="screen">
2988: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2989: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2990: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2991: </pre>
2992: <p>If you wish to include a common set of files
2993: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2994: etc.) on each CD in the collection, then you need to create a
2995: directory which contains these files. e.g.</p>
2996: <pre class="screen">
2997: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2998: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2999: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3000: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3001: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3002: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3003: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3004: </pre>
1.75 rillig 3005: <p>Now create the images:</p>
3006: <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 3007: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3008: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3009: in their root directories.</p>
1.75 rillig 3010: </div>
3011: </div>
3012: </div>
1.148 ! asau 3013: <div class="chapter">
1.75 rillig 3014: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3015: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 3016: <div class="toc">
3017: <p><b>Table of Contents</b></p>
3018: <dl>
1.128 wiz 3019: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
3020: <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 3021: </dl>
3022: </div>
3023: <p>The files that are installed by pkgsrc are organized in a way that
3024: is similar to what you find in the <code class="filename">/usr</code> directory
3025: of the base system. But some details are different. This is because
3026: pkgsrc initially came from FreeBSD and had adopted its file system
3027: hierarchy. Later it was largely influenced by NetBSD. But no matter
3028: which operating system you are using pkgsrc with, you can expect the
3029: same layout for pkgsrc.</p>
1.91 rillig 3030: <p>There are mainly four root directories for pkgsrc, which are all
3031: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3032: When pkgsrc has been installed as root, the default locations
3033: are:</p>
3034: <pre class="programlisting">
1.100 rillig 3035: LOCALBASE= /usr/pkg
3036: PKG_SYSCONFBASE= /usr/pkg/etc
3037: VARBASE= /var
3038: PKG_DBDIR= /var/db/pkg
1.91 rillig 3039: </pre>
3040: <p>In unprivileged mode (when pkgsrc has been installed as any other
3041: user), the default locations are:</p>
3042: <pre class="programlisting">
1.100 rillig 3043: LOCALBASE= ${HOME}/pkg
3044: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3045: VARBASE= ${HOME}/pkg/var
3046: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3047: </pre>
3048: <p>What these four directories are for, and what they look like is
3049: explained below.</p>
1.148 ! asau 3050: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3051: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 3052: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 3053: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 3054: the well-known subdirectories like <code class="filename">bin</code>,
3055: <code class="filename">include</code>, <code class="filename">lib</code>,
3056: <code class="filename">share</code> and
3057: <code class="filename">sbin</code>.</p></li>
1.128 wiz 3058: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 3059: <code class="filename">/var</code> in the base system. Some programs (especially
3060: games, network daemons) need write access to it during normal
3061: operation.</p></li>
1.128 wiz 3062: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 3063: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 3064: 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 3065: itself.</p></li>
3066: </ul></div>
1.148 ! asau 3067: <div class="sect1">
1.90 rillig 3068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3069: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 3070: </h2></div></div></div>
1.90 rillig 3071: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3072: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 ! asau 3073: <div class="variablelist"><dl class="variablelist">
1.90 rillig 3074: <dt><span class="term"><code class="filename">bin</code></span></dt>
3075: <dd><p>Contains executable programs that are intended to be
3076: directly used by the end user.</p></dd>
3077: <dt><span class="term"><code class="filename">emul</code></span></dt>
3078: <dd><p>Contains files for the emulation layers of various other
3079: operating systems, especially for
3080: NetBSD.</p></dd>
3081: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3082: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3083: <dd><p>Contains
3084: the configuration files.</p></dd>
3085: <dt><span class="term"><code class="filename">include</code></span></dt>
3086: <dd><p>Contains headers for the C and C++ programming
3087: languages.</p></dd>
3088: <dt><span class="term"><code class="filename">info</code></span></dt>
3089: <dd><p>Contains GNU info files of various
3090: packages.</p></dd>
3091: <dt><span class="term"><code class="filename">lib</code></span></dt>
3092: <dd><p>Contains shared and static
3093: libraries.</p></dd>
3094: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3095: <dd><p>Contains data files that don't change after
3096: installation. Other data files belong into
3097: <code class="filename">${VARBASE}</code>.</p></dd>
3098: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3099: <dd><p>Contains programs that are not intended to be used by
3100: end users, such as helper programs or network
3101: daemons.</p></dd>
3102: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3103: <dd><p>Contains programs that are intended to be executed as
3104: CGI scripts by a web server.</p></dd>
3105: <dt><span class="term"><code class="filename">man</code> (the usual value of
3106: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3107: <dd><p>Contains brief
3108: documentation in form of manual pages.</p></dd>
3109: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3110: <dd><p>Contains programs that are intended to be used only by
3111: the super-user.</p></dd>
3112: <dt><span class="term"><code class="filename">share</code></span></dt>
3113: <dd><p>Contains platform-independent data files that don't
3114: change after installation.</p></dd>
3115: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3116: <dd><p>Contains documentation files provided by the
3117: packages.</p></dd>
3118: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3119: <dd><p>Contains example files provided by the packages. Among
3120: others, the original configuration files are saved here and copied to
3121: <code class="filename">${PKG_SYSCONFDIR}</code> during
3122: installation.</p></dd>
3123: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3124: <dd><p>Contains the original files for rc.d
3125: scripts.</p></dd>
3126: <dt><span class="term"><code class="filename">var</code> (the usual location of
3127: <code class="filename">${VARBASE}</code>)</span></dt>
3128: <dd><p>Contains files
3129: that may be modified after
3130: installation.</p></dd>
3131: </dl></div>
3132: </div>
1.148 ! asau 3133: <div class="sect1">
1.90 rillig 3134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3135: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 3136: </h2></div></div></div>
1.148 ! asau 3137: <div class="variablelist"><dl class="variablelist">
1.90 rillig 3138: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3139: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3140: <dd><p>Contains
3141: information about the currently installed
3142: packages.</p></dd>
3143: <dt><span class="term"><code class="filename">games</code></span></dt>
3144: <dd><p>Contains highscore
3145: files.</p></dd>
3146: <dt><span class="term"><code class="filename">log</code></span></dt>
3147: <dd><p>Contains log files.</p></dd>
3148: <dt><span class="term"><code class="filename">run</code></span></dt>
3149: <dd><p>Contains informational files about daemons that are
3150: currently running.</p></dd>
3151: </dl></div>
3152: </div>
3153: </div>
1.148 ! asau 3154: <div class="chapter">
1.90 rillig 3155: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3156: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3157: <div class="toc">
3158: <p><b>Table of Contents</b></p>
3159: <dl>
1.106 rillig 3160: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3161: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3162: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3163: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3164: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3165: <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>
3166: <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 3167: <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 3168: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.128 wiz 3169: <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
3170: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
3171: <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 3172: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3173: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3174: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.128 wiz 3175: <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 3176: <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 3177: <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 3178: </dl>
3179: </div>
3180: <p>This section contains hints, tips & tricks on special things in
3181: pkgsrc that we didn't find a better place for in the previous chapters, and
3182: it contains items for both pkgsrc users and developers.</p>
1.148 ! asau 3183: <div class="sect1">
1.75 rillig 3184: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3185: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3186: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 ! asau 3187: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3188: <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 3189: This is a general purpose list for most issues regarding
3190: pkgsrc, regardless of platform, e.g. soliciting user help
3191: for pkgsrc configuration, unexpected build failures, using
3192: particular packages, upgrading pkgsrc installations,
3193: questions regarding the pkgsrc release branches, etc. General announcements or
3194: proposals for changes that impact the pkgsrc user community,
3195: e.g. major infrastructure changes, new features, package
3196: removals, etc., may also be posted.</p></li>
1.128 wiz 3197: <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 3198: A list where the results of pkgsrc bulk builds are sent and
3199: discussed.</p></li>
1.128 wiz 3200: <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 3201: This list is for those who are interested in getting a
3202: commit message for every change committed to pkgsrc. It is
3203: also available in digest form, meaning one daily message
3204: containing all commit messages for changes to the package
3205: source tree in that 24 hour period.</p></li>
3206: </ul></div>
3207: <p>To subscribe, do:</p>
3208: <pre class="programlisting">
1.100 rillig 3209: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 3210: </pre>
3211: <p>Archives for all these mailing lists are available from
1.110 hubertf 3212: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 3213: </div>
1.148 ! asau 3214: <div class="sect1">
1.75 rillig 3215: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3216: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3217: <p>Pkgviews is tightly integrated with buildlink. You can find a
3218: pkgviews User's guide in
1.76 rillig 3219: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3220: </div>
1.148 ! asau 3221: <div class="sect1">
1.75 rillig 3222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3223: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3224: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3225: a number of useful utilities for both users and developers of pkgsrc. This
3226: section attempts only to make the reader aware of the utilities and when
3227: they might be useful, and not to duplicate the documentation that comes
3228: with each package.</p>
3229: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.148 ! asau 3230: <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 3231: Symlinks for use by buildlink.</p></li></ul></div>
3232: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 ! asau 3233: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3234: <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 3235: Calculates various kinds of checksums (including SHA1).</p></li>
1.128 wiz 3236: <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 3237: Compatibility library for pkgsrc tools.</p></li>
1.128 wiz 3238: <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 3239: non-BSD systems due to lack of native mtree.</p></li>
1.128 wiz 3240: <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 3241: Up-to-date replacement for
1.76 rillig 3242: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3243: systems where pkg_install is not present.</p></li>
3244: </ul></div>
3245: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 ! asau 3246: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3247: <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 3248: Create a binary package from an
1.110 hubertf 3249: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 3250: save the old package.</p></li>
1.128 wiz 3251: <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 3252: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3253: from multiple locations. It currently supports the following
3254: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.128 wiz 3255: <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 3256: packages someplace else (enabled by default).</p></li>
1.128 wiz 3257: <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 3258: the best compiler flags to optimise code for your current
1.128 wiz 3259: CPU and compiler. </p></li>
1.75 rillig 3260: </ul></div>
3261: <p>Utilities for keeping track of installed packages, being up to date,
3262: etc:</p>
1.148 ! asau 3263: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3264: <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 3265: packages whose installed versions do not match the latest pkgsrc
3266: entries.</p></li>
1.128 wiz 3267: <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 3268: dependency graphs of packages, to aid in choosing a strategy for
3269: updating.</p></li>
1.128 wiz 3270: <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 3271: 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 3272: <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 3273: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.128 wiz 3274: <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 3275: does various checks on the complete pkgsrc system.</p></li>
1.128 wiz 3276: <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 3277: packages you have installed.</p></li>
3278: </ul></div>
3279: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 ! asau 3280: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3281: <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 3282: making and maintaining patches for a package (includes pkgdiff,
3283: pkgvi, mkpatches, etc.).</p></li>
1.128 wiz 3284: <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 3285: <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 3286: converting to pkgsrc.</p></li>
1.128 wiz 3287: <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 3288: pkgsrc to a Solaris package.</p></li>
3289: </ul></div>
3290: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3291: utilities)</p>
1.148 ! asau 3292: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3293: <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 3294: packages in a chrooted area.</p></li>
1.128 wiz 3295: <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 3296: kernel version for chrooted cross builds.</p></li>
3297: </ul></div>
3298: </div>
1.148 ! asau 3299: <div class="sect1">
1.75 rillig 3300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3301: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3302: <p>If you want to use pkgsrc as non-root user, you can set some
3303: variables to make pkgsrc work under these conditions. At the very least,
1.128 wiz 3304: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.75 rillig 3305: will turn on unprivileged mode and set multiple related variables to allow
3306: installation of packages as non-root.</p>
3307: <p>In case the defaults are not enough, you may want to tune some other
3308: variables used. For example, if the automatic user/group detection leads
3309: to incorrect values (or not the ones you would like to use), you can change
3310: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3311: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3312: <p>As regards bootstrapping, please note that the
1.110 hubertf 3313: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128 wiz 3314: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.76 rillig 3315: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3316: installation targets. These directories can be overridden by the
1.128 wiz 3317: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.75 rillig 3318: that allow finer tuning of the tree layout.</p>
3319: </div>
1.148 ! asau 3320: <div class="sect1">
1.75 rillig 3321: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3322: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3323: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3324: enable this feature by adding the option
3325: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3326: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3327: distfile is found, pkgsrc will try to resume it.</p>
3328: <p>You can also
1.136 dholland 3329: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.117 jnemeth 3330: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3331: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3332: by using the value manual. A value of custom disables the system defaults
3333: and dependency tracking for the fetch program. In that case you have to
3334: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3335: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3336: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3337: <p>For example, if you want to use
1.117 jnemeth 3338: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3339: like:</p>
3340: <pre class="programlisting">
1.117 jnemeth 3341: FETCH_USING= wget
1.1 grant 3342: </pre>
1.75 rillig 3343: </div>
1.148 ! asau 3344: <div class="sect1">
1.75 rillig 3345: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3346: <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 3347: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3348: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3349: you will have to add the following line into
1.110 hubertf 3350: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3351: <pre class="programlisting">
1.103 wiz 3352: X11_TYPE=modular
1.1 grant 3353: </pre>
1.148 ! asau 3354: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 3355: <h3 class="title">Note</h3>
1.103 wiz 3356: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3357: </p>
1.75 rillig 3358: </div>
3359: </div>
1.148 ! asau 3360: <div class="sect1">
1.75 rillig 3361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3362: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3363: <p>If you are sitting behind a firewall which does not allow direct
3364: connections to Internet hosts (i.e. non-NAT), you may specify the
3365: relevant proxy hosts. This is done using an environment variable in the
3366: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 3367: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 3368: port 80 as the proxy port number. So the proxy environment variables
3369: are:</p>
3370: <pre class="programlisting">
1.100 rillig 3371: ftp_proxy=ftp://orpheus.amdahl.com:80/
3372: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3373: </pre>
1.75 rillig 3374: </div>
1.148 ! asau 3375: <div class="sect1">
1.75 rillig 3376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 3377: <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 3378: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3379: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3380: the first available command from the following list:</p>
1.148 ! asau 3381: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3382: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3383: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3384: </ul></div>
3385: <p>On a default NetBSD installation, this will be
1.76 rillig 3386: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3387: connections first, and falls back to active connections if the server
3388: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3389: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3390: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3391: <p>Having that option present will prevent
1.76 rillig 3392: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3393: transfers.</p>
3394: </div>
1.148 ! asau 3395: <div class="sect1">
1.75 rillig 3396: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3397: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3398: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3399: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 3400: 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 3401: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3402: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3403: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3404: resulting list to your machine at work/school and use it there. If you
1.136 dholland 3405: 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 3406: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3407: URL:</p>
3408: <p>At home:</p>
3409: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3410: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3411: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3412: <p>At work:</p>
3413: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3414: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3415: home.</p>
3416: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3417: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3418: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3419: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3420: directly by running:</p>
1.75 rillig 3421: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3422: <p>If you even decide to ignore
3423: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3424: by running:</p>
3425: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3426: </div>
1.148 ! asau 3427: <div class="sect1">
1.75 rillig 3428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 wiz 3429: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
3430: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.91 rillig 3431: <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 3432: package, you get the error from make that it doesn't know how to make
1.76 rillig 3433: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3434: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3435: the NetBSD base distribution on your machine. It is recommended to do
3436: that to format man pages.</p>
1.91 rillig 3437: <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 3438: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3439: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3440: </div>
1.148 ! asau 3441: <div class="sect1">
1.75 rillig 3442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 wiz 3443: <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 3444: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3445: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3446: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3447: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3448: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3449: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3450: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3451: -r</strong></span>).</p>
3452: </div>
1.148 ! asau 3453: <div class="sect1">
1.75 rillig 3454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3455: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3456: <p>When installing packages as non-root user and using the just-in-time
1.136 dholland 3457: <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 3458: password for each required package installed. To avoid this, the sudo
3459: package can be used, which does password caching over a limited time. To
3460: use it, install sudo (either as binary package or from
1.98 wiz 3461: <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 3462: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3463: <span class="emphasis"><em>after</em></span> the definition of the
3464: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3465: <pre class="programlisting">
1.100 rillig 3466: .if exists(${LOCALBASE}/bin/sudo)
3467: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3468: .endif
1.1 grant 3469: </pre>
1.75 rillig 3470: </div>
1.148 ! asau 3471: <div class="sect1">
1.75 rillig 3472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3473: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3474: <p>As the system administrator, you can choose where configuration files
3475: are installed. The default settings make all these files go into
1.76 rillig 3476: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3477: be suboptimal depending on your expectations (e.g., a read-only,
3478: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3479: configuration of the provided packages).</p>
3480: <p>In order to change the defaults, you can modify the
3481: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3482: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3483: directory; some common examples include <code class="filename">/etc</code> or
3484: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3485: <p>Furthermore, you can change this value on a per-package basis by
3486: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3487: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3488: package you would like to modify, that is, the contents of
3489: <code class="varname">PKGBASE</code>.</p>
3490: <p>Note that after changing these settings, you must rebuild and
3491: reinstall any affected packages.</p>
3492: </div>
1.148 ! asau 3493: <div class="sect1">
1.75 rillig 3494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3495: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 3496: <p>Please be aware that there can often be bugs in third-party software,
3497: and some of these bugs can leave a machine vulnerable to exploitation by
3498: attackers. In an effort to lessen the exposure, the NetBSD packages team
3499: maintains a database of known-exploits to packages which have at one time
3500: been included in pkgsrc. The database can be downloaded automatically, and
3501: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3502: do this, refer to the following two tools (installed as part of the
3503: <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 3504: <div class="orderedlist"><ol class="orderedlist" type="1">
3505: <li class="listitem">
1.122 reed 3506: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3507: download a list of the security vulnerabilities information. This list
1.132 spz 3508: is kept up to date by the pkgsrc security team, and is distributed
3509: from the NetBSD ftp server:</p>
3510: <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 3511: </li>
1.128 wiz 3512: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3513: current machine, checking each known vulnerability. If a
1.75 rillig 3514: vulnerable package is installed, it will be shown by output to stdout,
3515: including a description of the type of vulnerability, and a URL
3516: containing more information.</p></li>
3517: </ol></div>
1.114 jmcneill 3518: <p>Use of these tools is strongly recommended! After
1.128 wiz 3519: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.75 rillig 3520: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3521: pkg_install</code></strong>.</p>
1.87 wiz 3522: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3523: 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 3524: check.</p>
1.75 rillig 3525: </div>
1.148 ! asau 3526: <div class="sect1">
1.75 rillig 3527: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3528: <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 3529: <p>When you add your own preferences to the
3530: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3531: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3532: environment variables to the <code class="filename">./configure</code>
1.136 dholland 3533: 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 3534: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3535: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3536: package.</p>
3537: <p>Currently there is no solution to this problem. If you
3538: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3539: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3540: directory and then inspect any <code class="filename">Makefile</code> and
3541: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3542: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3543: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3544: programmers write so bad code that it only works for the
3545: specific combination of <code class="varname">CFLAGS</code> they have
3546: chosen.</p>
3547: </div>
1.148 ! asau 3548: <div class="sect1">
1.80 rillig 3549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3550: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3551: <div class="procedure"><ol class="procedure" type="1">
1.148 ! asau 3552: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3553: case that occurs often is that people only update pkgsrc in
3554: parts, because of performance reasons. Since pkgsrc is one large
3555: system, not a collection of many small systems, there are
3556: sometimes changes that only work when the whole pkgsrc tree is
3557: updated.</p></li>
1.148 ! asau 3558: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3559: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3560: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3561: files.</p></li>
1.148 ! asau 3562: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3563: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3564: verify this.</p></li>
1.148 ! asau 3565: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3566: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3567: </ol></div>
3568: </div>
1.148 ! asau 3569: <div class="sect1">
1.88 wiz 3570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 wiz 3571: <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 3572: <p>You have modified a file from pkgsrc, and someone else has
3573: modified that same file afterwards in the CVS repository. Both changes
3574: are in the same region of the file, so when you updated pkgsrc, the
3575: <code class="literal">cvs</code> command marked the conflicting changes in the
3576: file. Because of these markers, the file is no longer a valid
3577: <code class="filename">Makefile</code>.</p>
3578: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3579: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3580: -dP</strong></span> in that directory to download the current version.</p>
3581: </div>
1.75 rillig 3582: </div>
3583: </div>
1.148 ! asau 3584: <div class="part">
1.75 rillig 3585: <div class="titlepage"><div><div><h1 class="title">
3586: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 ! asau 3587: <div class="partintro">
1.77 rillig 3588: <div></div>
3589: <p>This part of the book deals with creating and
1.128 wiz 3590: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3591: guide on creating a new package. The remaining chapters are more
3592: like a reference manual for pkgsrc.</p>
1.75 rillig 3593: <div class="toc">
3594: <p><b>Table of Contents</b></p>
3595: <dl>
1.106 rillig 3596: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3597: <dd><dl>
1.106 rillig 3598: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3599: <dd><dl>
1.106 rillig 3600: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3601: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3602: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3603: </dl></dd>
1.106 rillig 3604: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3605: <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>
3606: </dl></dd>
3607: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3608: <dd><dl>
1.128 wiz 3609: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3610: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3611: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3612: <dd><dl>
3613: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3614: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3615: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3616: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3617: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3618: </dl></dd>
3619: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3620: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3621: <dd><dl>
3622: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3623: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3624: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3625: </dl></dd>
1.128 wiz 3626: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3627: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3628: </dl></dd>
1.128 wiz 3629: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3630: <dd><dl>
3631: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 3632: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 3633: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3634: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3635: <dd><dl>
3636: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3637: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3638: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3639: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3640: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3641: </dl></dd>
3642: </dl></dd>
3643: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3644: <dd><dl>
3645: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 3646: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3647: <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 3648: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3649: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 3650: <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 3651: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3652: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3653: </dl></dd>
3654: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3655: <dd><dl>
3656: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 3657: <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 3658: <dd><dl>
3659: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 3660: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3661: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3662: and
3663: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3664: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3665: </dl></dd>
1.128 wiz 3666: <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 3667: <dd><dl>
1.128 wiz 3668: <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 3669: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3670: </dl></dd>
3671: </dl></dd>
3672: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3673: <dd><dl>
3674: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3675: <dd><dl>
3676: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3677: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3678: </dl></dd>
3679: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3680: <dd><dl>
1.128 wiz 3681: <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 3682: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3683: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3684: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3685: </dl></dd>
3686: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3687: <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>
3688: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3689: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3690: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3691: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3692: <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>
3693: </dl></dd>
3694: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3695: <dd><dl>
3696: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 3697: <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 3698: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3699: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3700: </dl></dd>
3701: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3702: <dd><dl>
3703: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3704: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3705: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3706: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 3707: <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 3708: <dd><dl>
3709: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3710: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3711: </dl></dd>
1.128 wiz 3712: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3713: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3714: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3715: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3716: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3717: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3718: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3719: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3720: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3721: <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 3722: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3723: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3724: </dl></dd>
3725: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3726: <dd><dl>
3727: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3728: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3729: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3730: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3731: </dl></dd>
3732: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3733: <dd><dl>
3734: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3735: <dd><dl>
3736: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 3737: <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 3738: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3739: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3740: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3741: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3742: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3743: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3744: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3745: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3746: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3747: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3748: </dl></dd>
1.128 wiz 3749: <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 3750: <dd><dl>
3751: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3752: <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>
3753: </dl></dd>
1.128 wiz 3754: <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 3755: <dd><dl>
3756: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3757: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3758: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3759: </dl></dd>
3760: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3761: <dd><dl>
3762: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3763: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3764: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 3765: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3766: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 3767: </dl></dd>
1.128 wiz 3768: <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 3769: <dd><dl>
3770: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3771: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 3772: <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 3773: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3774: </dl></dd>
1.128 wiz 3775: <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 3776: <dd><dl>
3777: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3778: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3779: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3780: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3781: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3782: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3783: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3784: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3785: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3786: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3787: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3788: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3789: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3790: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3791: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3792: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3793: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3794: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3795: emulation</a></span></dt>
1.106 rillig 3796: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3797: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3798: </dl></dd>
1.106 rillig 3799: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3800: </dl></dd>
1.106 rillig 3801: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3802: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3803: <dd><dl>
1.106 rillig 3804: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3805: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3806: <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 3807: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 3808: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3809: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3810: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3811: </dl></dd>
3812: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3813: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3814: <dd><dl>
3815: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3816: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3817: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3818: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3819: </dl></dd>
1.75 rillig 3820: </dl>
3821: </div>
1.77 rillig 3822: </div>
1.148 ! asau 3823: <div class="chapter">
1.77 rillig 3824: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3825: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3826: <div class="toc">
3827: <p><b>Table of Contents</b></p>
3828: <dl>
1.106 rillig 3829: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3830: <dd><dl>
1.106 rillig 3831: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3832: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3833: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3834: </dl></dd>
1.106 rillig 3835: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3836: <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 3837: </dl>
3838: </div>
1.77 rillig 3839: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3840: most likely have a URL from where you can download the source
3841: code. Starting with this URL, creating a package involves only a
3842: few steps.</p>
1.128 wiz 3843: <div class="procedure"><ol class="procedure" type="1">
1.148 ! asau 3844: <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>
! 3845: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 3846: category in which you want to place your package. You can also create a
3847: directory of your own (maybe called <code class="filename">local</code>). In that
3848: category directory, create another directory for your package and change
3849: into it.</p></li>
1.148 ! asau 3850: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3851: you for a URL. Enter the URL of the distribution file (in most cases a
3852: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3853: of your package are created automatically. The distribution file is
3854: extracted automatically to fill in some details in the
3855: <code class="filename">Makefile</code> that would otherwise have to be done
3856: manually.</p></li>
1.148 ! asau 3857: <li class="step">
1.91 rillig 3858: <p>Examine the extracted files to determine the dependencies of
3859: your package. Ideally, this is mentioned in some
3860: <code class="filename">README</code> file, but things may differ. For each of
3861: these dependencies, look where it exists in pkgsrc, and if there is a
3862: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3863: line to your package <code class="filename">Makefile</code> which includes that
3864: file just before the last line. If the
1.132 spz 3865: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3866: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3867: <p>If you just need binaries from a package, add a
1.91 rillig 3868: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3869: version of the dependency and where it can be found in pkgsrc. This line
3870: should be placed in the third paragraph. If the dependency is only
3871: needed for building the package, but not when using it, use
3872: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3873: Your package may then look like this:</p>
1.77 rillig 3874: <pre class="programlisting">
1.100 rillig 3875: [...]
1.77 rillig 3876:
1.100 rillig 3877: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3878: DEPENDS+= screen-[0-9]*:../../misc/screen
3879: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3880:
1.100 rillig 3881: [...]
1.77 rillig 3882:
1.100 rillig 3883: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3884: .include "../../devel/glib2/buildlink3.mk"
3885: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3886: </pre>
3887: </li>
1.148 ! asau 3888: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 wiz 3889: 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 3890: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3891: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3892: -e</strong></span>, which outputs additional
3893: explanations.</p></li>
1.148 ! asau 3894: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3895: 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 3896: over there, you can hopefully continue here.</p></li>
1.148 ! asau 3897: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3898: directory from the extracted files. Besides these files, a lot of cache
3899: files and other system information has been saved in the working
3900: directory, which may become wrong after you edited the
3901: <code class="filename">Makefile</code>.</p></li>
1.148 ! asau 3902: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 3903: 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 3904: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3905: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3906: everything works.</p></li>
1.148 ! asau 3907: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3908: contains a list of the files that are installed by the package, is
1.110 hubertf 3909: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3910: >PLIST</strong></span> to generate a probably correct list. Check
3911: the file using your preferred text editor to see if the list of
3912: files looks plausible.</p></li>
1.148 ! asau 3913: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3914: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 ! asau 3915: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3916: has been registered in the database of installed files, but with an
1.110 hubertf 3917: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3918: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3919: registered with the list of files from
3920: <code class="filename">PLIST</code>.</p></li>
1.148 ! asau 3921: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3922: package from the set of installed files.</p></li>
1.77 rillig 3923: </ol></div>
1.148 ! asau 3924: <div class="sect1">
1.91 rillig 3925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3926: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 ! asau 3927: <div class="sect2">
1.91 rillig 3928: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3929: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3930: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3931: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3932: </div>
1.148 ! asau 3933: <div class="sect2">
1.91 rillig 3934: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3935: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91 rillig 3936: <p>KDE applications should always include
3937: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3938: settings that are typical of KDE packages.</p>
3939: </div>
1.148 ! asau 3940: <div class="sect2">
1.118 imil 3941: <div class="titlepage"><div><div><h3 class="title">
3942: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3943: <p>Python modules and programs packages are easily created using a
3944: set of predefined variables.</p>
1.128 wiz 3945: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3946: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3947: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, set the
3948: <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">“<span class="quote">yes</span>”</span> so
1.118 imil 3949: pkgsrc will make use of this framework.
1.128 wiz 3950: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3951: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
1.118 imil 3952: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3953: to the name of the script.</p>
3954: <p>
3955: If the default Python versions are not supported by the software, set the
3956: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
3957: the software is known to work with, from the most recent to the older
3958: one, e.g.
3959: </p>
3960: <pre class="programlisting">
1.146 wiz 3961: PYTHON_VERSIONS_ACCEPTED= 31 27 26
1.118 imil 3962: </pre>
3963: <p>
3964: If the packaged software is a Python module, include
1.128 wiz 3965: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 3966: In this case, the package directory should be called
1.128 wiz 3967: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3968: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3969: </p>
3970: <pre class="programlisting">
3971: DISTNAME= foopymodule-1.2.10
3972: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3973: </pre>
3974: <p>If it is an application, also include
1.128 wiz 3975: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>
3976: before <span class="quote">“<span class="quote">extension.mk</span>”</span>.</p>
1.118 imil 3977: <p>If the packaged software, either it is an application or a module, is
3978: egg-aware, you only need to include
1.128 wiz 3979: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
1.118 imil 3980: <p>In order to correctly set the path to the Python interpreter, use the
3981: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3982: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
3983: For example :
1.118 imil 3984: </p>
3985: <pre class="programlisting">
1.142 wiz 3986: REPLACE_PYTHON= *.py
1.118 imil 3987: </pre>
3988: </div>
1.91 rillig 3989: </div>
1.148 ! asau 3990: <div class="sect1">
1.91 rillig 3991: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3992: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 ! asau 3993: <div class="sect2">
1.91 rillig 3994: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3995: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 ! asau 3996: <div class="sect3">
1.91 rillig 3997: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3998: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3999: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 4000: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 4001: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 4002: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 4003: <pre class="programlisting">
1.100 rillig 4004: <code class="prompt">$</code> mkdir www/nvu
4005: <code class="prompt">$</code> cd www/nvu
1.91 rillig 4006: </pre>
4007: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 4008: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 4009: <pre class="programlisting">
1.100 rillig 4010: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 4011: </pre>
4012: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4013: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 4014: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 4015: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4016: <code class="varname">COMMENT</code> fields. Then the package
4017: <code class="filename">Makefile</code> looked like that:</p>
4018: <pre class="programlisting">
1.100 rillig 4019: # $NetBSD$
4020: #
1.91 rillig 4021:
1.100 rillig 4022: DISTNAME= nvu-1.0-sources
4023: PKGNAME= nvu-1.0
4024: CATEGORIES= www
4025: MASTER_SITES= http://cvs.nvu.com/download/
4026: EXTRACT_SUFX= .tar.bz2
4027:
4028: MAINTAINER= rillig@NetBSD.org
4029: HOMEPAGE= http://cvs.nvu.com/
4030: COMMENT= Web Authoring System
1.91 rillig 4031:
1.100 rillig 4032: # url2pkg-marker (please do not remove this line.)
4033: .include "../../mk/bsd.pkg.mk"
1.91 rillig 4034: </pre>
4035: <p>Then, I quit the editor and watched pkgsrc downloading a large
4036: source archive:</p>
4037: <pre class="programlisting">
1.100 rillig 4038: url2pkg> Running "make makesum" ...
4039: => Required installed package digest>=20010302: digest-20060826 found
4040: => Fetching nvu-1.0-sources.tar.bz2
4041: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4042: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4043: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4044: url2pkg> Running "make extract" ...
4045: => Required installed package digest>=20010302: digest-20060826 found
4046: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4047: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4048: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4049: ===> Installing dependencies for nvu-1.0
4050: ===> Overriding tools for nvu-1.0
4051: ===> Extracting for nvu-1.0
4052: url2pkg> Adjusting the Makefile.
1.91 rillig 4053:
1.100 rillig 4054: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 4055:
1.100 rillig 4056: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 4057: </pre>
4058: </div>
1.148 ! asau 4059: <div class="sect3">
1.91 rillig 4060: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4061: <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 4062: <p>Now that the package has been extracted, let's see what's inside
4063: it. The package has a <code class="filename">README.txt</code>, but that only
4064: says something about mozilla, so it's probably useless for seeing what
4065: dependencies this package has. But since there is a GNU configure script
4066: in the package, let's hope that it will complain about everything it
4067: needs.</p>
4068: <pre class="programlisting">
1.100 rillig 4069: <code class="prompt">$</code> bmake
4070: => Required installed package digest>=20010302: digest-20060826 found
4071: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4072: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4073: ===> Patching for nvu-1.0
4074: ===> Creating toolchain wrappers for nvu-1.0
4075: ===> Configuring for nvu-1.0
4076: [...]
4077: configure: error: Perl 5.004 or higher is required.
4078: [...]
4079: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4080: [...]
1.91 rillig 4081: </pre>
4082: <p>That worked quite well. So I opened the package Makefile in my
4083: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 4084: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 4085: package have changed now, and since a perl wrapper is automatically
1.128 wiz 4086: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 4087: from scratch.</p>
4088: <pre class="programlisting">
1.100 rillig 4089: <code class="prompt">$</code> bmake clean
4090: ===> Cleaning for nvu-1.0
4091: <code class="prompt">$</code> bmake
4092: [...]
4093: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4094: GNU Make. You will not be able to build Mozilla without GNU Make.
4095: [...]
1.91 rillig 4096: </pre>
1.128 wiz 4097: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 4098: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4099: <pre class="programlisting">
1.100 rillig 4100: [...]
4101: checking for GTK - version >= 1.2.0... no
4102: *** Could not run GTK test program, checking why...
4103: [...]
1.91 rillig 4104: </pre>
4105: <p>Now to the other dependencies. The first question is: Where is the
4106: GTK package hidden in pkgsrc?</p>
4107: <pre class="programlisting">
1.100 rillig 4108: <code class="prompt">$</code> echo ../../*/gtk*
4109: [many packages ...]
4110: <code class="prompt">$</code> echo ../../*/gtk
4111: ../../x11/gtk
4112: <code class="prompt">$</code> echo ../../*/gtk2
4113: ../../x11/gtk2
4114: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4115: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4116: </pre>
4117: <p>The first try was definitely too broad. The second one had exactly
4118: one result, which is very good. But there is one pitfall with GNOME
4119: packages. Before GNOME 2 had been released, there were already many
4120: GNOME 1 packages in pkgsrc. To be able to continue to use these
4121: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 4122: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 4123: whether this was the case here, and indeed it was.</p>
4124: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4125: file, adding the dependency is very easy. I just inserted an
4126: <code class="literal">.include</code> line before the last line of the package
4127: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4128: <pre class="programlisting">
1.100 rillig 4129: [...]
4130: .include "../../x11/gtk2/buildlink3.mk"
4131: .include "../../mk/bsd.pkg.mk
1.91 rillig 4132: </pre>
1.110 hubertf 4133: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 4134: was:</p>
4135: <pre class="programlisting">
1.100 rillig 4136: [...]
4137: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4138: checking for GTK - version >= 1.2.0... no
4139: *** Could not run GTK test program, checking why...
4140: *** The test program failed to compile or link. See the file config.log for the
4141: *** exact error that occured. This usually means GTK was incorrectly installed
4142: *** or that you have moved GTK since it was installed. In the latter case, you
4143: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4144: configure: error: Test for GTK failed.
4145: [...]
1.91 rillig 4146: </pre>
1.128 wiz 4147: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
4148: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 4149: told me that this package really wanted to have the GNOME 1 version of
4150: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 4151: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 4152: So I changed the <code class="literal">x11/gtk2</code> to
4153: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4154: and tried again.</p>
4155: <pre class="programlisting">
1.100 rillig 4156: [...]
4157: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" -I../../../dist/include/xpcom -I../../../dist/include -I/tmp/roland/pkgsrc/www/nvu/work.bacc/mozilla/dist/include/nspr -I/usr/X11R6/include -fPIC -DPIC -I/home/roland/pkg/include -I/usr/include -I/usr/X11R6/include -Wall -W -Wno-unused -Wpointer-arith -Wcast-align -Wno-long-long -pedantic -O2 -I/home/roland/pkg/include -I/usr/include -Dunix -pthread -pipe -DDEBUG -D_DEBUG -DDEBUG_roland -DTRACING -g -I/home/roland/pkg/include/glib/glib-1.2 -I/home/roland/pkg/lib/glib/include -I/usr/pkg/include/orbit-1.0 -I/home/roland/pkg/include -I/usr/include -I/usr/X11R6/include -include ../../../mozilla-config.h -DMOZILLA_CLIENT -Wp,-MD,.deps/xpidl.pp xpidl.c
4158: In file included from xpidl.c:42:
4159: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4160: In file included from xpidl.c:42:
4161: xpidl.h:132: error: parse error before "IDL_ns"
4162: [...]
1.91 rillig 4163: </pre>
4164: <p>The package still does not find all of its dependencies. Now the
4165: question is: Which package provides the
4166: <code class="filename">libIDL/IDL.h</code> header file?</p>
4167: <pre class="programlisting">
1.100 rillig 4168: <code class="prompt">$</code> echo ../../*/*idl*
4169: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4170: <code class="prompt">$</code> echo ../../*/*IDL*
4171: ../../net/libIDL
1.91 rillig 4172: </pre>
4173: <p>Let's take the one from the second try. So I included the
4174: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4175: again. But the error didn't change. After digging through some of the
4176: code, I concluded that the build process of the package was broken and
4177: couldn't have ever worked, but since the Mozilla source tree is quite
4178: large, I didn't want to fix it. So I added the following to the package
4179: <code class="filename">Makefile</code> and tried again:</p>
4180: <pre class="programlisting">
1.100 rillig 4181: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4182: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4183: </pre>
4184: <p>The latter line is needed because the package expects the library
4185: <code class="filename">libIDL.so</code>, but only
4186: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4187: wrapper to rewrite that on the fly.</p>
4188: <p>The next problem was related to a recent change of the FreeType
4189: 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>
4190: which patch files were relevant for this issue and copied them to the
4191: <code class="filename">patches</code> directory. Then I retried, fixed the
4192: patches so that they applied cleanly and retried again. This time,
4193: everything worked.</p>
4194: </div>
1.148 ! asau 4195: <div class="sect3">
1.91 rillig 4196: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4197: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 4198: <pre class="programlisting">
1.100 rillig 4199: <code class="prompt">$</code> bmake CHECK_FILES=no install
4200: [...]
4201: <code class="prompt">$</code> bmake print-PLIST >PLIST
4202: <code class="prompt">$</code> bmake deinstall
4203: <code class="prompt">$</code> bmake install
1.91 rillig 4204: </pre>
4205: </div>
4206: </div>
4207: </div>
1.77 rillig 4208: </div>
1.148 ! asau 4209: <div class="chapter">
1.75 rillig 4210: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4211: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4212: <div class="toc">
4213: <p><b>Table of Contents</b></p>
4214: <dl>
1.128 wiz 4215: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4216: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 4217: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4218: <dd><dl>
4219: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4220: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4221: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4222: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4223: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4224: </dl></dd>
4225: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4226: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4227: <dd><dl>
4228: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4229: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4230: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4231: </dl></dd>
1.128 wiz 4232: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4233: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4234: </dl>
4235: </div>
1.87 wiz 4236: <p>Whenever you're preparing a package, there are a number of
4237: files involved which are described in the following
4238: sections.</p>
1.148 ! asau 4239: <div class="sect1">
1.75 rillig 4240: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4241: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 4242: </h2></div></div></div>
1.75 rillig 4243: <p>Building, installation and creation of a binary package are all
1.87 wiz 4244: controlled by the package's <code class="filename">Makefile</code>.
4245: The <code class="filename">Makefile</code> describes various things about
4246: a package, for example from where to get it, how to configure,
4247: build, and install it.</p>
1.76 rillig 4248: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4249: sections that describe the package.</p>
1.75 rillig 4250: <p>In the first section there are the following variables, which
1.87 wiz 4251: should appear exactly in the order given here. The order and
4252: grouping of the variables is mostly historical and has no further
4253: meaning.</p>
1.148 ! asau 4254: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4255: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4256: distribution file to be downloaded from the package's
4257: website.</p></li>
1.128 wiz 4258: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4259: package, as used by pkgsrc. You only need to provide it if
4260: <code class="varname">DISTNAME</code> (which is the default) is not a good
4261: name for the package in pkgsrc. Usually it is the pkgsrc
4262: directory name together with the version number. It must match the
4263: regular expression
4264: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4265: starts with a letter or digit, and contains only letters, digits,
4266: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 4267: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.87 wiz 4268: the package file to create if the <code class="varname">PKGNAME</code>
4269: isn't unique on a SVR4 system. The default is
4270: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4271: <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 4272: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4273: does not produce an unique package name on a SVR4 system.
4274: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4275: characters.</p></li>
1.128 wiz 4276: <li class="listitem">
1.75 rillig 4277: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4278: which the package fits in. You can choose any of the top-level
4279: directories of pkgsrc for it.</p>
1.75 rillig 4280: <p>Currently the following values are available for
1.87 wiz 4281: <code class="varname">CATEGORIES</code>. If more than
4282: one is used, they need to be separated by spaces:</p>
1.75 rillig 4283: <pre class="programlisting">
1.100 rillig 4284: archivers cross geography meta-pkgs security
4285: audio databases graphics misc shells
4286: benchmarks devel ham multimedia sysutils
4287: biology editors inputmethod net textproc
4288: cad emulators lang news time
4289: chat finance mail parallel wm
4290: comms fonts math pkgtools www
4291: converters games mbone print x11
4292: </pre>
1.75 rillig 4293: </li>
1.128 wiz 4294: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4295: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4296: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4297: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 4298: <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 4299: </ul></div>
4300: <p>The second section contains information about separately
1.87 wiz 4301: downloaded patches, if any.
4302: </p>
1.148 ! asau 4303: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4304: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4305: Name(s) of additional files that contain distribution patches.
4306: There is no default. pkgsrc will look for them at
4307: <code class="varname">PATCH_SITES</code>.
4308: They will automatically be uncompressed before patching if
4309: the names end with <code class="filename">.gz</code> or
4310: <code class="filename">.Z</code>.</p></li>
1.128 wiz 4311: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4312: Primary location(s) for distribution patch files (see
4313: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4314: </ul></div>
4315: <p>The third section contains the following variables.
1.87 wiz 4316: </p>
1.148 ! asau 4317: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4318: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4319: address of the person who feels responsible for this package,
4320: and who is most likely to look at problems or questions regarding
1.136 dholland 4321: 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 4322: Other developers may contact the <code class="varname">MAINTAINER</code>
4323: before making changes to the package, but are not required to
4324: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4325: to yourself. If you really can't maintain the package for future
4326: updates, set it to
1.110 hubertf 4327: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 4328: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4329: of <code class="varname">MAINTAINER</code> when you do not want other
4330: developers to update or change the package without contacting
4331: you first. A package Makefile should contain one of
4332: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4333: not both. </p></li>
1.128 wiz 4334: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4335: find more information about the package.</p></li>
1.128 wiz 4336: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4337: description of the package (should not include the package
4338: name).</p></li>
1.75 rillig 4339: </ul></div>
4340: <p>Other variables that affect the build:
1.87 wiz 4341: </p>
1.148 ! asau 4342: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 4343: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4344: interesting distribution files of the package are found. The
4345: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4346: works for most packages.</p>
1.75 rillig 4347: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4348: (most GNU software does, for instance), but extracts itself in
4349: the current directory, you should set
4350: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4351: <p>If a package doesn't create a subdirectory with the
4352: name of <code class="varname">DISTNAME</code> but some different name,
4353: set <code class="varname">WRKSRC</code> to point to the proper name in
4354: <code class="filename">${WRKDIR}</code>, for example
4355: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4356: <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 4357: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4358: taken from the <code class="varname">WRKDIR_BASENAME</code>
4359: variable. By default, its value is
4360: <code class="filename">work</code>. If you want to use the same
4361: pkgsrc tree for building different kinds of binary packages,
4362: you can change the variable according to your needs. Two
4363: other variables handle common cases of setting
4364: <code class="varname">WRKDIR_BASENAME</code> individually. If
4365: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4366: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4367: the host's name is attached to the directory name. If
4368: <code class="varname">OBJMACHINE</code> is defined, the platform name
4369: is attached, which might look like
4370: <code class="filename">work.i386</code> or
4371: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4372: </li></ul></div>
4373: <p>Please pay attention to the following gotchas:</p>
1.148 ! asau 4374: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4375: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4376: installed in compressed form by the package. For packages using
4377: BSD-style makefiles which honor MANZ, there is
4378: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 4379: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4380: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4381: below).</p></li>
1.128 wiz 4382: <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 4383: </ul></div>
4384: </div>
1.148 ! asau 4385: <div class="sect1">
1.75 rillig 4386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4387: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4388: </h2></div></div></div>
1.76 rillig 4389: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4390: digest, or checksum, of each distfile needed for the package. This
4391: ensures that the distfiles retrieved from the Internet have not been
4392: corrupted during transfer or altered by a malign force to introduce
4393: a security hole. Due to recent rumor about weaknesses of digest
4394: algorithms, all distfiles are protected using both SHA1 and RMD160
4395: message digests, as well as the file size.</p>
1.76 rillig 4396: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4397: checksums for all the patches found in the
1.110 hubertf 4398: <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 4399: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4400: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4401: command.</p>
1.75 rillig 4402: <p>Some packages have different sets of distfiles depending on
1.128 wiz 4403: 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 4404: <code class="filename">distinfo</code> file and care should be taken when
4405: upgrading such a package to ensure distfile information is not
4406: lost.</p>
1.75 rillig 4407: </div>
1.148 ! asau 4408: <div class="sect1">
1.75 rillig 4409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4410: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4411: <p>Many packages still don't work out-of-the box on the various
4412: platforms that are supported by pkgsrc. Therefore, a number of custom
4413: patch files are needed to make the package work. These patch files are
4414: found in the <code class="filename">patches/</code> directory.</p>
4415: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4416: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4417: 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 4418: order</a>.</p>
1.148 ! asau 4419: <div class="sect2">
1.93 rillig 4420: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4421: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4422: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4423: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4424: problems. (To force patches to apply with fuzz you can set
4425: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4426: should contain only changes for a single file, and no file should be
1.93 rillig 4427: patched by more than one patch file. This helps to keep future
4428: modifications simple.</p>
4429: <p>Each patch file is structured as follows: In the first line,
4430: there is the RCS Id of the patch itself. The second line should be
4431: empty for aesthetic reasons. After that, there should be a comment for
4432: each change that the patch does. There are a number of standard
4433: cases:</p>
1.148 ! asau 4434: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4435: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4436: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 4437: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4438: platform and other environment (for example, the compiler) that the
4439: patch is needed for.</p></li>
4440: </ul></div>
1.130 wiz 4441: <p>In all, the patch should be commented so that any
1.93 rillig 4442: developer who knows the code of the application can make some use of
4443: the patch. Special care should be taken for the upstream developers,
4444: since we generally want that they accept our patches, so we have less
4445: work in the future.</p>
4446: </div>
1.148 ! asau 4447: <div class="sect2">
1.93 rillig 4448: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4449: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4450: <p>One important thing to mention is to pay attention that no RCS
4451: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4452: later checked into the NetBSD CVS tree. Use the
1.110 hubertf 4453: <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 4454: problems.</p>
1.87 wiz 4455: <p>For even more automation, we recommend using
1.110 hubertf 4456: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4457: whole set of patches. You just have to backup files before you
4458: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4459: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4460: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4461: you upgrade a package this way, you can easily compare the new
4462: set of patches with the previously existing one with
1.130 wiz 4463: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4464: are replaced by new files, so carefully check if you want to take all
4465: the changes.</p>
1.87 wiz 4466: <p>When you have finished a package, remember to generate
1.110 hubertf 4467: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 4468: 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 4469: <p>When adding a patch that corrects a problem in the
4470: distfile (rather than e.g. enforcing pkgsrc's view of where
4471: man pages should go), send the patch as a bug report to the
4472: maintainer. This benefits non-pkgsrc users of the package,
4473: and usually makes it possible to remove the patch in future
4474: version.</p>
1.101 rillig 4475: <p>The file names of the patch files are usually of the form
1.130 wiz 4476: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4477: Many packages still use the previous convention
4478: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4479: but new patches should be of the form containing the filename.
4480: <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
4481: automatically.</p>
1.93 rillig 4482: </div>
1.148 ! asau 4483: <div class="sect2">
1.93 rillig 4484: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4485: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4486: <p>If you want to share patches between multiple packages
4487: in pkgsrc, e.g. because they use the same distfiles, set
4488: <code class="varname">PATCHDIR</code> to the path where the patch files
4489: can be found, e.g.:</p>
4490: <pre class="programlisting">
1.100 rillig 4491: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4492: </pre>
1.75 rillig 4493: <p>Patch files that are distributed by the author or other
1.87 wiz 4494: maintainers can be listed in
4495: <code class="varname">PATCHFILES</code>.</p>
4496: <p>If it is desired to store any patches that should not be
4497: committed into pkgsrc, they can be kept outside the pkgsrc
4498: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4499: directory tree there is expected to have the same
1.128 wiz 4500: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4501: patches are expected to be stored inside these dirs (also
4502: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4503: example, if you want to keep a private patch for
4504: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4505: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4506: files in the named directory are expected to be patch files,
4507: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4508: applied</em></span>.</p>
1.93 rillig 4509: </div>
1.148 ! asau 4510: <div class="sect2">
1.85 jmmv 4511: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4512: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4513: <p>When fixing a portability issue in the code do not use
4514: preprocessor magic to check for the current operating system nor
4515: platform. Doing so hurts portability to other platforms because
4516: the OS-specific details are not abstracted appropriately.</p>
4517: <p>The general rule to follow is: instead of checking for the
4518: operating system the application is being built on, check for the
4519: specific <span class="emphasis"><em>features</em></span> you need. For example,
4520: instead of assuming that kqueue is available under NetBSD and
4521: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4522: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4523: yes, this generally involves patching the
1.110 hubertf 4524: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4525: that prevents some OSes from adopting interfaces from other OSes
4526: (e.g. Linux implementing kqueue), something that the above checks
4527: cannot take into account.</p>
4528: <p>Of course, checking for features generally involves more
4529: work on the developer's side, but the resulting changes are
1.87 wiz 4530: cleaner and there are chances they will work on many other
1.85 jmmv 4531: platforms. Not to mention that there are higher chances of being
4532: later integrated into the mainstream sources. Remember:
4533: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4534: <p>Some typical examples:</p>
4535: <div class="table">
1.106 rillig 4536: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4537: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4538: <colgroup>
4539: <col>
4540: <col>
4541: <col>
4542: </colgroup>
4543: <thead><tr>
4544: <th>Where</th>
4545: <th>Incorrect</th>
4546: <th>Correct</th>
4547: </tr></thead>
4548: <tbody>
4549: <tr>
4550: <td>configure script</td>
4551: <td>
1.100 rillig 4552: <pre class="programlisting">
4553: case ${target_os} in
4554: netbsd*) have_kvm=yes ;;
4555: *) have_kvm=no ;;
4556: esac
4557: </pre>
1.85 jmmv 4558: </td>
4559: <td>
1.100 rillig 4560: <pre class="programlisting">
4561: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4562: </pre>
1.85 jmmv 4563: </td>
4564: </tr>
4565: <tr>
4566: <td>C source file</td>
4567: <td>
1.100 rillig 4568: <pre class="programlisting">
4569: #if defined(__NetBSD__)
4570: # include <sys/event.h>
4571: #endif
4572: </pre>
1.85 jmmv 4573: </td>
4574: <td>
1.100 rillig 4575: <pre class="programlisting">
4576: #if defined(HAVE_SYS_EVENT_H)
4577: # include <sys/event.h>
4578: #endif
4579: </pre>
1.85 jmmv 4580: </td>
4581: </tr>
4582: <tr>
4583: <td>C source file</td>
4584: <td>
1.100 rillig 4585: <pre class="programlisting">
4586: int
4587: monitor_file(...)
4588: {
4589: #if defined(__NetBSD__)
4590: int fd = kqueue();
4591: ...
4592: #else
4593: ...
4594: #endif
4595: }
4596: </pre>
1.85 jmmv 4597: </td>
4598: <td>
1.100 rillig 4599: <pre class="programlisting">
4600: int
4601: monitor_file(...)
4602: {
4603: #if defined(HAVE_KQUEUE)
4604: int fd = kqueue();
4605: ...
4606: #else
4607: ...
4608: #endif
4609: }
4610: </pre>
1.85 jmmv 4611: </td>
4612: </tr>
4613: </tbody>
1.91 rillig 4614: </table></div>
1.85 jmmv 4615: </div>
1.91 rillig 4616: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4617: 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
4618: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4619: 2</a>). It summarizes multiple details on how to make
4620: software easier to package; all the suggestions in it were
4621: collected from our experience in pkgsrc work, so they are possibly
4622: helpful when creating patches too.</p>
4623: </div>
1.148 ! asau 4624: <div class="sect2">
1.85 jmmv 4625: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4626: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4627: <p>Always, always, <span class="strong"><strong>always</strong></span>
4628: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4629: improvements you do to a package to the mainstream developers.
4630: This is the only way to get their attention on portability issues
4631: and to ensure that future versions can be built out-of-the box on
4632: NetBSD. Furthermore, any user that gets newer distfiles will get
4633: the fixes straight from the packaged code.</p>
1.93 rillig 4634: <p>This generally involves cleaning up the patches
4635: (because sometimes the patches that are
1.147 wiz 4636: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 4637: appropriate trackers for the projects and working with the
4638: mainstream authors to accept your changes. It is
4639: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4640: the packages in pkgsrc are kept simple and thus further changes
4641: can be done without much hassle.</p>
1.130 wiz 4642: <p>When you have done this, please add a URL to the upstream
4643: bug report to the patch comment.</p>
1.85 jmmv 4644: <p>Support the idea of free software!</p>
4645: </div>
1.75 rillig 4646: </div>
1.148 ! asau 4647: <div class="sect1">
1.75 rillig 4648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4649: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 ! asau 4650: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4651: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4652: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4653: any credits where they are due. Please bear in mind that others do not
4654: share your sense of humour (or spelling idiosyncrasies), and that others
4655: will read everything that you write here.</p></dd>
1.76 rillig 4656: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4657: <dd><p>This file governs the files that are installed on your
4658: system: all the binaries, manual pages, etc. There are other
4659: directives which may be entered in this file, to control the
4660: creation and deletion of directories, and the location of
1.110 hubertf 4661: 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 4662: information.</p></dd>
1.75 rillig 4663: </dl></div>
4664: </div>
1.148 ! asau 4665: <div class="sect1">
1.75 rillig 4666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4667: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 ! asau 4668: <div class="sect2">
1.78 rillig 4669: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4670: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 ! asau 4671: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4672: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 4673: <dd>
1.136 dholland 4674: <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 4675: First time after package extraction and before files are
4676: moved in place, the second time after the files to install
4677: are moved in place. This can be used to do any custom
4678: procedures not possible with @exec commands in
1.136 dholland 4679: <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
4680: <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 4681: Please note that you can modify variables in it easily by using
4682: <code class="varname">FILES_SUBST</code> in the package's
4683: <code class="filename">Makefile</code>:</p>
4684: <pre class="programlisting">
4685: FILES_SUBST+= SOMEVAR="somevalue"
4686: </pre>
4687: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4688: <code class="filename">INSTALL</code>. By default, substitution is
4689: performed for <code class="varname">PREFIX</code>,
4690: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4691: <code class="varname">VARBASE</code>, and a few others, type
4692: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4693: complete list.</p>
4694: </dd>
1.76 rillig 4695: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4696: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4697: this script's responsibility to clean up any additional messy details
4698: around the package's installation, since all pkg_delete knows is how to
4699: delete the files created in the original distribution.
1.136 dholland 4700: 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>
4701: 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 4702: The same methods to replace variables can be used as for
4703: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 4704: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4705: <dd>
4706: <p>This file is displayed after installation of the package.
1.87 wiz 4707: Useful for things like legal notices on almost-free
4708: software and hints for updating config files after
4709: installing modules for apache, PHP etc.
4710: Please note that you can modify variables in it easily by using
4711: <code class="varname">MESSAGE_SUBST</code> in the package's
4712: <code class="filename">Makefile</code>:</p>
1.75 rillig 4713: <pre class="programlisting">
1.100 rillig 4714: MESSAGE_SUBST+= SOMEVAR="somevalue"
4715: </pre>
1.128 wiz 4716: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4717: <code class="filename">MESSAGE</code>. By default, substitution is
4718: performed for <code class="varname">PKGNAME</code>,
4719: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4720: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4721: <code class="varname">X11BASE</code>,
4722: <code class="varname">PKG_SYSCONFDIR</code>,
4723: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4724: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4725: <p>You can display a different or additional files by
4726: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4727: default is <code class="filename">MESSAGE</code>, if the file
4728: exists.</p>
1.75 rillig 4729: </dd>
1.78 rillig 4730: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4731: <dd><p>FIXME: There is no documentation on the
4732: alternatives framework.</p></dd>
4733: </dl></div>
4734: </div>
1.148 ! asau 4735: <div class="sect2">
1.78 rillig 4736: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4737: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 ! asau 4738: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4739: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4740: <dd><p>This file contains arbitrary things that could
4741: also go into a <code class="filename">Makefile</code>, but its purpose is
4742: to be used by more than one package. This file should only be
4743: used when the packages that will use the file are known in
4744: advance. For other purposes it is often better to write a
4745: <code class="filename">*.mk</code> file and give it a good name that
4746: describes what it does.</p></dd>
4747: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4748: <dd><p>This file contains the dependency information
1.110 hubertf 4749: 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 4750: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4751: <dd><p>This file contains workarounds for compiler bugs
4752: and similar things. It is included automatically by the pkgsrc
4753: infrastructure, so you don't need an extra
4754: <code class="literal">.include</code> line for
4755: it.</p></dd>
4756: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4757: <dd><p>This file contains the code for the
1.110 hubertf 4758: 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 4759: selected by the user. If a package has only one or two options,
4760: it is equally acceptable to put the code directly into the
4761: <code class="filename">Makefile</code>.</p></dd>
4762: </dl></div>
4763: </div>
1.148 ! asau 4764: <div class="sect2">
1.78 rillig 4765: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4766: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 ! asau 4767: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4768: <dt><span class="term"><code class="filename">README*</code></span></dt>
4769: <dd><p>These files do not take place in the creation of
4770: a package and thus are purely informative to the package
4771: developer.</p></dd>
4772: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4773: <dd><p>This file contains things that need to be done
4774: to make the package even
4775: better.</p></dd>
1.75 rillig 4776: </dl></div>
4777: </div>
1.78 rillig 4778: </div>
1.148 ! asau 4779: <div class="sect1">
1.75 rillig 4780: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4781: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4782: </h2></div></div></div>
1.110 hubertf 4783: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4784: unpacked into the directory denoted by
4785: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4786: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4787: directory is also used to keep various timestamp files.
4788: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4789: The default is <code class="filename">${.CURDIR}/work</code>
4790: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4791: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4792: </div>
1.148 ! asau 4793: <div class="sect1">
1.75 rillig 4794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4795: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4796: </h2></div></div></div>
1.75 rillig 4797: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4798: to configuration or building, you could place these files here and use
1.110 hubertf 4799: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4800: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4801: this. Alternatively, you could simply diff the file against
4802: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4803: the creation of this file.</p>
4804: <p>If you want to share files in this way with other
4805: packages, set the <code class="varname">FILESDIR</code> variable to point
4806: to the other package's <code class="filename">files</code> directory,
4807: e.g.:</p>
4808: <pre class="programlisting">
1.100 rillig 4809: FILESDIR=${.CURDIR}/../xemacs/files
4810: </pre>
1.75 rillig 4811: </div>
4812: </div>
1.148 ! asau 4813: <div class="chapter">
1.75 rillig 4814: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4815: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4816: <div class="toc">
4817: <p><b>Table of Contents</b></p>
4818: <dl>
1.106 rillig 4819: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4820: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4821: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4822: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4823: <dd><dl>
4824: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4825: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4826: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4827: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4828: <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 4829: </dl></dd>
4830: </dl>
4831: </div>
1.76 rillig 4832: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4833: each of which forms a well-defined part of the pkgsrc system. Using
1.136 dholland 4834: 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 4835: like pkgsrc requires some discipline to keep the code correct and
4836: understandable.</p>
1.76 rillig 4837: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4838: programming are variables (which are actually macros) and shell
4839: commands. Among these shell commands may even be more complex ones
1.136 dholland 4840: 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 4841: as intended it is necessary to quote all variables correctly when they
4842: are used.</p>
4843: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4844: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4845: with them.</p>
1.148 ! asau 4846: <div class="sect1">
1.75 rillig 4847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4848: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 ! asau 4849: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4850: <p>When you are creating a file as a
4851: target of a rule, always write the data to a temporary file first
4852: and finally rename that file. Otherwise there might occur an error
4853: in the middle of generating the file, and when the user runs
1.136 dholland 4854: <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 4855: regenerated properly. Example:</p>
4856: <pre class="programlisting">
1.100 rillig 4857: wrong:
4858: @echo "line 1" > ${.TARGET}
4859: @echo "line 2" >> ${.TARGET}
4860: @false
4861:
4862: correct:
4863: @echo "line 1" > ${.TARGET}.tmp
4864: @echo "line 2" >> ${.TARGET}.tmp
4865: @false
4866: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4867: </pre>
1.110 hubertf 4868: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4869: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4870: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4871: correct</strong></span> gives an error message twice, as expected.</p>
1.136 dholland 4872: <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 4873: <code class="literal">${.TARGET}</code> in case of error, but this only
4874: happens when it is interrupted, for example by pressing
4875: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.136 dholland 4876: 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 4877: </li></ul></div>
4878: </div>
1.148 ! asau 4879: <div class="sect1">
1.97 rillig 4880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4881: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4882: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4883: can be processed using the five operators ``='', ``+='', ``?='',
1.136 dholland 4884: ``:='', 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 4885: page.</p>
4886: <p>When a variable's value is parsed from a
1.76 rillig 4887: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4888: backslash character ``\'' are handled specially. If a backslash is
4889: followed by a newline, any whitespace immediately in front of the
4890: backslash, the backslash, the newline, and any whitespace
4891: immediately behind the newline are replaced with a single space. A
4892: backslash character and an immediately following hash character are
4893: replaced with a single hash character. Otherwise, the backslash is
4894: passed as is. In a variable assignment, any hash character that is
4895: not preceded by a backslash starts a comment that continues upto the
4896: end of the logical line.</p>
4897: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4898: the only way to create a variable consisting of a single backslash
4899: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4900: <p>So far for defining variables. The other thing you can do with
4901: variables is evaluating them. A variable is evaluated when it is
4902: part of the right side of the ``:='' or the ``!='' operator, or
4903: directly before executing a shell command which the variable is part
1.136 dholland 4904: 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 4905: is, variables are not evaluated until there's no other way. The
4906: ``modifiers'' mentioned in the man page also evaluate the
4907: variable.</p>
4908: <p>Some of the modifiers split the string into words and then
4909: operate on the words, others operate on the string as a whole. When
4910: a string is split into words, it is split as you would expect
1.136 dholland 4911: 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 4912: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4913: loop does not follow the shell quoting rules but splits at sequences
4914: of whitespace.</p>
4915: <p>There are several types of variables that should be handled
4916: differently. Strings and two types of lists.</p>
1.148 ! asau 4917: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4918: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4919: characters. Nevertheless, you should restrict yourself to only
4920: using printable characters. Examples are
4921: <code class="varname">PREFIX</code> and
4922: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4923: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4924: are never exported to any shell command. Their elements are
4925: separated by whitespace. Therefore, the elements themselves cannot
4926: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4927: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4928: Examples are <code class="varname">DEPENDS</code> and
4929: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4930: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4931: may be exported to a shell command. Their elements can contain any
4932: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4933: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4934: <code class="varname">DISTFILES</code> and
4935: <code class="varname">MASTER_SITES</code>.</p></li>
4936: </ul></div>
1.148 ! asau 4937: <div class="sect2">
1.75 rillig 4938: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4939: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 ! asau 4940: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4941: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4942: are reserved for use by the pkgsrc infrastructure. They shall
4943: not be used by package
1.76 rillig 4944: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4945: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4946: lowercase variable names for the iteration
4947: variables.</p></li>
1.128 wiz 4948: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4949: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4950: <code class="varname">DISTFILES</code>.</p></li>
4951: </ul></div>
4952: </div>
4953: </div>
1.148 ! asau 4954: <div class="sect1">
1.75 rillig 4955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4956: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4957: <p>This section presents you with some code snippets you should
4958: use in your own code. If you don't find anything appropriate here,
4959: you should test your code and add it here.</p>
1.148 ! asau 4960: <div class="sect2">
1.75 rillig 4961: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4962: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4963: <pre class="programlisting">
1.100 rillig 4964: STRING= foo * bar `date`
4965: INT_LIST= # empty
4966: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4967: EXT_LIST= # empty
4968: ANOTHER_EXT_LIST= a=b c=d
4969:
4970: INT_LIST+= ${STRING} # 1
4971: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4972: EXT_LIST+= ${STRING:Q} # 3
4973: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4974: </pre>
1.75 rillig 4975: <p>When you add a string to an external list (example 3), it
4976: must be quoted. In all other cases, you must not add a quoting
4977: level. You must not merge internal and external lists, unless you
4978: are sure that all entries are correctly interpreted in both
4979: lists.</p>
4980: </div>
1.148 ! asau 4981: <div class="sect2">
1.75 rillig 4982: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4983: <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 4984: <pre class="programlisting">
1.100 rillig 4985: EXT_LIST= # empty
4986: .for i in ${INT_LIST}
4987: EXT_LIST+= ${i:Q}""
4988: .endfor
1.1 grant 4989: </pre>
1.75 rillig 4990: <p>This code converts the internal list
4991: <code class="varname">INT_LIST</code> into the external list
4992: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4993: are unquoted they must be quoted here. The reason for appending
4994: <code class="varname">""</code> is explained below.</p>
4995: </div>
1.148 ! asau 4996: <div class="sect2">
1.75 rillig 4997: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4998: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4999: <p>Sometimes you may want to print an arbitrary string. There
5000: are many ways to get it wrong and only few that can handle every
5001: nastiness.</p>
1.75 rillig 5002: <pre class="programlisting">
1.100 rillig 5003: STRING= foo bar < > * `date` $$HOME ' "
5004: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 5005:
1.100 rillig 5006: all:
5007: echo ${STRING} # 1
5008: echo "${STRING}" # 2
5009: echo "${STRING:Q}" # 3
5010: echo ${STRING:Q} # 4
5011: echo x${STRING:Q} | sed 1s,.,, # 5
5012: printf "%s\\n" ${STRING:Q}"" # 6
5013: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 5014: </pre>
1.75 rillig 5015: <p>Example 1 leads to a syntax error in the shell, as the
5016: characters are just copied.</p>
5017: <p>Example 2 leads to a syntax error too, and if you leave out
5018: the last " character from <code class="varname">${STRING}</code>,
1.136 dholland 5019: <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 5020: variable would be evaluated, too.</p>
5021: <p>Example 3 outputs each space character preceded by a
5022: backslash (or not), depending on the implementation of the
1.136 dholland 5023: <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 5024: <p>Example 4 handles correctly every string that does not start
5025: with a dash. In that case, the result depends on the
1.136 dholland 5026: 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 5027: guarantee that your input does not start with a dash, this form is
5028: appropriate.</p>
5029: <p>Example 5 handles even the case of a leading dash
5030: correctly.</p>
1.79 rillig 5031: <p>Example 6 also works with every string and is the
5032: light-weight solution, since it does not involve a pipe, which has
5033: its own problems.</p>
1.75 rillig 5034: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5035: because the quoting has already been done when adding elements to
5036: the list.</p>
5037: <p>As internal lists shall not be passed to the shell, there is
5038: no example for it.</p>
5039: </div>
1.148 ! asau 5040: <div class="sect2">
1.75 rillig 5041: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5042: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 5043: <p>There are many possible sources of wrongly quoted variables.
5044: This section lists some of the commonly known ones.</p>
1.148 ! asau 5045: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5046: <li class="listitem">
1.75 rillig 5047: <p>Whenever you use the value of a list, think
5048: about what happens to leading or trailing whitespace. If the
5049: list is a well-formed shell expression, you can apply the
5050: <code class="varname">:M*</code> modifier to strip leading and trailing
5051: whitespace from each word. The <code class="varname">:M</code> operator
5052: first splits its argument according to the rules of the shell,
5053: and then creates a new list consisting of all words that match
5054: the shell glob expression <code class="varname">*</code>, that is: all.
5055: One class of situations where this is needed is when adding a
5056: variable like <code class="varname">CPPFLAGS</code> to
5057: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5058: invokes other configure scripts, it strips the leading and
5059: trailing whitespace from the variable and then passes it to the
5060: other configure scripts. But these configure scripts expect the
5061: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5062: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5063: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5064: here is how we do it:</p>
5065: <pre class="programlisting">
1.100 rillig 5066: CPPFLAGS= # empty
5067: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5068: CPPFLAGS+= ${MY_CPPFLAGS}
5069:
5070: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5071:
5072: all:
5073: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5074: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5075: </pre>
1.75 rillig 5076: </li>
1.128 wiz 5077: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 5078: <code class="varname">${PREFIX}</code> is a properly quoted shell
5079: expression, but there is the C compiler after it, which also
5080: expects a properly quoted string (this time in C syntax). The
5081: version above is therefore only correct if
5082: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5083: or double quotes. If you want to allow these, you have to add
5084: another layer of quoting to each variable that is used as a C
5085: string literal. You cannot use the <code class="varname">:Q</code>
5086: operator for it, as this operator only works for the
5087: shell.</p></li>
1.128 wiz 5088: <li class="listitem">
1.75 rillig 5089: <p>Whenever a variable can be empty, the
5090: <code class="varname">:Q</code> operator can have surprising results. Here
5091: are two completely different cases which can be solved with the
5092: same trick.</p>
5093: <pre class="programlisting">
1.100 rillig 5094: EMPTY= # empty
5095: empty_test:
5096: for i in a ${EMPTY:Q} c; do \
5097: echo "$$i"; \
5098: done
5099:
5100: for_test:
5101: .for i in a:\ a:\test.txt
5102: echo ${i:Q}
5103: echo "foo"
5104: .endfor
1.1 grant 5105: </pre>
1.75 rillig 5106: <p>The first example will only print two of the three lines
5107: we might have expected. This is because
5108: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5109: the shell cannot see. The workaround is to write
5110: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5111: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5112: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5113: <p>The second example will only print three lines instead of
5114: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5115: This is because the backslash of the value
5116: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.136 dholland 5117: <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
5118: <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 5119: <code class="varname">${i:Q}""</code>.</p>
5120: </li>
5121: </ul></div>
5122: </div>
1.148 ! asau 5123: <div class="sect2">
1.75 rillig 5124: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5125: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5126: <p>The pkgsrc bmake program does not handle the following
5127: assignment correctly. In case <code class="varname">_othervar_</code>
5128: contains a ``-'' character, one of the closing braces is included
5129: in <code class="varname">${VAR}</code> after this code executes.</p>
5130: <pre class="programlisting">
1.100 rillig 5131: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5132: </pre>
1.75 rillig 5133: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5134: 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 5135: <code class="varname">bug1</code>.</p>
5136: </div>
5137: </div>
5138: </div>
1.148 ! asau 5139: <div class="chapter">
1.75 rillig 5140: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5141: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 5142: <div class="toc">
5143: <p><b>Table of Contents</b></p>
5144: <dl>
1.106 rillig 5145: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 5146: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5147: <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 5148: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5149: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 5150: <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 5151: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5152: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5153: </dl>
5154: </div>
1.87 wiz 5155: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 5156: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 5157: the package (relative to the <code class="filename">${PREFIX}</code>
5158: directory it's been installed in) plus some additional statements
1.136 dholland 5159: - 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 5160: This chapter addresses some issues that need attention when
5161: dealing with the <code class="filename">PLIST</code> file (or files, see
5162: below!).</p>
1.148 ! asau 5163: <div class="sect1">
1.75 rillig 5164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5165: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 5166: <p>Be sure to add a RCS ID line as the first thing in any
5167: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5168: <pre class="programlisting">
1.100 rillig 5169: @comment $NetBSD$
1.87 wiz 5170: </pre>
1.75 rillig 5171: </div>
1.148 ! asau 5172: <div class="sect1">
1.75 rillig 5173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5174: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 5175: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 5176: to output a PLIST that matches any new files since the package
1.110 hubertf 5177: 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 5178: more information on this target.</p>
1.75 rillig 5179: </div>
1.148 ! asau 5180: <div class="sect1">
1.75 rillig 5181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 5182: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 5183: </h2></div></div></div>
1.87 wiz 5184: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 5185: <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
5186: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 5187: <code class="varname">@comment</code>s instead of real
5188: <code class="varname">@dirrm</code> lines. You can also do this for
5189: specific directories and files, so that the results of that
5190: command are very close to reality. This helps <span class="emphasis"><em>a
5191: lot</em></span> during the update of packages.</p>
5192: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5193: of AWK patterns and actions that are used to filter the output of
5194: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5195: scripting you like to it, but be careful with quoting.</p>
5196: <p>For example, to get all files inside the
5197: <code class="filename">libdata/foo</code> directory removed from the
5198: resulting PLIST:</p>
5199: <pre class="programlisting">
1.100 rillig 5200: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5201: </pre>
5202: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5203: to a specific (shared) directory converted to
5204: <code class="varname">@comment</code>s:</p>
1.75 rillig 5205: <pre class="programlisting">
1.100 rillig 5206: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5207: </pre>
1.75 rillig 5208: </div>
1.148 ! asau 5209: <div class="sect1">
1.75 rillig 5210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5211: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5212: <p>A number of variables are substituted automatically in
5213: PLISTs when a package is installed on a system. This includes the
5214: following variables:</p>
1.148 ! asau 5215: <div class="variablelist"><dl class="variablelist">
1.75 rillig 5216: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5217: <dd>
5218: <p>Some packages like emacs and perl embed information
1.87 wiz 5219: about which architecture they were built on into the
5220: pathnames where they install their files. To handle this
5221: case, PLIST will be preprocessed before actually used, and
5222: the symbol
1.128 wiz 5223: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 5224: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 5225: same is done if the string
5226: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5227: PLIST somewhere - use this on packages that have GNU
5228: autoconf-created configure scripts.</p>
1.148 ! asau 5229: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 5230: <h3 class="title">Legacy note</h3>
5231: <p>There used to be a symbol
1.128 wiz 5232: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 5233: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 5234: -m</strong></span>, but that's no longer supported and has
5235: been removed.</p>
1.75 rillig 5236: </div>
5237: </dd>
5238: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5239: <dd>
5240: <p>Some packages want to embed the OS name and version
1.87 wiz 5241: into some paths. To do this, use these variables in the
5242: <code class="filename">PLIST</code>:
5243: </p>
1.148 ! asau 5244: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5245: <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>
5246: <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>
5247: <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 5248: </ul></div>
5249: </dd>
5250: </dl></div>
1.87 wiz 5251: <p>For a complete list of values which are replaced by
5252: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5253: search for <code class="varname">PLIST_SUBST</code>).</p>
5254: <p>If you want to change other variables not listed above, you
5255: can add variables and their expansions to this variable in the
1.110 hubertf 5256: 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 5257: <pre class="programlisting">
1.100 rillig 5258: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5259: </pre>
1.128 wiz 5260: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 5261: in the <code class="filename">PLIST</code> with
1.128 wiz 5262: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 5263: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 5264: the common case of conditionally including some
5265: <code class="filename">PLIST</code> entries. It can be done by adding
5266: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 5267: setting the corresponding <code class="varname">PLIST.foo</code> variable
5268: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 5269: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 5270: in the <code class="filename">PLIST</code> with either
1.128 wiz 5271: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5272: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 5273: For example, in <code class="filename">Makefile</code>:</p>
5274: <pre class="programlisting">
5275: PLIST_VARS+= foo
5276: .if <em class="replaceable"><code>condition</code></em>
5277: PLIST.foo= yes
5278: .else
5279: </pre>
5280: <p>And then in <code class="filename">PLIST</code>:</p>
5281: <pre class="programlisting">
5282: @comment $NetBSD$
5283: bin/bar
5284: man/man1/bar.1
5285: ${PLIST.foo}bin/foo
5286: ${PLIST.foo}man/man1/foo.1
5287: ${PLIST.foo}share/bar/foo.data
5288: ${PLIST.foo}@dirrm share/bar
5289: </pre>
1.75 rillig 5290: </div>
1.148 ! asau 5291: <div class="sect1">
1.75 rillig 5292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5293: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5294: <p>Man pages should be installed in compressed form if
1.87 wiz 5295: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5296: and uncompressed otherwise. To handle this in the
1.128 wiz 5297: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5298: appended/removed automatically for man pages according to
5299: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5300: or not, see above for details. This modification of the
5301: <code class="filename">PLIST</code> file is done on a copy of it, not
5302: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5303: </div>
1.148 ! asau 5304: <div class="sect1">
1.75 rillig 5305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5306: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5307: </h2></div></div></div>
1.76 rillig 5308: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5309: in generating the binary package, set the variable
5310: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.136 dholland 5311: 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 5312: important. The default for <code class="varname">PLIST_SRC</code> is
5313: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5314: </div>
1.148 ! asau 5315: <div class="sect1">
1.75 rillig 5316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5317: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5318: <p>Some packages decide to install a different set of files based on
1.87 wiz 5319: the operating system being used. These differences can be
5320: automatically handled by using the following files:</p>
1.148 ! asau 5321: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5322: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5323: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5324: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5325: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5326: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5327: </ul></div>
5328: </div>
1.148 ! asau 5329: <div class="sect1">
1.75 rillig 5330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5331: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.128 wiz 5332: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5333: multiple (and unrelated) packages install files. These
1.125 wiz 5334: directories were problematic because you had to add special
5335: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5336: centralized package handle them.</p>
1.125 wiz 5337: <p>In pkgsrc, it is now easy: Each package should create
5338: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5339: will remove any directories left empty after uninstalling a
5340: package.</p>
5341: <p>If a package needs an empty directory to work, create
5342: the directory during installation as usual, and also add an
5343: entry to the PLIST:
5344: </p>
1.87 wiz 5345: <pre class="programlisting">
1.125 wiz 5346: @pkgdir path/to/empty/directory
1.87 wiz 5347: </pre>
1.125 wiz 5348: <p>
5349: </p>
1.75 rillig 5350: </div>
5351: </div>
1.148 ! asau 5352: <div class="chapter">
1.75 rillig 5353: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5354: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5355: <div class="toc">
5356: <p><b>Table of Contents</b></p>
5357: <dl>
1.106 rillig 5358: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 5359: <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 5360: <dd><dl>
1.106 rillig 5361: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 5362: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5363: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5364: and
5365: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5366: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5367: </dl></dd>
1.128 wiz 5368: <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 5369: <dd><dl>
1.128 wiz 5370: <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 5371: <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 5372: </dl></dd>
5373: </dl>
5374: </div>
5375: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5376: are seen by a package's configure and build processes. This is implemented
5377: in a two step process:</p>
1.128 wiz 5378: <div class="orderedlist"><ol class="orderedlist" type="1">
5379: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5380: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5381: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 5382: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5383: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5384: <code class="option">-L${LOCALBASE}/lib</code> into references to
5385: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5386: native compiler on some operating systems look like GCC, so that
5387: packages that expect GCC won't require modifications to build with
5388: those native compilers.</p></li>
1.75 rillig 5389: </ol></div>
5390: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5391: package may be built consistently despite what other software may be
5392: installed. Please note that the normal system header and library paths,
5393: e.g. <code class="filename">/usr/include</code>,
5394: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5395: designed to insulate the package build from non-system-supplied
5396: software.</p>
1.148 ! asau 5397: <div class="sect1">
1.75 rillig 5398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5399: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5400: <p>The process of converting packages to use the buildlink3
1.128 wiz 5401: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5402: The things to keep in mind are:</p>
1.128 wiz 5403: <div class="orderedlist"><ol class="orderedlist" type="1">
5404: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5405: instead of the actual toolchain. Some packages are tricky,
5406: and the only way to know for sure is the check
5407: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5408: wrappers are being invoked.</p></li>
1.128 wiz 5409: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5410: the package Makefile, e.g. Java VMs, standalone shells,
5411: etc., because the code to symlink files into
5412: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 5413: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5414: </p></li>
1.128 wiz 5415: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5416: <code class="filename">buildlink3.mk</code> files that you list in a
5417: package's Makefile are added as dependencies for that package.
5418: </p></li>
1.75 rillig 5419: </ol></div>
1.87 wiz 5420: <p>If a dependency on a particular package is required for its libraries and
5421: headers, then we replace:</p>
1.75 rillig 5422: <pre class="programlisting">
1.100 rillig 5423: DEPENDS+= foo>=1.1.0:../../category/foo
5424: </pre>
1.75 rillig 5425: <p>with</p>
5426: <pre class="programlisting">
1.100 rillig 5427: .include "../../category/foo/buildlink3.mk"
5428: </pre>
1.75 rillig 5429: <p>The buildlink3.mk files usually define the required dependencies.
5430: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5431: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5432: <pre class="programlisting">
1.100 rillig 5433: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5434: .include "../../category/foo/buildlink3.mk"
5435: </pre>
1.76 rillig 5436: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5437: files in <code class="filename">pkgsrc/mk</code>
5438: that handle special package issues:</p>
1.148 ! asau 5439: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5440: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5441: the native or a pkgsrc Berkeley DB implementation based on
5442: the values of <code class="varname">BDB_ACCEPTED</code> and
5443: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 5444: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5445: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5446: 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 5447: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5448: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5449: adding a dependency on Heimdal or MIT-krb5 for packages that
5450: require a Kerberos 5 implementation.</p></li>
1.128 wiz 5451: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5452: system-provided Motif installation or adds a dependency on
1.91 rillig 5453: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>. The user can set
1.128 wiz 5454: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
5455: <span class="quote">“<span class="quote">lesstif</span>”</span>, or <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5456: which Motif version will be used.</p></li>
1.128 wiz 5457: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5458: variables that may be used by packages that use the
5459: Open Sound System (OSS) API.</p></li>
1.128 wiz 5460: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 5461: any of the Postgres versions in the variable
5462: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5463: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 5464: the file for more information.</p></li>
1.128 wiz 5465: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5466: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5467: 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 5468: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5469: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5470: library.</p></li>
1.75 rillig 5471: </ul></div>
1.76 rillig 5472: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5473: files provide a more complete
5474: description of how to use them properly.</p>
1.75 rillig 5475: </div>
1.148 ! asau 5476: <div class="sect1">
1.75 rillig 5477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5478: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5479: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5480: included by Makefiles to indicate the need to compile and link
5481: against header files and libraries provided by the package. A
5482: <code class="filename">buildlink3.mk</code> file should always provide
5483: enough information to add the correct type of dependency
5484: relationship and include any other
5485: <code class="filename">buildlink3.mk</code> files that it needs to find
5486: headers and libraries that it needs in turn.</p>
5487: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5488: 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 5489: package is highly recommended. For most packages, the following
5490: command will generate a good starting point for
5491: <code class="filename">buildlink3.mk</code> files:</p>
5492: <pre class="screen">
5493: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5494: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5495: </pre>
1.148 ! asau 5496: <div class="sect2">
1.75 rillig 5497: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5498: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5499: <p>The following real-life example
1.87 wiz 5500: <code class="filename">buildlink3.mk</code> is taken
5501: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5502: <pre class="programlisting">
1.120 snj 5503: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5504:
1.120 snj 5505: BUILDLINK_TREE+= tiff
1.1 grant 5506:
1.120 snj 5507: .if !defined(TIFF_BUILDLINK3_MK)
5508: TIFF_BUILDLINK3_MK:=
1.87 wiz 5509:
1.120 snj 5510: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5511: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5512: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5513:
1.100 rillig 5514: .include "../../devel/zlib/buildlink3.mk"
5515: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5516: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5517:
1.120 snj 5518: BUILDLINK_TREE+= -tiff
1.100 rillig 5519: </pre>
1.87 wiz 5520: <p>The header and footer manipulate
1.120 snj 5521: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5522: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5523: the dependency tree.</p>
5524: <p>The main section is protected from multiple inclusion
1.87 wiz 5525: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5526: added. Several important variables are set in the section:</p>
1.148 ! asau 5527: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5528: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5529: is the actual dependency recorded in the installed
5530: package; this should always be set using
1.110 hubertf 5531: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5532: we're appending to any pre-existing list of values. This
5533: variable should be set to the first version of the
1.133 wiz 5534: package that had an backwards-incompatible API change.
1.87 wiz 5535: </p></li>
1.128 wiz 5536: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5537: is the location of the <em class="replaceable"><code>pkg</code></em>
5538: pkgsrc directory.</p></li>
1.128 wiz 5539: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5540: (not shown above) controls whether we use
5541: <code class="varname">BUILD_DEPENDS</code> or
5542: <code class="varname">DEPENDS</code> to add the dependency on
5543: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5544: selected by setting
5545: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5546: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5547: used.</p></li>
1.128 wiz 5548: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5549: and
5550: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5551: (not shown above) are lists of subdirectories of
1.76 rillig 5552: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5553: to add to the header and library search paths. These
1.128 wiz 5554: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5555: respectively.</p></li>
1.128 wiz 5556: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5557: (not shown above) is the list of preprocessor flags to add
5558: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 5559: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5560: should be avoided and instead be handled using
5561: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5562: above.</p></li>
1.75 rillig 5563: </ul></div>
1.87 wiz 5564: <p>The following variables are all optionally defined within
5565: this second section (protected against multiple inclusion) and
5566: control which package files are symlinked into
5567: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5568: transformed during the symlinking:</p>
1.148 ! asau 5569: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5570: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5571: (not shown above) is a shell glob pattern relative to
1.76 rillig 5572: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5573: to be symlinked into
1.76 rillig 5574: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5575: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 5576: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5577: (not shown above) is a shell pipeline that
5578: outputs to stdout a list of files relative to
5579: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5580: The resulting files are to be symlinked
5581: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5582: this takes the <code class="filename">+CONTENTS</code> of a
5583: <em class="replaceable"><code>pkg</code></em> and filters it through
5584: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 5585: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5586: (not shown above) is a filter command that filters
1.76 rillig 5587: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5588: relative to
1.76 rillig 5589: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5590: on stdout. By default for overwrite packages,
5591: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5592: outputs the contents of the <code class="filename">include</code>
5593: and <code class="filename">lib</code> directories in the package
5594: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5595: it outputs any libtool archives in
1.87 wiz 5596: <code class="filename">lib</code> directories.</p></li>
1.128 wiz 5597: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5598: (not shown above) is a list of sed arguments used to
5599: transform the name of the source filename into a
1.110 hubertf 5600: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5601: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5602: </ul></div>
1.120 snj 5603: <p>This section can additionally include any
1.87 wiz 5604: <code class="filename">buildlink3.mk</code> needed for
5605: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5606: Including these <code class="filename">buildlink3.mk</code> files
5607: means that the headers and libraries for these
5608: dependencies are also symlinked into
5609: <code class="filename">${BUILDLINK_DIR}</code>
5610: whenever the <em class="replaceable"><code>pkg</code></em>
5611: <code class="filename">buildlink3.mk</code>
1.120 snj 5612: file is included. Dependencies are only added for directly
5613: include <code class="filename">buildlink3.mk</code> files.</p>
1.75 rillig 5614: </div>
1.148 ! asau 5615: <div class="sect2">
1.75 rillig 5616: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 5617: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 5618: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5619: and
5620: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5621: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5622: <p>These two variables differ in that one describes source
5623: compatibility (API) and the other binary compatibility (ABI).
5624: The difference is that a change in the API breaks compilation of
5625: programs while changes in the ABI stop compiled programs from
5626: running.</p>
5627: <p>Changes to the
1.134 wiz 5628: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5629: variable in a <code class="filename">buildlink3.mk</code> file happen
5630: very rarely. One possible reason is that all packages depending
5631: on this already need a newer version. In case it is bumped see
5632: the description below.</p>
5633: <p>The most common example of an ABI change is that the major
5634: version of a shared library is increased. In this case,
5635: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5636: should be adjusted to require at least the new package version.
5637: Then the packages that depend on this package need their
5638: <code class="varname">PKGREVISION</code>s increased and, if they have
5639: <code class="filename">buildlink3.mk</code> files, their
5640: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5641: adjusted, too. This is needed so pkgsrc will require the correct
5642: package dependency and not settle for an older one when building
5643: the source.</p>
1.110 hubertf 5644: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.133 wiz 5645: more information about dependencies on other packages,
5646: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5647: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5648: <p>Please take careful consideration before adjusting
5649: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5650: or
5651: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5652: as we don't want to cause unneeded package deletions and
5653: rebuilds. In many cases, new versions of packages work just
5654: fine with older dependencies.</p>
5655: <p>Also it is not needed to set
1.133 wiz 5656: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5657: when it is identical to
1.87 wiz 5658: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5659: </div>
5660: </div>
1.148 ! asau 5661: <div class="sect1">
1.75 rillig 5662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5663: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5664: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5665: coincide with headers and libraries present in the base system.
1.76 rillig 5666: Aside from a <code class="filename">buildlink3.mk</code> file, these
5667: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5668: file that includes the necessary checks to decide whether using
5669: the built-in software or the pkgsrc software is
1.87 wiz 5670: appropriate.</p>
5671: <p>The only requirements of a builtin.mk file for
5672: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 5673: <div class="orderedlist"><ol class="orderedlist" type="1">
5674: <li class="listitem"><p>It should set
1.87 wiz 5675: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5676: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5677: after it is included.</p></li>
1.128 wiz 5678: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5679: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5680: which is already set before the
5681: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 5682: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5683: is <span class="emphasis"><em>very</em></span> important and takes careful
5684: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5685: </ol></div>
1.148 ! asau 5686: <div class="sect2">
1.75 rillig 5687: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5688: <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 5689: <p>The following is the recommended template for builtin.mk
1.87 wiz 5690: files:</p>
1.75 rillig 5691: <pre class="programlisting">
1.100 rillig 5692: .if !defined(IS_BUILTIN.foo)
5693: #
5694: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5695: # genuinely exists in the system or not.
5696: #
5697: IS_BUILTIN.foo?= no
5698:
5699: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5700: # version can be determined.
5701: #
5702: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5703: BUILTIN_PKG.foo?= foo-1.0
5704: . endif
5705: .endif # IS_BUILTIN.foo
5706:
5707: .if !defined(USE_BUILTIN.foo)
5708: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5709: . if defined(BUILTIN_PKG.foo)
5710: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5711: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5712: USE_BUILTIN.foo!= \
5713: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5714: && ${ECHO} "yes" || ${ECHO} "no"
5715: . endif
5716: . endfor
5717: . endif
5718: .endif # USE_BUILTIN.foo
5719:
5720: CHECK_BUILTIN.foo?= no
5721: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5722: #
5723: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5724: # "yes" or "no".
5725: #
5726: .endif # CHECK_BUILTIN.foo
5727: </pre>
1.87 wiz 5728: <p>The first section sets
5729: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5730: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5731: in the base system. This should not be a base system software
5732: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 5733: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5734: included as part of the base system. This variable is only
5735: used internally within the <code class="filename">builtin.mk</code>
5736: file.</p>
5737: <p>The second section sets
5738: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5739: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5740: system if it exists (if
5741: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5742: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5743: within the <code class="filename">builtin.mk</code> file.</p>
5744: <p>The third section sets
5745: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5746: and is <span class="emphasis"><em>required</em></span> in all
5747: <code class="filename">builtin.mk</code> files. The code in this
5748: section must make the determination whether the built-in
5749: software is adequate to satisfy the dependencies listed in
5750: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5751: This is typically done by comparing
5752: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5753: against each of the dependencies in
5754: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5755: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5756: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5757: end of the <code class="filename">builtin.mk</code> file. Note that
5758: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5759: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5760: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5761: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5762: that the built-in version of the software is similar enough to
5763: be used as a replacement.</p>
5764: <p>The last section is guarded by
5765: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5766: and includes code that uses the value of
5767: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5768: set in the previous section. This typically includes, e.g.,
5769: adding additional dependency restrictions and listing additional
5770: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5771: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5772: </div>
1.148 ! asau 5773: <div class="sect2">
1.75 rillig 5774: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5775: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5776: <p>When building packages, it's possible to choose whether to set
5777: a global preference for using either the built-in (native)
5778: version or the pkgsrc version of software to satisfy a
5779: dependency. This is controlled by setting
5780: <code class="varname">PREFER_PKGSRC</code> and
5781: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 5782: 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 5783: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5784: use the pkgsrc versions of software, while
5785: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5786: built-in versions. Preferences are determined by the most
5787: specific instance of the package in either
5788: <code class="varname">PREFER_PKGSRC</code> or
5789: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5790: in neither or in both variables, then
5791: <code class="varname">PREFER_PKGSRC</code> has precedence over
5792: <code class="varname">PREFER_NATIVE</code>. For example, to require
5793: using pkgsrc versions of software for all but the most basic
5794: bits on a NetBSD system, you can set:</p>
5795: <pre class="programlisting">
1.100 rillig 5796: PREFER_PKGSRC= yes
5797: PREFER_NATIVE= getopt skey tcp_wrappers
5798: </pre>
1.87 wiz 5799: <p>A package <span class="emphasis"><em>must</em></span> have a
5800: <code class="filename">builtin.mk</code>
5801: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5802: otherwise it is simply ignored in that list.</p>
1.75 rillig 5803: </div>
5804: </div>
5805: </div>
1.148 ! asau 5806: <div class="chapter">
1.75 rillig 5807: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5808: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5809: <div class="toc">
5810: <p><b>Table of Contents</b></p>
5811: <dl>
1.106 rillig 5812: <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 5813: <dd><dl>
1.106 rillig 5814: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5815: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5816: </dl></dd>
1.106 rillig 5817: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5818: <dd><dl>
1.128 wiz 5819: <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 5820: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5821: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5822: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5823: </dl></dd>
5824: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5825: <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>
5826: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5827: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5828: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5829: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5830: <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 5831: </dl>
5832: </div>
5833: <p>This chapter describes the framework known as
5834: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 ! asau 5835: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5836: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5837: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5838: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5839: provided that packages are correctly designed.</p></li>
1.128 wiz 5840: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5841: <li class="listitem"><p>Registration of system users and groups.</p></li>
5842: <li class="listitem"><p>Registration of system shells.</p></li>
5843: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5844: </ul></div>
5845: <p>The following sections inspect each of the above points in detail.</p>
5846: <p>You may be thinking that many of the things described here could be
5847: easily done with simple code in the package's post-installation target
5848: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5849: as the code in them is only executed when building from source. Machines
5850: using binary packages could not benefit from it at all (as the code itself
5851: could be unavailable). Therefore, the only way to achieve any of the items
5852: described above is by means of the installation scripts, which are
5853: automatically generated by pkginstall.</p>
1.148 ! asau 5854: <div class="sect1">
1.75 rillig 5855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5856: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5857: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5858: of files and directories that belong to a package. The names used in it
1.76 rillig 5859: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5860: which means that it cannot register files outside this directory (absolute
5861: path names are not allowed). Despite this restriction, some packages need
5862: to install files outside this location; e.g., under
1.76 rillig 5863: <code class="filename">${VARBASE}</code> or
1.87 wiz 5864: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5865: is to create such files during installation time by using
5866: installation scripts.</p>
5867: <p>The generic installation scripts are shell scripts that can
5868: contain arbitrary code. The list of scripts to execute is taken from
5869: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5870: <code class="filename">INSTALL</code>. A similar variable exists for package
5871: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5872: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5873: commands, so they have the potential to create and manage files
5874: anywhere in the file system.</p>
5875: <p>Using these general installation files is not recommended, but
5876: may be needed in some special cases. One reason for avoiding them is
5877: that the user has to trust the packager that there is no unwanted or
5878: simply erroneous code included in the installation script. Also,
5879: previously there were many similar scripts for the same functionality,
5880: and fixing a common error involved finding and changing all of
5881: them.</p>
5882: <p>The pkginstall framework offers another, standardized way. It
5883: provides generic scripts to abstract the manipulation of such files
5884: and directories based on variables set in the package's
5885: <code class="filename">Makefile</code>. The rest of this section describes
5886: these variables.</p>
1.148 ! asau 5887: <div class="sect2">
1.75 rillig 5888: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5889: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5890: <p>The following variables can be set to request the creation of
5891: directories anywhere in the file system:</p>
1.148 ! asau 5892: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5893: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5894: contain a list of directories that should be created and should attempt
5895: to be destroyed by the installation scripts. The difference between
5896: the two is that the latter prompts the administrator to remove any
5897: directories that may be left after deinstallation (because they were
5898: not empty), while the former does not.</p></li>
1.128 wiz 5899: <li class="listitem">
1.75 rillig 5900: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5901: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5902: which directories should be created and should attempt to be destroyed
5903: by the installation scripts. Each tuple holds the following values,
5904: separated by spaces: the directory name, its owner, its group and its
5905: numerical mode. For example:</p>
5906: <pre class="programlisting">
1.100 rillig 5907: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5908: </pre>
1.75 rillig 5909: <p>The difference between the two is exactly the same as their
5910: non-<code class="varname">PERMS</code> counterparts.</p>
5911: </li>
5912: </ul></div>
5913: </div>
1.148 ! asau 5914: <div class="sect2">
1.75 rillig 5915: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5916: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5917: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5918: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5919: To overcome this problem, the only solution is to extract the file in the
5920: known place (i.e., inside the installation prefix) and copy it to the
5921: appropriate location during installation (done by the installation scripts
5922: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5923: file</em></span> in the following paragraphs, which describe the variables
5924: that can be used to automatically and consistently handle files outside the
5925: installation prefix:</p>
1.148 ! asau 5926: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5927: <li class="listitem">
1.75 rillig 5928: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5929: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5930: During installation time, the master file is copied to the target one
5931: if and only if the latter does not exist. Upon deinstallation, the
5932: target file is removed provided that it was not modified by the
5933: installation.</p>
5934: <p>The difference between the two is that the latter prompts the
5935: administrator to remove any files that may be left after
5936: deinstallation (because they were not empty), while the former does
5937: not.</p>
5938: </li>
1.128 wiz 5939: <li class="listitem">
1.75 rillig 5940: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5941: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5942: files as well as their target locations. For each of them, it also
5943: specifies their owner, their group and their numeric permissions, in
5944: this order. For example:</p>
5945: <pre class="programlisting">
1.137 wiz 5946: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5947: </pre>
1.75 rillig 5948: <p>The difference between the two is exactly the same as their
5949: non-<code class="varname">PERMS</code> counterparts.</p>
5950: </li>
5951: </ul></div>
5952: </div>
5953: </div>
1.148 ! asau 5954: <div class="sect1">
1.75 rillig 5955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5956: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5957: <p>Configuration files are special in the sense that they are installed
5958: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5959: need special treatment during installation (most of which is automated by
5960: pkginstall). The main concept you must bear in mind is that files marked
5961: as configuration files are automatically copied to the right place (somewhere
5962: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5963: and only if</em></span> they didn't exist before. Similarly, they will not
5964: be removed if they have local modifications. This ensures that
5965: administrators never lose any custom changes they may have made.</p>
1.148 ! asau 5966: <div class="sect2">
1.75 rillig 5967: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5968: <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 5969: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5970: specifies where configuration files shall be installed. Its contents are
5971: set based upon the following variables:</p>
1.148 ! asau 5972: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5973: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5974: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5975: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5976: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5977: Packages must not use it directly.</p></li>
1.128 wiz 5978: <li class="listitem">
1.75 rillig 5979: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5980: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5981: for the package being built shall be installed. The definition of this
5982: variable only makes sense in the package's
1.76 rillig 5983: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5984: <p>As an example, consider the Apache package,
1.91 rillig 5985: <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 5986: configuration files under the
1.76 rillig 5987: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5988: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5989: Makefile.</p>
5990: </li>
1.128 wiz 5991: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5992: variable that holds this package's configuration directory (if
5993: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5994: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5995: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5996: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5997: directory where the configuration files for the package identified by
5998: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5999: </ul></div>
6000: <p>Based on the above variables, pkginstall determines the value of
6001: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6002: variable that can be used within a package to refer to its configuration
6003: directory. The algorithm used to set its value is basically the
6004: following:</p>
1.128 wiz 6005: <div class="orderedlist"><ol class="orderedlist" type="1">
6006: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 6007: its value is used.</p></li>
1.128 wiz 6008: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 6009: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 6010: <code class="filename">Makefile</code>, the resulting value is
6011: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 6012: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 6013: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 6014: </ol></div>
1.76 rillig 6015: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 6016: 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
6017: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
6018: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 6019: </div>
1.148 ! asau 6020: <div class="sect2">
1.75 rillig 6021: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6022: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 6023: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6024: known place, you need to teach each package where it shall install its
6025: files. In some cases you will have to patch the package Makefiles to
6026: achieve it. If you are lucky, though, it may be as easy as passing an
6027: extra flag to the configuration script; this is the case of GNU Autoconf-
6028: generated files:</p>
6029: <pre class="programlisting">
1.100 rillig 6030: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 6031: </pre>
1.75 rillig 6032: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6033: for</em></span> its configuration files, not where they will be originally
6034: installed (although the difference is never explicit,
6035: unfortunately).</p>
6036: </div>
1.148 ! asau 6037: <div class="sect2">
1.75 rillig 6038: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6039: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6040: <p>As said before, pkginstall automatically handles configuration files.
6041: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6042: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6043: directly</strong></span>. Bad news is that many software installation scripts
6044: will, out of the box, mess with the contents of that directory. So what is
6045: the correct procedure to fix this issue?</p>
6046: <p>You must teach the package (usually by manually patching it) to
6047: install any configuration files under the examples hierarchy,
1.76 rillig 6048: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6049: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6050: has the original copies available.</p>
6051: <p>Once the required configuration files are in place (i.e., under the
6052: examples hierarchy), the pkginstall framework can use them as master copies
6053: during the package installation to update what is in
1.76 rillig 6054: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6055: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 6056: 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 6057: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6058: <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 6059: <pre class="programlisting">
1.100 rillig 6060: EGDIR= ${PREFIX}/share/doc/mutt/samples
6061: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6062: </pre>
1.75 rillig 6063: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6064: package and has no meaning outside it.</p>
6065: </div>
1.148 ! asau 6066: <div class="sect2">
1.75 rillig 6067: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6068: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6069: <p>The automatic copying of config files can be toggled by setting the
6070: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6071: installation.</p>
6072: </div>
6073: </div>
1.148 ! asau 6074: <div class="sect1">
1.75 rillig 6075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6076: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 6077: <p>System startup scripts are special files because they must be
6078: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 6079: 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 6080: can be used. However, pkginstall provides a special mechanism to handle
6081: these files.</p>
6082: <p>In order to provide system startup scripts, the package has
6083: to:</p>
1.128 wiz 6084: <div class="orderedlist"><ol class="orderedlist" type="1">
6085: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6086: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6087: <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 6088: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 6089: <li class="listitem">
1.75 rillig 6090: <p>Tell pkginstall to handle it, appending the name of the script,
6091: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6092: Continuing the previous example:</p>
6093: <pre class="programlisting">
1.100 rillig 6094: RCD_SCRIPTS+= cupsd
1.1 grant 6095: </pre>
1.75 rillig 6096: </li>
6097: </ol></div>
6098: <p>Once this is done, pkginstall will do the following steps for each
6099: script in an automated fashion:</p>
1.128 wiz 6100: <div class="orderedlist"><ol class="orderedlist" type="1">
6101: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 6102: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6103: variable.</p></li>
1.128 wiz 6104: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 6105: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6106: that this master file must be explicitly registered in the
1.76 rillig 6107: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 6108: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 6109: from the examples hierarchy into the system-wide startup scripts
6110: directory.</p></li>
6111: </ol></div>
1.148 ! asau 6112: <div class="sect2">
1.75 rillig 6113: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6114: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6115: <p>The automatic copying of config files can be toggled by setting the
6116: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6117: installation. Note that the scripts will be always copied inside the
1.76 rillig 6118: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6119: matter what the value of this variable is.</p>
6120: </div>
6121: </div>
1.148 ! asau 6122: <div class="sect1">
1.75 rillig 6123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6124: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 6125: <p>If a package needs to create special users and/or groups during
6126: installation, it can do so by using the pkginstall framework.</p>
6127: <p>Users can be created by adding entries to the
6128: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6129: syntax:</p>
6130: <pre class="programlisting">
1.100 rillig 6131: user:group
1.1 grant 6132: </pre>
1.87 wiz 6133: <p>Further specification of user details may be done by setting
6134: per-user variables.
6135: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6136: numeric UID for the user.
6137: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6138: user's description or comment.
6139: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6140: user's home directory, and defaults to
6141: <code class="filename">/nonexistent</code> if not specified.
6142: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6143: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6144: not specified.</p>
1.75 rillig 6145: <p>Similarly, groups can be created by adding entries to the
6146: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6147: <pre class="programlisting">
1.100 rillig 6148: group
1.1 grant 6149: </pre>
1.93 rillig 6150: <p>The numeric GID of the group may be set by defining
1.75 rillig 6151: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6152: <p>If a package needs to create the users and groups at an earlier
6153: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6154: either <code class="literal">configure</code> or <code class="literal">build</code> to
6155: indicate the phase before which the users and groups are created. In
6156: this case, the numeric UIDs and GIDs of the created users and groups
6157: are automatically hardcoded into the final installation scripts.</p>
6158: </div>
1.148 ! asau 6159: <div class="sect1">
1.75 rillig 6160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6161: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 6162: <p>Packages that install system shells should register them in the shell
1.76 rillig 6163: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6164: administrator. This must be done from the installation scripts to keep
6165: binary packages working on any system. pkginstall provides an easy way to
6166: accomplish this task.</p>
6167: <p>When a package provides a shell interpreter, it has to set the
6168: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6169: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6170: 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 6171: <pre class="programlisting">
1.100 rillig 6172: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6173: </pre>
1.148 ! asau 6174: <div class="sect2">
1.75 rillig 6175: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6176: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6177: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6178: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6179: environment variable to <code class="literal">NO</code>.</p>
6180: </div>
6181: </div>
1.148 ! asau 6182: <div class="sect1">
1.75 rillig 6183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6184: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 6185: <p>Packages that install X11 fonts should update the database files
6186: that index the fonts within each fonts directory. This can easily be
6187: accomplished within the pkginstall framework.</p>
6188: <p>When a package installs X11 fonts, it must list the directories in
6189: which fonts are installed in the
6190: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 6191: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
6192: <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 6193: installation scripts to run the appropriate commands to update the fonts
6194: database files within each of those directories. For convenience, if the
6195: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6196: 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 6197: <pre class="programlisting">
1.100 rillig 6198: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6199: </pre>
1.148 ! asau 6200: <div class="sect2">
1.75 rillig 6201: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6202: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6203: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6204: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6205: environment variable to <code class="literal">NO</code>.</p>
6206: </div>
6207: </div>
6208: </div>
1.148 ! asau 6209: <div class="chapter">
1.75 rillig 6210: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6211: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 6212: <div class="toc">
6213: <p><b>Table of Contents</b></p>
6214: <dl>
1.106 rillig 6215: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 6216: <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 6217: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 6218: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6219: </dl>
6220: </div>
6221: <p>Many packages have the ability to be built to support different
1.76 rillig 6222: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6223: in pkgsrc that provides generic handling of those options that
6224: determine different ways in which the packages can be built. It's
6225: possible for the user to specify exactly which sets of options will be
6226: built into a package or to allow a set of global default options
6227: apply.</p>
1.107 rillig 6228: <p>There are two broad classes of behaviors that one might want to
6229: control via options. One is whether some particular feature is
6230: enabled in a program that will be built anyway, often by including or
6231: not including a dependency on some other package. The other is
6232: whether or not an additional program will be built as part of the
6233: package. Generally, it is better to make a split package for such
6234: additional programs instead of using options, because it enables
6235: binary packages to be built which can then be added separately. For
6236: example, the foo package might have minimal dependencies (those
6237: packages without which foo doesn't make sense), and then the foo-gfoo
6238: package might include the GTK frontend program gfoo. This is better
6239: than including a gtk option to foo that adds gfoo, because either that
6240: option is default, in which case binary users can't get foo without
6241: gfoo, or not default, in which case they can't get gfoo. With split
6242: packages, they can install foo without having GTK, and later decide to
6243: install gfoo (pulling in GTK at that time). This is an advantage to
6244: source users too, avoiding the need for rebuilds.</p>
6245: <p>Plugins with widely varying dependencies should usually be split
6246: instead of options.</p>
6247: <p>It is often more work to maintain split packages, especially if
6248: the upstream package does not support this. The decision of split
6249: vs. option should be made based on the likelihood that users will want
6250: or object to the various pieces, the size of the dependencies that are
6251: included, and the amount of work.</p>
6252: <p>A further consideration is licensing. Non-free parts, or parts
6253: that depend on non-free dependencies (especially plugins) should
6254: almost always be split if feasible.</p>
1.148 ! asau 6255: <div class="sect1">
1.75 rillig 6256: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6257: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6258: <p>Global default options are listed in
6259: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6260: that should be built into every package if that option is supported.
1.110 hubertf 6261: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6262: </div>
1.148 ! asau 6263: <div class="sect1">
1.75 rillig 6264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6265: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6266: </h2></div></div></div>
1.75 rillig 6267: <p>The following example shows how
1.76 rillig 6268: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6269: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6270: <code class="filename">Makefile</code>, or in a file,
6271: e.g. <code class="filename">options.mk</code>, that is included by the
6272: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6273: <pre class="programlisting">
1.100 rillig 6274: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6275: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6276: PKG_OPTIONS_OPTIONAL_GROUPS= database
6277: PKG_OPTIONS_GROUP.database= mysql pgsql
6278: PKG_SUGGESTED_OPTIONS= wibble-foo
6279: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6280: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6281:
6282: .include "../../mk/bsd.prefs.mk"
6283:
6284: # this package was previously named wibble2
6285: .if defined(PKG_OPTIONS.wibble2)
6286: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6287: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6288: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6289: .endif
6290:
6291: .include "../../mk/bsd.options.mk"
6292:
6293: # Package-specific option-handling
6294:
6295: ###
6296: ### FOO support
6297: ###
6298: .if !empty(PKG_OPTIONS:Mwibble-foo)
6299: CONFIGURE_ARGS+= --enable-foo
6300: .endif
6301:
6302: ###
6303: ### LDAP support
6304: ###
6305: .if !empty(PKG_OPTIONS:Mldap)
6306: . include "../../databases/openldap-client/buildlink3.mk"
6307: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6308: .endif
6309:
6310: ###
6311: ### database support
6312: ###
6313: .if !empty(PKG_OPTIONS:Mmysql)
6314: . include "../../mk/mysql.buildlink3.mk"
6315: .endif
6316: .if !empty(PKG_OPTIONS:Mpgsql)
6317: . include "../../mk/pgsql.buildlink3.mk"
6318: .endif
1.75 rillig 6319: </pre>
6320: <p>The first section contains the information about which build
6321: options are supported by the package, and any default options settings
6322: if needed.</p>
1.128 wiz 6323: <div class="orderedlist"><ol class="orderedlist" type="1">
6324: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.136 dholland 6325: <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 6326: options. It should be set to
1.78 rillig 6327: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6328: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6329: at the point where the options are processed.</p></li>
1.128 wiz 6330: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6331: build options supported by the package.</p></li>
1.128 wiz 6332: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6333: list of names of groups of mutually exclusive options. The options in
6334: each group are listed in
6335: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6336: The most specific setting of any option from the group takes
6337: precedence over all other options in the group. Options from the
6338: groups will be automatically added to
6339: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 6340: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6341: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6342: packages will fail if no option from the group is
6343: selected.</p></li>
1.128 wiz 6344: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6345: of names of sets of options. At least one option from each set must
6346: be selected. The options in each set are listed in
6347: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6348: Options from the sets will be automatically added to
6349: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6350: fail if no option from the set is selected.</p></li>
1.128 wiz 6351: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6352: build options which are enabled by default.</p></li>
1.128 wiz 6353: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6354: of
1.128 wiz 6355: <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 6356: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6357: their option counterparts. Pairs should be added with
1.128 wiz 6358: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6359: warning will be issued if the user uses a legacy
6360: variable.</p></li>
1.128 wiz 6361: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6362: of
1.128 wiz 6363: <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 6364: pairs that map options that have been renamed to their new
1.128 wiz 6365: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6366: the listing of global legacy options. A warning will be issued if
6367: the user uses a legacy option.</p></li>
1.128 wiz 6368: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6369: options implied by deprecated variables used. This can be used for
6370: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6371: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6372: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 6373: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6374: a list of warnings about deprecated variables or options used, and
6375: what to use instead.</p></li>
6376: </ol></div>
6377: <p>A package should never modify
6378: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6379: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6380: To suggest a default set of options, use
6381: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6382: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6383: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6384: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6385: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6386: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6387: happen with platform-specific options if none of them is supported on
6388: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6389: empty list and the package is otherwise treated as not using the
6390: options framework.</p>
1.76 rillig 6391: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6392: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6393: build options, properly filtered to remove unsupported and duplicate
6394: options.</p>
6395: <p>The remaining sections contain the logic that is specific to
6396: each option. The correct way to check for an option is to check
6397: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6398: <pre class="programlisting">
1.100 rillig 6399: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6400: </pre>
6401: </div>
1.148 ! asau 6402: <div class="sect1">
1.75 rillig 6403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6404: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6405: <p>Options that enable similar features in different packages (like
6406: optional support for a library) should use a common name in all
6407: packages that support it (like the name of the library). If another
6408: package already has an option with the same meaning, use the same
6409: name.</p>
6410: <p>Options that enable features specific to one package, where it's
6411: unlikely that another (unrelated) package has the same (or a similar)
6412: optional feature, should use a name prefixed with
6413: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6414: <p>If a group of related packages share an optional feature
6415: specific to that group, prefix it with the name of the
1.128 wiz 6416: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6417: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6418: <p>For new options, add a line to
1.76 rillig 6419: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6420: fields, separated by tab. The first field is the option name, the
6421: second its description. The description should be a whole sentence
6422: (starting with an uppercase letter and ending with a period) that
1.128 wiz 6423: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6424: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6425: </div>
1.148 ! asau 6426: <div class="sect1">
1.107 rillig 6427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6428: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6429: <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 6430: different dependencies based on the options with which the package was
6431: built. For querying these options, the file
6432: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6433: typical example looks like this:</p>
6434: <pre class="programlisting">
6435: pkgbase := libpurple
6436: .include "../../mk/pkg-build-options.mk"
6437:
6438: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6439: ...
6440: .endif
6441: </pre>
6442: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6443: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6444: options of the libpurple package, which can then be queried like
6445: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6446: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6447: details.</p>
6448: </div>
1.75 rillig 6449: </div>
1.148 ! asau 6450: <div class="chapter">
1.75 rillig 6451: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6452: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6453: <div class="toc">
6454: <p><b>Table of Contents</b></p>
6455: <dl>
1.106 rillig 6456: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6457: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6458: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6459: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 6460: <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 6461: <dd><dl>
6462: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6463: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6464: </dl></dd>
1.128 wiz 6465: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6466: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6467: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6468: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6469: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6470: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6471: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6472: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6473: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6474: <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 6475: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6476: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6477: </dl>
6478: </div>
1.148 ! asau 6479: <div class="sect1">
1.75 rillig 6480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6481: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6482: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6483: built. Building a package is separated into different
6484: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6485: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6486: described in the following sections. Each phase is split into
1.87 wiz 6487: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6488: containing phase, prefixed by one of <code class="varname">pre-</code>,
6489: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6490: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6491: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6492: <p>Never override the regular targets (like
6493: <code class="varname">fetch</code>), if you have to, override the
6494: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6495: <p>The basic steps for building a program are always the same. First
1.87 wiz 6496: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6497: the local system and then extracted. After any pkgsrc-specific patches
6498: to compile properly are applied, the software can be configured, then
6499: built (usually by compiling), and finally the generated binaries, etc.
6500: can be put into place on the system.</p>
1.97 rillig 6501: <p>To get more details about what is happening at each step,
6502: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6503: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6504: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6505: </div>
1.148 ! asau 6506: <div class="sect1">
1.75 rillig 6507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6508: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6509: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6510: the next section, here's a brief discussion on where programs are
6511: installed, and which variables influence this.</p>
1.75 rillig 6512: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6513: where all files of the final program shall be installed. It is
6514: usually set to <code class="varname">LOCALBASE</code>
6515: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6516: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6517: <code class="varname">PREFIX</code> needs to be put
6518: into the various places in the program's source where paths to
1.110 hubertf 6519: 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 6520: <p>When choosing which of these variables to use,
1.87 wiz 6521: follow the following rules:</p>
1.148 ! asau 6522: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6523: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6524: where the current pkg will be installed. When referring to a
6525: pkg's own installation path, use
1.128 wiz 6526: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6527: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6528: are installed. If you need to construct a -I or -L argument
6529: to the compiler to find includes and libraries installed by
1.128 wiz 6530: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6531: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6532: installed all packages in <code class="filename">/usr/local</code>. As
6533: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6534: administrator, this variable is a misnomer.</p></li>
1.128 wiz 6535: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6536: distribution (from xsrc, etc.) is installed. When looking for
6537: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 6538: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6539: <li class="listitem">
1.88 wiz 6540: <p>X11-based packages are special in that they may be
6541: installed in either <code class="varname">X11BASE</code> or
6542: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6543: <p>Usually, X11 packages should be installed under
1.88 wiz 6544: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6545: will need to include
6546: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6547: request the presence of X11 and to get the right compilation
6548: flags.</p>
1.75 rillig 6549: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6550: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6551: files. These packages are special and they must be placed under
6552: <code class="varname">X11BASE</code>. To accomplish this, set either
6553: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6554: your package.</p>
1.75 rillig 6555: <p>Some notes: If you need
1.87 wiz 6556: to find includes or libraries installed by a pkg that has
6557: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6558: its pkg <code class="filename">Makefile</code>, you need to look in
6559: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6560: <code class="filename">${LOCALBASE}</code>. To force installation of
6561: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6562: <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 6563: is enabled by default.</p>
1.75 rillig 6564: </li>
1.128 wiz 6565: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6566: the installed location of an X11
6567: package. <code class="varname">X11PREFIX</code> will be set to
6568: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6569: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6570: installed.</p></li>
1.128 wiz 6571: <li class="listitem">
1.88 wiz 6572: <p>If xpkgwedge is installed, it is possible to have some
6573: packages installed in <code class="varname">X11BASE</code> and some in
6574: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6575: installed package, the <code class="varname">EVAL_PREFIX</code>
6576: definition can be used. It takes pairs in the format
1.136 dholland 6577: <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 6578: variable <code class="varname">DIRNAME</code> will be set to the prefix
6579: of the installed package <package>, or
1.128 wiz 6580: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6581: installed.</p>
1.75 rillig 6582: <p>This is best illustrated by example.</p>
6583: <p>The following lines are taken from
1.87 wiz 6584: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6585: <pre class="programlisting">
1.100 rillig 6586: EVAL_PREFIX+= GTKDIR=gtk+
6587: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6588: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6589: CONFIGURE_ARGS+= --enable-multibyte
6590: </pre>
1.88 wiz 6591: <p>Specific defaults can be defined for the packages
6592: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6593: definition of the form:</p>
1.75 rillig 6594: <pre class="programlisting">
1.100 rillig 6595: GTKDIR_DEFAULT= ${LOCALBASE}
6596: </pre>
1.75 rillig 6597: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6598: to the first definition in
6599: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6600: </li>
1.128 wiz 6601: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.136 dholland 6602: 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 6603: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6604: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6605: </ul></div>
6606: </div>
1.148 ! asau 6607: <div class="sect1">
1.75 rillig 6608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6609: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6610: <p>When building a package, various directories are used to store
1.87 wiz 6611: source files, temporary files, pkgsrc-internal files, and so on. These
6612: directories are explained here.</p>
1.75 rillig 6613: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6614: are two common base directories for these relative directories:
6615: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6616: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6617: inside the package itself.</p>
1.148 ! asau 6618: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6619: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6620: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6621: root directory. Generally, you don't need
6622: it.</p></dd>
1.97 rillig 6623: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6624: <dd><p>This is an absolute pathname that points to the
6625: current package.</p></dd>
1.75 rillig 6626: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6627: <dd><p>This is a pathname relative to
1.87 wiz 6628: <code class="varname">PKGSRCDIR</code> that points to the current
6629: package.</p></dd>
1.75 rillig 6630: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6631: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6632: where all work takes place. The distfiles are extracted to this
1.87 wiz 6633: directory. It also contains temporary directories and log files used by
6634: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6635: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6636: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6637: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6638: where the distfiles are extracted. It is usually a direct subdirectory
6639: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6640: that isn't hidden. This variable may be changed by a package
6641: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6642: </dl></div>
1.114 jmcneill 6643: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6644: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6645: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6646: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6647: If users would like to have their pkgsrc trees behave in a
6648: read-only manner, then the value of
6649: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6650: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6651: </div>
1.148 ! asau 6652: <div class="sect1">
1.75 rillig 6653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6654: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6655: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6656: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6657: phase. This will automatically run all phases that are required for this
6658: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6659: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6660: the package will be built, but not installed.</p>
1.75 rillig 6661: </div>
1.148 ! asau 6662: <div class="sect1">
1.75 rillig 6663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6664: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6665: <p>The first step in building a package is to fetch the
1.88 wiz 6666: distribution files (distfiles) from the sites that are providing
6667: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6668: phase.</p>
1.148 ! asau 6669: <div class="sect2">
1.81 rillig 6670: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6671: <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 6672: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6673: defines all URLs from where the distfile, whose name is
6674: derived from the <code class="varname">DISTNAME</code> variable, is
6675: fetched. The more complicated cases are described
6676: below.</p>
6677: <p>The variable <code class="varname">DISTFILES</code> specifies
6678: the list of distfiles that have to be fetched. Its value
6679: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6680: so that most packages don't need to define it at all.
6681: <code class="varname">EXTRACT_SUFX</code> is
6682: <code class="literal">.tar.gz</code> by default, but can be changed
6683: freely. Note that if your package requires additional
6684: distfiles to the default one, you cannot just append the
6685: additional filenames using the <code class="literal">+=</code>
6686: operator, but you have write for example:</p>
1.81 rillig 6687: <pre class="programlisting">
1.100 rillig 6688: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6689: </pre>
1.88 wiz 6690: <p>Each distfile is fetched from a list of sites, usually
6691: <code class="varname">MASTER_SITES</code>. If the package has multiple
6692: <code class="varname">DISTFILES</code> or multiple
6693: <code class="varname">PATCHFILES</code> from different sites, you can
6694: set
6695: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6696: to the list of URLs where the file
6697: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6698: (including the suffix) can be found.</p>
6699: <pre class="programlisting">
1.100 rillig 6700: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6701: DISTFILES+= foo-file.tar.gz
6702: SITES.foo-file.tar.gz= \
6703: http://www.somewhere.com/somehow/ \
6704: http://www.somewhereelse.com/mirror/somehow/
6705: </pre>
1.81 rillig 6706: <p>When actually fetching the distfiles, each item from
1.88 wiz 6707: <code class="varname">MASTER_SITES</code> or
6708: <code class="varname">SITES.*</code> gets the name of each distfile
6709: appended to it, without an intermediate slash. Therefore,
6710: all site values have to end with a slash or other separator
6711: character. This allows for example to set
6712: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6713: that gets the name of the distfile as a parameter. In this
6714: case, the definition would look like:</p>
1.81 rillig 6715: <pre class="programlisting">
1.100 rillig 6716: MASTER_SITES= http://www.example.com/download.cgi?file=
6717: </pre>
1.125 wiz 6718: <p> The exception to this rule are URLs starting with a dash.
6719: In that case the URL is taken as is, fetched and the result stored
6720: under the name of the distfile.</p>
1.81 rillig 6721: <p>There are some predefined values for
1.88 wiz 6722: <code class="varname">MASTER_SITES</code>, which can be used in
6723: packages. The names of the variables should speak for
6724: themselves.</p>
6725: <pre class="programlisting">
1.100 rillig 6726: ${MASTER_SITE_APACHE}
6727: ${MASTER_SITE_BACKUP}
6728: ${MASTER_SITE_CYGWIN}
6729: ${MASTER_SITE_DEBIAN}
6730: ${MASTER_SITE_FREEBSD}
6731: ${MASTER_SITE_FREEBSD_LOCAL}
6732: ${MASTER_SITE_GENTOO}
6733: ${MASTER_SITE_GNOME}
6734: ${MASTER_SITE_GNU}
6735: ${MASTER_SITE_GNUSTEP}
6736: ${MASTER_SITE_IFARCHIVE}
6737: ${MASTER_SITE_KDE}
6738: ${MASTER_SITE_MOZILLA}
6739: ${MASTER_SITE_MYSQL}
6740: ${MASTER_SITE_OPENOFFICE}
6741: ${MASTER_SITE_PERL_CPAN}
6742: ${MASTER_SITE_PGSQL}
6743: ${MASTER_SITE_R_CRAN}
6744: ${MASTER_SITE_SOURCEFORGE}
6745: ${MASTER_SITE_SOURCEFORGE_JP}
6746: ${MASTER_SITE_SUNSITE}
6747: ${MASTER_SITE_SUSE}
6748: ${MASTER_SITE_TEX_CTAN}
6749: ${MASTER_SITE_XCONTRIB}
6750: ${MASTER_SITE_XEMACS}
6751: </pre>
1.88 wiz 6752: <p>Some explanations for the less self-explaining ones:
6753: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 6754: 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 6755: 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 6756: <p>If you choose one of these predefined sites, you may
6757: want to specify a subdirectory of that site. Since these
6758: macros may expand to more than one actual site, you
6759: <span class="emphasis"><em>must</em></span> use the following construct to
6760: specify a subdirectory:</p>
1.81 rillig 6761: <pre class="programlisting">
1.100 rillig 6762: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6763: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6764: </pre>
1.81 rillig 6765: <p>Note the trailing slash after the subdirectory
1.88 wiz 6766: name.</p>
1.81 rillig 6767: </div>
1.148 ! asau 6768: <div class="sect2">
1.81 rillig 6769: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6770: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6771: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6772: all the distfiles exist in a local directory
1.93 rillig 6773: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6774: user). If the files do not exist, they are fetched using
6775: commands of the form</p>
1.75 rillig 6776: <pre class="programlisting">
1.100 rillig 6777: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6778: </pre>
1.88 wiz 6779: <p>where <code class="literal">${site}</code> varies through
6780: several possibilities in turn: first,
6781: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6782: sites specified in either <code class="varname">SITES.file</code> if
6783: defined, else <code class="varname">MASTER_SITES</code> or
6784: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6785: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6786: all except the first and the last can be optionally sorted
6787: by the user, via setting either
6788: <code class="varname">MASTER_SORT_RANDOM</code>, and
6789: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6790: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6791: <p> The specific command and arguments used depend on the
6792: <code class="varname">FETCH_USING</code> parameter. The example above is
6793: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6794: <p>The distfiles mirror run by the NetBSD Foundation uses the
6795: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6796: distfiles, if they are freely distributable. Packages setting
6797: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6798: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6799: mirrored.</p>
1.81 rillig 6800: </div>
1.75 rillig 6801: </div>
1.148 ! asau 6802: <div class="sect1">
1.75 rillig 6803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6804: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6805: <p>After the distfile(s) are fetched, their checksum is
6806: generated and compared with the checksums stored in the
6807: distinfo file. If the checksums don't match, the build is
6808: aborted. This is to ensure the same distfile is used for
6809: building, and that the distfile wasn't changed, e.g. by some
6810: malign force, deliberately changed distfiles on the master
6811: distribution site or network lossage.</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.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6816: <p>When the distfiles are present on the local system, they
1.88 wiz 6817: need to be extracted, as they usually come in the form of some
6818: compressed archive format.</p>
1.75 rillig 6819: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6820: extracted. If you only need some of them, you can set the
6821: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6822: files.</p>
6823: <p>Extracting the files is usually done by a little
1.93 rillig 6824: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6825: already knows how to extract various archive formats, so most
6826: likely you will not need to change anything here. But if you
6827: need, the following variables may help you:</p>
1.148 ! asau 6828: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6829: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6830: <dd><p>Use these variables to override the default
1.88 wiz 6831: options for an extract command, which are defined in
1.93 rillig 6832: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6833: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6834: <dd><p>This variable can be set to
1.114 jmcneill 6835: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6836: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6837: absolute pathname pointing to the command with which tar
1.114 jmcneill 6838: archives should be extracted. It is preferred to choose bsdtar over gtar
6839: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6840: </dl></div>
1.88 wiz 6841: <p>If the <code class="filename">extract</code> program doesn't
6842: serve your needs, you can also override the
6843: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6844: command used for extracting the files. This command is
6845: executed in the <code class="filename">${WRKSRC}</code>
6846: directory. During execution of this command, the shell
6847: variable <code class="varname">extract_file</code> holds the absolute
6848: pathname of the file that is going to be extracted.</p>
1.75 rillig 6849: <p>And if that still does not suffice, you can override the
1.88 wiz 6850: <code class="varname">do-extract</code> target in the package
6851: Makefile.</p>
1.75 rillig 6852: </div>
1.148 ! asau 6853: <div class="sect1">
1.75 rillig 6854: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6855: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6856: <p>After extraction, all the patches named by the
1.88 wiz 6857: <code class="varname">PATCHFILES</code>, those present in the patches
6858: subdirectory of the package as well as in
6859: $LOCALPATCHES/$PKGPATH (e.g.
6860: <code class="filename">/usr/local/patches/graphics/png</code>) are
6861: applied. Patchfiles ending in <code class="filename">.Z</code> or
6862: <code class="filename">.gz</code> are uncompressed before they are
6863: applied, files ending in <code class="filename">.orig</code> or
6864: <code class="filename">.rej</code> are ignored. Any special options to
1.136 dholland 6865: <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 6866: <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 6867: <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 6868: it fail if the patches apply with some lines of fuzz. Please
6869: fix (regen) the patches so that they apply cleanly. The
6870: rationale behind this is that patches that don't apply cleanly
6871: may end up being applied in the wrong place, and cause severe
6872: harm there.</p>
1.75 rillig 6873: </div>
1.148 ! asau 6874: <div class="sect1">
1.75 rillig 6875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6876: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6877: <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 6878: </p>
1.75 rillig 6879: </div>
1.148 ! asau 6880: <div class="sect1">
1.75 rillig 6881: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6882: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6883: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6884: linkers. The following variables can be used to tweak the
6885: wrappers.</p>
1.148 ! asau 6886: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6887: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6888: <dd><p>The command used to print progress
1.88 wiz 6889: messages. Does nothing by default. Set to
6890: <code class="literal">${ECHO}</code> to see the progress
6891: messages.</p></dd>
1.75 rillig 6892: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6893: <dd><p>This variable can be set to
1.88 wiz 6894: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6895: depending on whether you want additional information in the
6896: wrapper log file.</p></dd>
1.75 rillig 6897: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6898: <dd><p>This variable can be set to
1.88 wiz 6899: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6900: on whether the wrapper should use its cache, which will
6901: improve the speed. The default value is
6902: <code class="literal">yes</code>, but is forced to
6903: <code class="literal">no</code> if the platform does not support
6904: it.</p></dd>
1.75 rillig 6905: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6906: <dd><p>A list of reordering commands. A reordering
6907: command has the form
6908: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6909: It ensures that that
6910: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6911: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6912: </p></dd>
1.75 rillig 6913: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6914: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6915: investigate further]</p></dd>
1.75 rillig 6916: </dl></div>
6917: </div>
1.148 ! asau 6918: <div class="sect1">
1.75 rillig 6919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6920: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6921: <p>Most pieces of software need information on the header
6922: files, system calls, and library routines which are available
6923: on the platform they run on. The process of determining this
6924: information is known as configuration, and is usually
6925: automated. In most cases, a script is supplied with the
6926: distfiles, and its invocation results in generation of header
6927: files, Makefiles, etc.</p>
6928: <p>If the package contains a configure script, this can be
6929: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6930: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6931: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6932: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6933: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6934: <pre class="programlisting">
1.100 rillig 6935: .for d in ${CONFIGURE_DIRS}
6936: cd ${WRKSRC} \
6937: && cd ${d} \
6938: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6939: .endfor
6940: </pre>
1.88 wiz 6941: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6942: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6943: <code class="varname">WRKSRC</code>. In each of these directories, the
6944: configure script is run with the environment
6945: <code class="varname">CONFIGURE_ENV</code> and arguments
6946: <code class="varname">CONFIGURE_ARGS</code>. The variables
6947: <code class="varname">CONFIGURE_ENV</code>,
6948: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6949: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6950: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6951: package.</p>
1.144 wiz 6952: <p>If the program uses the Perl way of configuration (mainly Perl
6953: modules, but not only), i.e. a file called
6954: <code class="filename">Makefile.PL</code>, it should include
6955: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6956: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6957: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6958: <p>If the program uses an <code class="filename">Imakefile</code>
6959: for configuration, the appropriate steps can be invoked by
6960: setting <code class="varname">USE_IMAKE</code> to
1.128 wiz 6961: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 6962: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6963: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6964: xmkmf's environment by adding them to the
6965: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6966: <p>If the program uses <code class="filename">cmake</code>
6967: for configuration, the appropriate steps can be invoked by
1.128 wiz 6968: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6969: You can add variables to cmake's environment by adding them to the
6970: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6971: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6972: The top directory argument is given by the
6973: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6974: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6975: <p>If there is no configure step at all, set
1.128 wiz 6976: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6977: </div>
1.148 ! asau 6978: <div class="sect1">
1.75 rillig 6979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6980: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6981: <p>For building a package, a rough equivalent of the
6982: following code is executed.</p>
1.75 rillig 6983: <pre class="programlisting">
1.100 rillig 6984: .for d in ${BUILD_DIRS}
6985: cd ${WRKSRC} \
6986: && cd ${d} \
6987: && env ${MAKE_ENV} \
6988: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6989: -f ${MAKE_FILE} \
6990: ${BUILD_TARGET}
6991: .endfor
6992: </pre>
1.88 wiz 6993: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6994: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6995: <code class="varname">WRKSRC</code>. In each of these directories,
6996: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6997: <code class="varname">MAKE_ENV</code> and arguments
6998: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6999: <code class="varname">MAKE_ENV</code>,
7000: <code class="varname">BUILD_MAKE_FLAGS</code>,
7001: <code class="varname">MAKE_FILE</code> and
7002: <code class="varname">BUILD_TARGET</code> may all be changed by the
7003: package.</p>
1.75 rillig 7004: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 7005: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
7006: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 7007: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 7008: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
7009: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 7010: <p>If there is no build step at all, set
1.128 wiz 7011: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 7012: </div>
1.148 ! asau 7013: <div class="sect1">
1.75 rillig 7014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7015: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 7016: <p>[TODO]</p>
7017: </div>
1.148 ! asau 7018: <div class="sect1">
1.75 rillig 7019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7020: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 7021: <p>Once the build stage has completed, the final step is to
1.88 wiz 7022: install the software in public directories, so users can
7023: access the programs and files.</p>
1.75 rillig 7024: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 7025: equivalent of the following code is executed. Additionally,
7026: before and after this code, much magic is performed to do
7027: consistency checks, registering the package, and so on.</p>
7028: <pre class="programlisting">
1.100 rillig 7029: .for d in ${INSTALL_DIRS}
7030: cd ${WRKSRC} \
7031: && cd ${d} \
7032: && env ${MAKE_ENV} \
7033: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7034: -f ${MAKE_FILE} \
7035: ${INSTALL_TARGET}
7036: .endfor
7037: </pre>
1.75 rillig 7038: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 7039: <span class="emphasis"><em>build</em></span> phase.
7040: <code class="varname">INSTALL_DIRS</code> defaults to
7041: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 7042: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
7043: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 7044: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7045: defined.</p>
1.75 rillig 7046: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 7047: variables are useful. They are all variations of the
1.136 dholland 7048: <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 7049: permissions preset. <code class="varname">INSTALL</code> is the plain
7050: install command. The specialized variants, together with their
7051: intended use, are:</p>
1.148 ! asau 7052: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7053: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 7054: <dd><p>directories that contain
7055: binaries</p></dd>
1.75 rillig 7056: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 7057: <dd><p>directories that contain
7058: scripts</p></dd>
1.75 rillig 7059: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 7060: <dd><p>directories that contain shared and static
7061: libraries</p></dd>
1.75 rillig 7062: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 7063: <dd><p>directories that contain data
7064: files</p></dd>
1.75 rillig 7065: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 7066: <dd><p>directories that contain man
7067: pages</p></dd>
1.75 rillig 7068: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 7069: <dd><p>binaries that can be stripped from debugging
7070: symbols</p></dd>
1.75 rillig 7071: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 7072: <dd><p>binaries that cannot be
7073: stripped</p></dd>
1.75 rillig 7074: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 7075: <dd><p>game
7076: binaries</p></dd>
1.75 rillig 7077: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 7078: <dd><p>shared and static
7079: libraries</p></dd>
1.75 rillig 7080: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7081: <dd><p>data files</p></dd>
7082: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 7083: <dd><p>data files for
7084: games</p></dd>
1.75 rillig 7085: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7086: <dd><p>man pages</p></dd>
7087: </dl></div>
7088: <p>Some other variables are:</p>
1.148 ! asau 7089: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7090: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7091: <dd><p>A list of directories relative to
1.88 wiz 7092: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 7093: beginning of the <span class="emphasis"><em>install</em></span> phase.
7094: The package is supposed to create all needed directories itself
7095: before installing files to it and list all other directories here.
7096: </p></dd>
1.75 rillig 7097: </dl></div>
1.97 rillig 7098: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 7099: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 7100: mostly relevant for packages in the <code class="filename">regress</code>
7101: category.</p>
1.75 rillig 7102: </div>
1.148 ! asau 7103: <div class="sect1">
1.75 rillig 7104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7105: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7106: <p>Once the install stage has completed, a binary package of
7107: the installed files can be built. These binary packages can be
7108: used for quick installation without previous compilation, e.g. by
1.110 hubertf 7109: the <span class="command"><strong>make bin-install</strong></span> or by using
7110: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 7111: <p>By default, the binary packages are created in
7112: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7113: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7114: one for each category in the <code class="varname">CATEGORIES</code>
7115: variable. <code class="varname">PACKAGES</code> defaults to
7116: <code class="filename">pkgsrc/packages</code>.</p>
7117: </div>
1.148 ! asau 7118: <div class="sect1">
1.88 wiz 7119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7120: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 7121: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 7122: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 7123: to clean the work directories of all dependencies too, use
1.110 hubertf 7124: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 7125: </div>
1.148 ! asau 7126: <div class="sect1">
1.75 rillig 7127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7128: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 ! asau 7129: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7130: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7131: <dd><p>For any of the main targets described in the
7132: previous section, two auxiliary targets exist with
1.128 wiz 7133: <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 7134: prefix for the main target's name. These targets are
1.88 wiz 7135: invoked before and after the main target is called,
7136: allowing extra configuration or installation steps be
7137: performed from a package's Makefile, for example, which
7138: a program's configure script or install target
7139: omitted.</p></dd>
1.75 rillig 7140: <dt><span class="term">do-*</span></dt>
1.88 wiz 7141: <dd><p>Should one of the main targets do the wrong thing,
7142: and should there be no variable to fix this, you can
7143: redefine it with the do-* target. (Note that redefining
7144: the target itself instead of the do-* target is a bad
7145: idea, as the pre-* and post-* targets won't be called
7146: anymore, etc.) You will not usually need to do
7147: this.</p></dd>
1.75 rillig 7148: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7149: <dd>
1.110 hubertf 7150: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 7151: you noticed some file was not installed properly, you
7152: can repeat the installation with this target, which will
1.128 wiz 7153: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 7154: <p>This is the default value of
7155: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 7156: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 7157: package</strong></span>, where the defaults are
1.128 wiz 7158: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 7159: respectively.</p>
7160: </dd>
1.75 rillig 7161: <dt><span class="term">deinstall</span></dt>
7162: <dd>
1.136 dholland 7163: <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 7164: current directory, effectively de-installing the
7165: package. The following variables can be used to tune the
7166: behaviour:</p>
1.148 ! asau 7167: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7168: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.136 dholland 7169: <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 7170: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7171: <dd><p>Remove all packages that require (depend on)
7172: the given package. This can be used to remove any
7173: packages that may have been pulled in by a given
1.110 hubertf 7174: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 7175: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7176: <code class="filename">pkgsrc/x11/kde</code>, this is
7177: likely to remove whole KDE. Works by adding
1.136 dholland 7178: <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 7179: command line.</p></dd>
1.75 rillig 7180: </dl></div>
7181: </dd>
1.88 wiz 7182: <dt><span class="term">bin-install</span></dt>
7183: <dd><p>Install a binary package from local disk and via FTP
7184: from a list of sites (see the
7185: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 7186: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 7187: available anywhere. The arguments given to
1.110 hubertf 7188: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 7189: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7190: operation, etc.</p></dd>
1.75 rillig 7191: <dt><span class="term">update</span></dt>
7192: <dd>
1.88 wiz 7193: <p>This target causes the current package to be
7194: updated to the latest version. The package and all
7195: depending packages first get de-installed, then current
7196: versions of the corresponding packages get compiled and
7197: installed. This is similar to manually noting which
7198: packages are currently installed, then performing a
1.110 hubertf 7199: series of <span class="command"><strong>make deinstall</strong></span> and
7200: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7201: <code class="varname">UPDATE_TARGET</code> is set to) for these
7202: packages.</p>
1.128 wiz 7203: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 7204: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7205: update</strong></span> was interrupted for some reason.
7206: However, in this case, make sure you don't call
1.110 hubertf 7207: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7208: list of dependent packages in <code class="varname">WRKDIR</code>.
7209: Otherwise, you lose the ability to automatically update
7210: the current package along with the dependent packages
7211: you have installed.</p>
1.110 hubertf 7212: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7213: update</strong></span> will only work as long as the package
7214: tree remains unchanged. If the source code for one of
7215: the packages to be updated has been changed, resuming
1.110 hubertf 7216: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7217: fail!</p>
7218: <p>The following variables can be used either on the
1.110 hubertf 7219: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7220: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7221: update</strong></span>:</p>
1.148 ! asau 7222: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7223: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7224: <dd><p>Install target to recursively use for the
7225: updated package and the dependent packages.
7226: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 7227: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7228: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 7229: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7230: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7231: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7232: endless loop!</p></dd>
1.75 rillig 7233: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7234: <dd><p>Don't clean up after updating. Useful if
7235: you want to leave the work sources of the updated
7236: packages around for inspection or other purposes.
7237: Be sure you eventually clean up the source tree
1.128 wiz 7238: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7239: or you may run into troubles with old source code
7240: still lying around on your next
1.110 hubertf 7241: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7242: update</strong></span>.</p></dd>
1.75 rillig 7243: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7244: <dd><p>Deinstall each package before installing
7245: (making <code class="varname">DEPENDS_TARGET</code>). This
7246: may be necessary if the
1.128 wiz 7247: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7248: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7249: update</strong></span>.</p></dd>
1.75 rillig 7250: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7251: <dd><p>Allows you to disable recursion and hardcode
7252: the target for packages. The default is
1.128 wiz 7253: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7254: facilitating a recursive update of prerequisite
7255: packages. Only set
7256: <code class="varname">DEPENDS_TARGET</code> if you want to
7257: disable recursive updates. Use
7258: <code class="varname">UPDATE_TARGET</code> instead to just
7259: set a specific target for each package to be
1.110 hubertf 7260: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7261: (see above).</p></dd>
1.75 rillig 7262: </dl></div>
7263: </dd>
7264: <dt><span class="term">clean-update</span></dt>
7265: <dd>
1.88 wiz 7266: <p>Clean the source tree for all packages that would
1.110 hubertf 7267: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7268: from the current directory. This target should not be
7269: used if the current package (or any of its depending
7270: packages) have already been de-installed (e.g., after
1.110 hubertf 7271: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7272: some packages you intended to update. As a rule of
7273: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7274: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7275: and only if you have a dirty package tree (e.g., if you
7276: used <code class="varname">NOCLEAN</code>).</p>
7277: <p>If you are unsure about whether your tree is
1.110 hubertf 7278: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7279: clean</strong></span> at the top of the tree, or use the
7280: following sequence of commands from the directory of the
7281: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7282: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7283: time, otherwise you lose all the packages you wanted to
7284: update!):</p>
1.87 wiz 7285: <pre class="screen">
7286: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7287: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7288: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7289: </pre>
1.88 wiz 7290: <p>The following variables can be used either on the
1.110 hubertf 7291: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7292: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 ! asau 7293: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7294: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7295: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7296: reconstruct the list of directories to update for
1.110 hubertf 7297: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7298: update</strong></span> successfully installed all
7299: packages you wanted to update. Normally, this is
1.110 hubertf 7300: done automatically on <span class="command"><strong>make
1.88 wiz 7301: update</strong></span>, but may have been suppressed by
7302: the <code class="varname">NOCLEAN</code> variable (see
7303: above).</p></dd>
1.75 rillig 7304: </dl></div>
7305: </dd>
1.88 wiz 7306: <dt><span class="term">replace</span></dt>
7307: <dd>
7308: <p>Update the installation of the current package. This
7309: differs from update in that it does not replace dependent
1.93 rillig 7310: 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 7311: target to work.</p>
7312: <p><span class="emphasis"><em>Be careful when using this
7313: target!</em></span> There are no guarantees that dependent
7314: packages will still work, in particular they will most
1.110 hubertf 7315: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7316: library package whose shared library major version changed
7317: between your installed version and the new one. For this
7318: reason, this target is not officially supported and only
7319: recommended for advanced users.</p>
7320: </dd>
1.75 rillig 7321: <dt><span class="term">info</span></dt>
1.136 dholland 7322: <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 7323: package. You can use this to check which version of a
7324: package is installed.</p></dd>
7325: <dt><span class="term">index</span></dt>
7326: <dd>
7327: <p>This is a top-level command, i.e. it should be used in
7328: the <code class="filename">pkgsrc</code> directory. It creates a
7329: database of all packages in the local pkgsrc tree, including
7330: dependencies, comment, maintainer, and some other useful
7331: information. Individual entries are created by running
1.110 hubertf 7332: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7333: directories. This index file is saved as
7334: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7335: verbose format by running <span class="command"><strong>make
1.88 wiz 7336: print-index</strong></span>. You can search in it with
1.110 hubertf 7337: <span class="command"><strong>make search
1.88 wiz 7338: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7339: extract a list of all packages that depend on a particular
1.110 hubertf 7340: one by running <span class="command"><strong>make show-deps
1.88 wiz 7341: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7342: <p>Running this command takes a very long time, some
7343: hours even on fast machines!</p>
7344: </dd>
1.75 rillig 7345: <dt><span class="term">readme</span></dt>
1.88 wiz 7346: <dd>
7347: <p>This target generates a
7348: <code class="filename">README.html</code> file, which can be
1.91 rillig 7349: 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 7350: contain references to any packages which are in the
7351: <code class="varname">PACKAGES</code> directory on the local
7352: host. The generated files can be made to refer to URLs
7353: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7354: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7355: wanted to generate <code class="filename">README.html</code>
7356: files which pointed to binary packages on the local
7357: machine, in the directory
7358: <code class="filename">/usr/packages</code>, set
7359: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7360: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7361: <code class="varname">${PACKAGES}</code> directory and its
7362: subdirectories will be searched for all the binary
7363: packages.</p>
7364: <p>The target can be run at the toplevel or in category
7365: directories, in which case it descends recursively.</p>
7366: </dd>
1.75 rillig 7367: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7368: <dd><p>This is a top-level command, run it in
7369: <code class="filename">pkgsrc</code>. Use this target to create a
7370: file <code class="filename">README-all.html</code> which contains a
7371: list of all packages currently available in the NetBSD
7372: Packages Collection, together with the category they belong
7373: to and a short description. This file is compiled from the
7374: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7375: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7376: readme</strong></span>.</p></dd>
1.75 rillig 7377: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7378: <dd><p>This is very much the same as the
1.128 wiz 7379: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7380: used when generating a pkgsrc tree to be written to a
7381: CD-ROM. This target also produces
7382: <code class="filename">README.html</code> files, and can be made
7383: to refer to URLs based on
7384: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7385: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7386: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7387: <dd><p>This target shows which distfiles and patchfiles
7388: are needed to build the package
7389: (<code class="varname">ALLFILES</code>, which contains all
7390: <code class="varname">DISTFILES</code> and
1.87 wiz 7391: <code class="varname">PATCHFILES</code>, but not
7392: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7393: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7394: <dd><p>This target shows nothing if the package is not
7395: installed. If a version of this package is installed,
7396: but is not the version provided in this version of
7397: pkgsrc, then a warning message is displayed. This target
7398: can be used to show which of your installed packages are
7399: downlevel, and so the old versions can be deleted, and
7400: the current ones added.</p></dd>
1.75 rillig 7401: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7402: <dd><p>This target shows the directory in the pkgsrc
7403: hierarchy from which the package can be built and
7404: installed. This may not be the same directory as the one
7405: from which the package was installed. This target is
7406: intended to be used by people who may wish to upgrade
7407: many packages on a single host, and can be invoked from
7408: the top-level pkgsrc Makefile by using the
1.128 wiz 7409: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7410: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7411: <dd><p>This target shows which installed packages match
7412: the current package's <code class="varname">DEPENDS</code>. Useful
7413: if out of date dependencies are causing build
7414: problems.</p></dd>
1.75 rillig 7415: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7416: <dd><p>After a package is installed, check all its
7417: binaries and (on ELF platforms) shared libraries to see
7418: if they find the shared libs they need. Run by default
1.110 hubertf 7419: 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 7420: <dt><span class="term">print-PLIST</span></dt>
7421: <dd>
1.128 wiz 7422: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7423: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7424: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7425: -newer work/.extract_done</strong></span>. An attempt is made
7426: to care for shared libs etc., but it is
1.87 wiz 7427: <span class="emphasis"><em>strongly</em></span> recommended to review the
7428: result before putting it into
7429: <code class="filename">PLIST</code>. On upgrades, it's useful to
7430: diff the output of this command against an already
7431: existing <code class="filename">PLIST</code> file.</p>
1.136 dholland 7432: <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 7433: other methods that don't update file access times, be
7434: sure to add these files manually to your
1.128 wiz 7435: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7436: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7437: them!</p>
1.128 wiz 7438: <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 7439: information on this target.</p>
1.75 rillig 7440: </dd>
7441: <dt><span class="term">bulk-package</span></dt>
7442: <dd>
1.88 wiz 7443: <p>Used to do bulk builds. If an appropriate binary
7444: package already exists, no action is taken. If not, this
7445: target will compile, install and package it (and its
7446: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110 hubertf 7447: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.88 wiz 7448: After creating the binary package, the sources, the
7449: just-installed package and its required packages are
7450: removed, preserving free disk space.</p>
7451: <p><span class="emphasis"><em>Beware that this target may deinstall
7452: all packages installed on a system!</em></span></p>
1.75 rillig 7453: </dd>
7454: <dt><span class="term">bulk-install</span></dt>
7455: <dd>
1.88 wiz 7456: <p>Used during bulk-installs to install required
7457: packages. If an up-to-date binary package is available,
1.136 dholland 7458: 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 7459: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7460: but the installed binary won't be removed.</p>
1.88 wiz 7461: <p>A binary package is considered
1.128 wiz 7462: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.136 dholland 7463: <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 7464: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7465: <li class="listitem"><p>None of the package's files
1.88 wiz 7466: (<code class="filename">Makefile</code>, ...) were modified
7467: since it was built.</p></li>
1.128 wiz 7468: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7469: packages were modified since it was built.</p></li>
1.75 rillig 7470: </ul></div>
1.88 wiz 7471: <p><span class="emphasis"><em>Beware that this target may deinstall
7472: all packages installed on a system!</em></span></p>
1.75 rillig 7473: </dd>
7474: </dl></div>
7475: </div>
7476: </div>
1.148 ! asau 7477: <div class="chapter">
1.75 rillig 7478: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7479: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7480: <div class="toc">
7481: <p><b>Table of Contents</b></p>
7482: <dl>
1.106 rillig 7483: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7484: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7485: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7486: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7487: </dl>
7488: </div>
1.87 wiz 7489: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7490: by pkgsrc and also for individual packages to define what commands
7491: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7492: or for later run-time of an installed packaged (such as
7493: <code class="varname">DEPENDS</code>).
7494: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7495: package will not be used.</p>
7496: <p>When building a package, the replacement tools are
1.75 rillig 7497: made available in a directory (as symlinks or wrapper scripts)
7498: that is early in the executable search path. Just like the buildlink
1.87 wiz 7499: system, this helps with consistent builds.</p>
7500: <p>A tool may be needed to help build a specific package. For example,
7501: perl, GNU make (gmake) or yacc may be needed.</p>
7502: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7503: tool may be inefficient for building a package with pkgsrc.
7504: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7505: yacc) or a better sed.</p>
7506: <p>The tools used by a package can be listed by running
1.110 hubertf 7507: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 ! asau 7508: <div class="sect1">
1.75 rillig 7509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7510: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7511: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7512: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7513: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7514: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7515: These can be seen by running:
1.110 hubertf 7516: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7517: <p>If a package needs a specific program to build
1.75 rillig 7518: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7519: to define the tools needed.</p>
1.75 rillig 7520: </div>
1.148 ! asau 7521: <div class="sect1">
1.75 rillig 7522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7523: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 7524: <p>In the following examples, the :run means that it is needed at
7525: run-time (and becomes a DEPENDS).
1.75 rillig 7526: The default is a build dependency which can be set with
7527: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7528: and pkg-config:build.)</p>
1.75 rillig 7529: <pre class="programlisting">
7530: USE_TOOLS+= gmake perl:run pkg-config
7531: </pre>
1.87 wiz 7532: <p>When using the tools framework, a
1.75 rillig 7533: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7534: which contains the full path to the appropriate tool. For example,
1.128 wiz 7535: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7536: on Linux systems.</p>
7537: <p>If you always need a pkgsrc version of the
1.75 rillig 7538: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7539: </p>
7540: </div>
1.148 ! asau 7541: <div class="sect1">
1.75 rillig 7542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7543: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7544: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7545: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7546: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7547: the name of the common tools. For example:</p>
7548: <pre class="programlisting">
7549: .if exists(/usr/bin/bzcat)
7550: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7551: .elif exists(/usr/bin/bzip2)
7552: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7553: .endif
1.69 rillig 7554:
1.75 rillig 7555: TOOLS_PLATFORM.true?= true # shell builtin
7556: </pre>
7557: </div>
1.148 ! asau 7558: <div class="sect1">
1.97 rillig 7559: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7560: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148 ! asau 7561: <div class="qandaset">
! 7562: <a name="idm11867712"></a><dl>
1.106 rillig 7563: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7564: </dt>
1.106 rillig 7565: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7566: tools?</a>
7567: </dt>
1.106 rillig 7568: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7569: package is using while being built? I want to know whether it
7570: uses sed or not.</a>
7571: </dt>
7572: </dl>
1.148 ! asau 7573: <table border="0" style="width: 100%;">
! 7574: <colgroup>
1.97 rillig 7575: <col align="left" width="1%">
1.128 wiz 7576: <col>
1.148 ! asau 7577: </colgroup>
1.97 rillig 7578: <tbody>
1.148 ! asau 7579: <tr class="question">
1.97 rillig 7580: <td align="left" valign="top">
1.148 ! asau 7581: <a name="tools.new"></a><a name="idm11867520"></a><p><b>18.4.1.</b></p>
1.97 rillig 7582: </td>
7583: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7584: </tr>
7585: <tr class="answer">
7586: <td align="left" valign="top"></td>
7587: <td align="left" valign="top"><p>TODO</p></td>
7588: </tr>
1.148 ! asau 7589: <tr class="question">
1.97 rillig 7590: <td align="left" valign="top">
1.148 ! asau 7591: <a name="tools.listall"></a><a name="idm11867008"></a><p><b>18.4.2.</b></p>
1.97 rillig 7592: </td>
7593: <td align="left" valign="top"><p>How do I get a list of all available
7594: tools?</p></td>
7595: </tr>
7596: <tr class="answer">
7597: <td align="left" valign="top"></td>
7598: <td align="left" valign="top"><p>TODO</p></td>
7599: </tr>
1.148 ! asau 7600: <tr class="question">
1.97 rillig 7601: <td align="left" valign="top">
1.148 ! asau 7602: <a name="tools.used"></a><a name="idm11866496"></a><p><b>18.4.3.</b></p>
1.97 rillig 7603: </td>
7604: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7605: package is using while being built? I want to know whether it
7606: uses sed or not.</p></td>
7607: </tr>
7608: <tr class="answer">
7609: <td align="left" valign="top"></td>
7610: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7611: to do it.)</p></td>
7612: </tr>
7613: </tbody>
7614: </table>
7615: </div>
7616: </div>
1.75 rillig 7617: </div>
1.148 ! asau 7618: <div class="chapter">
1.75 rillig 7619: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7620: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7621: <div class="toc">
7622: <p><b>Table of Contents</b></p>
7623: <dl>
1.106 rillig 7624: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7625: <dd><dl>
1.106 rillig 7626: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 7627: <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 7628: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7629: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7630: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7631: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7632: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7633: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7634: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7635: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7636: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7637: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7638: </dl></dd>
1.128 wiz 7639: <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 7640: <dd><dl>
7641: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7642: <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>
7643: </dl></dd>
1.128 wiz 7644: <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 7645: <dd><dl>
7646: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7647: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7648: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7649: </dl></dd>
7650: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7651: <dd><dl>
7652: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7653: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7654: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 7655: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7656: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 7657: </dl></dd>
1.128 wiz 7658: <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 7659: <dd><dl>
7660: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7661: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 7662: <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 7663: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7664: </dl></dd>
1.128 wiz 7665: <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 7666: <dd><dl>
7667: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7668: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7669: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7670: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7671: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7672: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7673: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7674: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7675: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7676: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7677: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7678: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7679: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7680: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7681: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7682: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7683: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7684: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7685: emulation</a></span></dt>
1.106 rillig 7686: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7687: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7688: </dl></dd>
1.106 rillig 7689: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7690: </dl>
7691: </div>
1.148 ! asau 7692: <div class="sect1">
1.75 rillig 7693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7694: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.148 ! asau 7695: <div class="sect2">
1.75 rillig 7696: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7697: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7698: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7699: different platforms. As a result, it is important to ensure,
7700: where possible, that packages in pkgsrc are portable. This
7701: chapter mentions some particular details you should pay
7702: attention to while working on pkgsrc.</p>
1.78 rillig 7703: </div>
1.148 ! asau 7704: <div class="sect2">
1.78 rillig 7705: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7706: <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 7707: </h3></div></div></div>
1.78 rillig 7708: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7709: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7710: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7711: want to use those variables in the preprocessor directives of
1.136 dholland 7712: <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 7713: <code class="literal">.for</code>), you need to include the file
7714: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7715: loads the user preferences.</p>
1.78 rillig 7716: <p>But note that some variables may not be completely defined
1.87 wiz 7717: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7718: included, as they may contain references to variables that are
7719: not yet defined. In shell commands this is no problem, since
7720: variables are actually macros, which are only expanded when they
7721: are used. But in the preprocessor directives mentioned above and
7722: in dependency lines (of the form <code class="literal">target:
7723: dependencies</code>) the variables are expanded at load
7724: time.</p>
1.148 ! asau 7725: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7726: <h3 class="title">Note</h3>
7727: <p>Currently there is no exhaustive list of all
1.87 wiz 7728: variables that tells you whether they can be used at load time
7729: or only at run time, but it is in preparation.</p>
1.78 rillig 7730: </div>
7731: </div>
1.148 ! asau 7732: <div class="sect2">
1.78 rillig 7733: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7734: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7735: <p>Occasionally, packages require interaction from the user,
7736: and this can be in a number of ways:</p>
1.148 ! asau 7737: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7738: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7739: interaction such as entering username/password or accepting a
7740: license on a web page.</p></li>
1.128 wiz 7741: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7742: passwords.</p></li>
1.128 wiz 7743: <li class="listitem"><p>help to configure the package before it is built</p></li>
7744: <li class="listitem"><p>help during the build process</p></li>
7745: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7746: </ul></div>
1.88 wiz 7747: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7748: provided to notify the pkgsrc mechanism of an interactive stage
7749: which will be needed, and this should be set in the package's
7750: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7751: <pre class="programlisting">
1.100 rillig 7752: INTERACTIVE_STAGE= build
1.87 wiz 7753: </pre>
1.78 rillig 7754: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7755: <pre class="programlisting">
1.100 rillig 7756: INTERACTIVE_STAGE= configure install
1.87 wiz 7757: </pre>
1.88 wiz 7758: <p>The user can then decide to skip this package by setting the
7759: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7760: </div>
1.148 ! asau 7761: <div class="sect2">
1.75 rillig 7762: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7763: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7764: <p>Authors of software can choose the licence under which
7765: software can be copied. This is due to copyright law, and reasons
7766: for license choices are outside the scope of pkgsrc. The pkgsrc
7767: system recognizes that there are a number of licenses which some
7768: users may find objectionable or difficult or impossible to comply
7769: with. The Free Software Foundation has declared some licenses
7770: "Free", and the Open Source Initiative has a definition of "Open
7771: Source". The pkgsrc system, as a policy choice, does not label
7772: packages which have licenses that are Free or Open Source.
7773: However, packages without a license meeting either of those tests
7774: are labeled with a license tag denoting the license. Note that a
7775: package with no license to copy trivially does not meet either the
7776: Free or Open Source test.</p>
7777: <p>For packages which are not Free or Open Source, pkgsrc will
7778: not build the package unless the user has indicated to pkgsrc that
7779: packages with that particular license may be built. Note that
7780: this documentation avoids the term "accepted the license". The
7781: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7782: accidentally building a package with a non-free license;
1.98 wiz 7783: judgement and responsibility remain with the user. (Installation
7784: of binary packages are not currently subject to this mechanism;
7785: this is a bug.)</p>
7786: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7787: or the GPL, and not the other. The free licenses are added to the
7788: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7789: user can override the default by setting the
7790: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7791: of "+=". The licenses accepted by default are:
7792: </p>
7793: <pre class="programlisting">
1.139 wiz 7794: public-domain unlicense
7795: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7796: gnu-gpl-v1
7797: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7798: gnu-gpl-v3 gnu-lgpl-v3
7799: original-bsd modified-bsd 2-clause-bsd
7800: x11 mit miros
7801: apache-1.1 apache-2.0
7802: artistic artistic-2.0
7803: cddl-1.0
7804: cpl-1.0
7805: open-font-license
7806: mpl-1.0 mpl-1.1 mpl-2.0
7807: php png-license
7808: postgresql-license
7809: zlib
7810: zpl
7811: python-software-foundation
7812: ipafont
7813: ibm-public-license-1.0
7814: isc
7815: boost-license
7816: mplusfont
7817: cc-by-sa-v3.0
7818: lppl-1.3c
7819: lucent
7820: epl-v1.0
7821: info-zip
1.121 jnemeth 7822: </pre>
7823: <p>
7824: </p>
1.78 rillig 7825: <p>The license tag mechanism is intended to address
1.87 wiz 7826: copyright-related issues surrounding building, installing and
7827: using a package, and not to address redistribution issues (see
7828: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7829: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7830: Packages with redistribution restrictions should set these
7831: tags.</p>
1.98 wiz 7832: <p>Denoting that a package may be copied according to a
7833: particular license is done by placing the license in
1.87 wiz 7834: <code class="filename">pkgsrc/licenses</code> and setting the
7835: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7836: 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 7837: <pre class="programlisting">
1.100 rillig 7838: LICENSE= xv-license
1.87 wiz 7839: </pre>
7840: <p>When trying to build, the user will get a notice that the
1.98 wiz 7841: package is covered by a license which has not been placed in the
7842: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7843: <pre class="programlisting">
1.100 rillig 7844: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7845: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7846: ===> To view the license, enter "/usr/bin/make show-license".
7847: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7848: ===> ACCEPTABLE_LICENSES+=xv-license
7849: *** Error code 1
1.87 wiz 7850: </pre>
1.110 hubertf 7851: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7852: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7853: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7854: convey to pkgsrc that it should not in the future fail because of
7855: that license:</p>
1.78 rillig 7856: <pre class="programlisting">
1.100 rillig 7857: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7858: </pre>
1.98 wiz 7859: <p>When adding a package with a new license, the license text
7860: should be added to <code class="filename">pkgsrc/licenses</code> for
7861: displaying. A list of known licenses can be seen in this
1.91 rillig 7862: directory.</p>
1.98 wiz 7863: <p>When the license changes (in a way other than formatting),
7864: please make sure that the new license has a different name (e.g.,
7865: append the version number if it exists, or the date). Just
7866: because a user told pkgsrc to build programs under a previous
7867: version of a license does not mean that pkgsrc should build
1.99 rillig 7868: programs under the new licenses. The higher-level point is that
1.98 wiz 7869: pkgsrc does not evaluate licenses for reasonableness; the only
7870: test is a mechanistic test of whether a particular text has been
7871: approved by either of two bodies.</p>
1.78 rillig 7872: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7873: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7874: is deprecated because it does not crisply refer to a particular
7875: license text. Another problem with such usage is that it does not
7876: enable a user to tell pkgsrc to proceed for a single package
7877: without also telling pkgsrc to proceed for all packages with that
7878: tag.</p>
1.75 rillig 7879: </div>
1.148 ! asau 7880: <div class="sect2">
1.75 rillig 7881: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7882: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7883: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7884: Because a license tag is required unless the package is Free or
7885: Open Source, all packages with restrictions should have license
7886: tags. By declaring the restrictions, package tools can
7887: automatically refrain from e.g. placing binary packages on FTP
7888: sites.</p>
7889: <p>There are four restrictions that may be encoded, which are
7890: the cross product of sources (distfiles) and binaries not being
7891: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7892: language in any license, and because non-Free licenses tend to be
7893: different from each other, pkgsrc adopts a definition of FTP and
7894: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7895: should not be made available over the Internet at no charge.
7896: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7897: made available on some kind of media, together with other source
7898: and binary packages, and which is sold for a distribution charge.
7899: </p>
7900: <p>In order to encode these restrictions, the package system
1.87 wiz 7901: defines five make variables that can be set to note these
7902: restrictions:</p>
1.148 ! asau 7903: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7904: <li class="listitem">
1.75 rillig 7905: <p><code class="varname">RESTRICTED</code></p>
7906: <p>This variable should be set whenever a restriction
1.87 wiz 7907: exists (regardless of its kind). Set this variable to a
1.98 wiz 7908: string containing the reason for the restriction. It should
7909: be understood that those wanting to understand the restriction
7910: will have to read the license, and perhaps seek advice of
7911: counsel.</p>
1.75 rillig 7912: </li>
1.128 wiz 7913: <li class="listitem">
1.75 rillig 7914: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7915: <p>Binaries may not be placed on CD-ROM containing other
7916: binary packages, for which a distribution charge may be made.
7917: In this case, set this variable to
7918: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7919: </li>
1.128 wiz 7920: <li class="listitem">
1.75 rillig 7921: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7922: <p>Binaries may not made available on the Internet without
7923: charge. In this case, set this variable to
7924: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7925: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7926: </li>
1.128 wiz 7927: <li class="listitem">
1.75 rillig 7928: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7929: <p>Distfiles may not be placed on CD-ROM, together with
7930: other distfiles, for which a fee may be charged. In this
7931: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7932: </p>
1.75 rillig 7933: </li>
1.128 wiz 7934: <li class="listitem">
1.75 rillig 7935: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7936: <p>Distfiles may not made available via FTP at no charge.
7937: In this case, set this variable to
7938: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7939: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7940: </li>
7941: </ul></div>
1.139 wiz 7942: <p>Please note that packages will to be removed from pkgsrc
7943: when the distfiles are not distributable and cannot be obtained
7944: for a period of one full quarter branch. Packages with manual /
7945: interactive fetch must have a maintainer and it is his/her
7946: responsibility to ensure this.</p>
1.75 rillig 7947: </div>
1.148 ! asau 7948: <div class="sect2">
1.75 rillig 7949: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7950: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7951: <p>Your package may depend on some other package being present
1.88 wiz 7952: - and there are various ways of expressing this dependency.
7953: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7954: <code class="varname">DEPENDS</code> definitions, the
7955: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7956: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7957: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7958: 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 7959: <p>The basic difference between the two variables is as
1.87 wiz 7960: follows: The <code class="varname">DEPENDS</code> definition registers
7961: that pre-requisite in the binary package so it will be pulled in
7962: when the binary package is later installed, whilst the
7963: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7964: dependency that is only needed for building the package.</p>
1.75 rillig 7965: <p>This means that if you only need a package present whilst
1.87 wiz 7966: you are building, it should be noted as a
7967: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7968: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7969: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7970: <pre class="programlisting">
1.100 rillig 7971: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7972: </pre>
1.128 wiz 7973: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7974: may include any of the wildcard version numbers recognized by
1.136 dholland 7975: <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 7976: <div class="orderedlist"><ol class="orderedlist" type="1">
7977: <li class="listitem">
1.75 rillig 7978: <p>If your package needs another package's binaries or
1.87 wiz 7979: libraries to build or run, and if that package has a
7980: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7981: <pre class="programlisting">
1.100 rillig 7982: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7983: </pre>
1.75 rillig 7984: </li>
1.128 wiz 7985: <li class="listitem">
1.132 spz 7986: <p>If your package needs binaries from another package to build,
7987: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 7988: <pre class="programlisting">
1.132 spz 7989: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87 wiz 7990: </pre>
1.75 rillig 7991: </li>
1.132 spz 7992: <li class="listitem"><p>If your package needs a library with which to link and
7993: there is no <code class="filename">buildlink3.mk</code> file
7994: available, create one. Using
7995: <code class="varname">DEPENDS</code> won't be sufficient because the
7996: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7997: <li class="listitem">
1.132 spz 7998: <p>If your package needs some executable to be able to run
7999: correctly and if there's no
8000: <code class="filename">buildlink3.mk</code> file, this is specified
8001: using the <code class="varname">DEPENDS</code> variable. The
8002: <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
8003: be able to execute the latex binary from the teTeX package
8004: when it runs, and that is specified:</p>
1.75 rillig 8005: <pre class="programlisting">
1.132 spz 8006: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 8007: </pre>
1.132 spz 8008: </li>
8009: <li class="listitem">
8010: <p>You can use wildcards in package dependencies. Note that
8011: such wildcard dependencies are retained when creating binary
8012: packages. The dependency is checked when installing the binary
8013: package and any package which matches the pattern will be
8014: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 8015: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
8016: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
8017: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
8018: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 8019: <p>Wildcards can also be used to specify that a package
1.87 wiz 8020: will only build against a certain minimum version of a
8021: pre-requisite:</p>
1.75 rillig 8022: <pre class="programlisting">
1.132 spz 8023: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.87 wiz 8024: </pre>
1.132 spz 8025: <p>This means that the package will build using version 6.0
8026: of ImageMagick or newer. Such a dependency may be warranted
8027: if, for example, the command line options of an executable
8028: have changed.</p>
8029: <p>If you need to depend on minimum versions of libraries,
8030: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 8031: <p>For security fixes, please update the package
1.110 hubertf 8032: 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 8033: information.</p>
1.75 rillig 8034: </li>
8035: </ol></div>
8036: <p>If your package needs files from another package to build,
1.87 wiz 8037: add the relevant distribution files to
8038: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 8039: 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 8040: (It relies on the jpeg sources being present in source form
8041: during the build.)</p>
1.75 rillig 8042: </div>
1.148 ! asau 8043: <div class="sect2">
1.75 rillig 8044: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8045: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 8046: <p>Your package may conflict with other packages a user might
1.87 wiz 8047: already have installed on his system, e.g. if your package
1.88 wiz 8048: installs the same set of files as another package in the pkgsrc
8049: tree.</p>
1.75 rillig 8050: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 8051: space-separated list of packages (including version string) your
8052: package conflicts with.</p>
1.91 rillig 8053: <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>
8054: 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 8055: install the same shared library, thus you set in
8056: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8057: <pre class="programlisting">
1.100 rillig 8058: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 8059: </pre>
8060: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 8061: <pre class="programlisting">
1.100 rillig 8062: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 8063: </pre>
1.75 rillig 8064: <p>Packages will automatically conflict with other packages
1.87 wiz 8065: with the name prefix and a different version
1.128 wiz 8066: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
8067: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.75 rillig 8068: </div>
1.148 ! asau 8069: <div class="sect2">
1.75 rillig 8070: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8071: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 8072: <p>There are several reasons why a package might be
1.88 wiz 8073: instructed to not build under certain circumstances. If the
1.87 wiz 8074: package builds and runs on most platforms, the exceptions
8075: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8076: the package builds and runs on a small handful of platforms,
8077: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8078: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8079: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8080: (OS-version-platform) that can use glob-style
8081: wildcards.</p>
1.88 wiz 8082: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8083: 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 8084: backwards compatible with other versions of the OS, and should be
8085: uploaded to a version specific directory on the FTP server. Mark
8086: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 8087: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 8088: the package system internals, but may be used in the
8089: future.</p>
1.75 rillig 8090: <p>If the package should be skipped (for example, because it
1.87 wiz 8091: provides functionality already provided by the system), set
1.88 wiz 8092: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8093: the package should fail because some preconditions are not met,
8094: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8095: message.</p>
1.75 rillig 8096: </div>
1.148 ! asau 8097: <div class="sect2">
1.75 rillig 8098: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8099: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8100: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8101: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8102: be set in the package Makefile. This will be carried into any
8103: binary package that is made from this pkgsrc entry. A
1.128 wiz 8104: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.136 dholland 8105: 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 8106: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 8107: </div>
1.148 ! asau 8108: <div class="sect2">
1.75 rillig 8109: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8110: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8111: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8112: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 8113: and after committing that file, ask pkgsrc-security@NetBSD.org to
8114: update the file on ftp.NetBSD.org.</p>
1.75 rillig 8115: <p>After fixing the vulnerability by a patch, its
1.138 wiz 8116: <code class="varname">PKGREVISION</code> should be increased (this is of
8117: course not necessary if the problem is fixed by using a newer
8118: release of the software), and the pattern in the
8119: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 8120: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8121: branch, be sure to submit a pullup request!</p>
1.75 rillig 8122: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8123: semi-automatically by a weekly cron job.</p>
1.75 rillig 8124: </div>
1.148 ! asau 8125: <div class="sect2">
1.75 rillig 8126: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8127: <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 8128: <p>When making fixes to an existing package it can be useful
1.87 wiz 8129: to change the version number in <code class="varname">PKGNAME</code>. To
8130: avoid conflicting with future versions by the original author, a
1.128 wiz 8131: <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 8132: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 8133: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
8134: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 8135: <pre class="programlisting">
1.100 rillig 8136: DISTNAME= foo-17.42
8137: PKGREVISION= 9
1.87 wiz 8138: </pre>
1.75 rillig 8139: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 8140: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
8141: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 8142: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8143: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8144: <p>When a new release of the package is released, the
1.87 wiz 8145: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8146: minor release of the above package, things should be like:</p>
1.75 rillig 8147: <pre class="programlisting">
1.100 rillig 8148: DISTNAME= foo-17.43
1.87 wiz 8149: </pre>
8150: <p><code class="varname">PKGREVISION</code> should be incremented for any
8151: non-trivial change in the resulting binary package. Without a
8152: <code class="varname">PKGREVISION</code> bump, someone with the previous
8153: version installed has no way of knowing that their package is out
8154: of date. Thus, changes without increasing
8155: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8156: trivial that no reasonable person would want to upgrade", and this
8157: is the rough test for when increasing
8158: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8159: changes that do not merit increasing
8160: <code class="varname">PKGREVISION</code> are:</p>
1.148 ! asau 8161: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8162: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 8163: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8164: or comments in Makefile.</p></li>
1.128 wiz 8165: <li class="listitem"><p>
1.100 rillig 8166: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 8167: <li class="listitem"><p>
1.100 rillig 8168: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 8169: <li class="listitem"><p>
1.100 rillig 8170: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8171: </ul></div>
1.87 wiz 8172: <p>Examples of changes that do merit an increase to
8173: <code class="varname">PKGREVISION</code> include:</p>
1.148 ! asau 8174: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8175: <li class="listitem"><p>
1.100 rillig 8176: Security fixes</p></li>
1.128 wiz 8177: <li class="listitem"><p>
1.100 rillig 8178: Changes or additions to a patch file</p></li>
1.128 wiz 8179: <li class="listitem"><p>
1.100 rillig 8180: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 8181: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8182: </ul></div>
1.78 rillig 8183: <p>PKGREVISION must also be incremented when dependencies have ABI
8184: changes.</p>
1.75 rillig 8185: </div>
1.148 ! asau 8186: <div class="sect2">
1.79 rillig 8187: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8188: <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 8189: <p>When you want to replace the same text in multiple files
1.87 wiz 8190: or when the replacement text varies, patches alone cannot help.
8191: This is where the SUBST framework comes in. It provides an
8192: easy-to-use interface for replacing text in files.
8193: Example:</p>
8194: <pre class="programlisting">
1.100 rillig 8195: SUBST_CLASSES+= fix-paths
8196: SUBST_STAGE.fix-paths= pre-configure
8197: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8198: SUBST_FILES.fix-paths= src/*.c
8199: SUBST_FILES.fix-paths+= scripts/*.sh
8200: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8201: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8202: </pre>
1.79 rillig 8203: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8204: that are used to identify the different SUBST blocks that are
8205: defined. The SUBST framework is heavily used by pkgsrc, so it is
8206: important to always use the <code class="literal">+=</code> operator with
8207: this variable. Otherwise some substitutions may be
8208: skipped.</p>
1.79 rillig 8209: <p>The remaining variables of each SUBST block are
1.87 wiz 8210: parameterized with the identifier from the first line
8211: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8212: parameters to a function call.</p>
1.79 rillig 8213: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8214: which the replacement will take place. All combinations of
8215: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8216: <code class="literal">post-</code> together with a phase name are
8217: possible, though only few are actually used. Most commonly used
8218: are <code class="literal">post-patch</code> and
8219: <code class="literal">pre-configure</code>. Of these two,
8220: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8221: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8222: have the state after applying the patches but before making any
8223: other changes. This is especially useful when you are debugging
8224: a package in order to create new patches for it. Similarly,
8225: <code class="literal">post-build</code> is preferred over
8226: <code class="literal">pre-install</code>, because the install phase should
8227: generally be kept as simple as possible. When you use
8228: <code class="literal">post-build</code>, you have the same files in the
8229: working directory that will be installed later, so you can check
8230: if the substitution has succeeded.</p>
1.79 rillig 8231: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8232: that is printed just before the substitution is done.</p>
1.79 rillig 8233: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8234: globbing patterns that specifies the files in which the
8235: substitution will take place. The patterns are interpreted
8236: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8237: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.136 dholland 8238: <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 8239: command should be prefixed with <code class="literal">-e</code>, so that
8240: all SUBST blocks look uniform.</p>
1.79 rillig 8241: <p>There are some more variables, but they are so seldomly
1.87 wiz 8242: used that they are only documented in the
8243: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8244: </div>
1.75 rillig 8245: </div>
1.148 ! asau 8246: <div class="sect1">
1.75 rillig 8247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8248: <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 8249: <div class="sect2">
1.75 rillig 8250: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8251: <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 8252: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8253: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8254: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8255: with the name of each file to download as an argument, expecting
8256: it to output the URL of the directory from which to download
1.91 rillig 8257: 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 8258: example of this usage.</p>
1.75 rillig 8259: <p>If the download can't be automated, because the user must
1.87 wiz 8260: submit personal information to apply for a password, or must pay
8261: for the source, or whatever, you can set
8262: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8263: displayed to the user before aborting the build. Example:</p>
8264: <pre class="programlisting">
1.100 rillig 8265: FETCH_MESSAGE= "Please download the files"
8266: FETCH_MESSAGE+= " "${DISTFILES:Q}
8267: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8268: </pre>
1.75 rillig 8269: </div>
1.148 ! asau 8270: <div class="sect2">
1.75 rillig 8271: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8272: <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 8273: <p>Sometimes authors of a software package make some
1.87 wiz 8274: modifications after the software was released, and they put up a
8275: new distfile without changing the package's version number. If a
8276: package is already in pkgsrc at that time, the checksum will
8277: no longer match. The contents of the new distfile should be
8278: compared against the old one before changing anything, to make
8279: sure the distfile was really updated on purpose, and that
8280: no trojan horse or so crept in.
1.97 rillig 8281: Please mention that the distfiles were compared and what was found
8282: in your commit message.
1.87 wiz 8283: Then, the correct way to work around this is to
8284: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8285: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8286: <code class="varname">DISTFILES</code> and
1.93 rillig 8287: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8288: subdirectory of the local distfiles directory.
1.110 hubertf 8289: (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 8290: In case this
1.87 wiz 8291: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8292: including the <code class="filename">nbX</code> suffix) or a date stamp
8293: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8294: Do not forget regenerating the <code class="filename">distinfo</code> file
8295: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8296: path in the filenames.
1.97 rillig 8297: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8298: Furthermore, a mail to the package's authors seems appropriate
8299: telling them that changing distfiles after releases without
8300: changing the file names is not good practice.</p>
1.75 rillig 8301: </div>
8302: </div>
1.148 ! asau 8303: <div class="sect1">
1.75 rillig 8304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8305: <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 8306: <div class="sect2">
1.75 rillig 8307: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8308: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8309: <p>pkgsrc supports many different machines, with different
1.87 wiz 8310: object formats like a.out and ELF, and varying abilities to do
8311: shared library and dynamic loading at all. To accompany this,
8312: varying commands and options have to be passed to the
8313: compiler, linker, etc. to get the Right Thing, which can be
8314: pretty annoying especially if you don't have all the machines
8315: at your hand to test things. The
1.91 rillig 8316: <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 8317: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8318: both static and dynamic libraries from a set of source files,
8319: thus being platform-independent.</p>
8320: <p>Here's how to use libtool in a package in seven simple
8321: steps:</p>
1.128 wiz 8322: <div class="orderedlist"><ol class="orderedlist" type="1">
8323: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8324: Makefile.</p></li>
1.128 wiz 8325: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8326: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8327: add it to the definition of <code class="varname">CC</code>, if only
8328: libraries are being built in a given Makefile. This one command
8329: will build both PIC and non-PIC library objects, so you need not
8330: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8331: <li class="listitem">
1.75 rillig 8332: <p>For the linking of the library, remove any
1.128 wiz 8333: <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
8334: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8335: <pre class="programlisting">
1.100 rillig 8336: ${LIBTOOL} --mode=link \
8337: ${CC} -o ${.TARGET:.a=.la} \
8338: ${OBJS:.o=.lo} \
8339: -rpath ${PREFIX}/lib \
8340: -version-info major:minor
1.87 wiz 8341: </pre>
1.75 rillig 8342: <p>Note that the library is changed to have a
1.87 wiz 8343: <code class="filename">.la</code> extension, and the objects are
8344: changed to have a <code class="filename">.lo</code>
8345: extension. Change <code class="varname">OBJS</code> as
8346: necessary. This automatically creates all of the
8347: <code class="filename">.a</code>,
8348: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8349: necessary) in the build directory. Be sure to include
1.128 wiz 8350: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8351: minor are zero, as libtool will otherwise strip off the
8352: shared library version.</p>
1.75 rillig 8353: <p>From the libtool manual:</p>
8354: <pre class="programlisting">
1.100 rillig 8355: So, libtool library versions are described by three integers:
1.69 rillig 8356:
1.100 rillig 8357: CURRENT
8358: The most recent interface number that this library implements.
1.69 rillig 8359:
1.100 rillig 8360: REVISION
8361: The implementation number of the CURRENT interface.
1.69 rillig 8362:
1.100 rillig 8363: AGE
8364: The difference between the newest and oldest interfaces that
8365: this library implements. In other words, the library implements
8366: all the interface numbers in the range from number `CURRENT -
8367: AGE' to `CURRENT'.
1.1 grant 8368:
1.100 rillig 8369: If two libraries have identical CURRENT and AGE numbers, then the
8370: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8371: </pre>
1.128 wiz 8372: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8373: different results for a.out and ELF (excluding symlinks)
8374: in only one case. An ELF library of the form
1.128 wiz 8375: <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 8376: will have a symlink of
1.128 wiz 8377: <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 8378: on an a.out platform. This is handled
8379: automatically.</p>
1.128 wiz 8380: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8381: directory of the library being built.</p>
1.76 rillig 8382: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8383: <code class="filename">.la</code> file, the other files will be
8384: added automatically.</p>
1.75 rillig 8385: </li>
1.128 wiz 8386: <li class="listitem">
1.76 rillig 8387: <p>When linking shared object (<code class="filename">.so</code>)
1.136 dholland 8388: 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 8389: shared libraries, use <span class="quote">“<span class="quote">-module
8390: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8391: tacked on.</p>
1.76 rillig 8392: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8393: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8394: </li>
1.128 wiz 8395: <li class="listitem">
1.75 rillig 8396: <p>When linking programs that depend on these libraries
1.87 wiz 8397: <span class="emphasis"><em>before</em></span> they are installed, preface
1.136 dholland 8398: 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 8399: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8400: libraries (static or shared), but please be aware that
8401: libtool will not allow you to specify a relative path in
1.128 wiz 8402: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8403: expects you to change that argument to be the
8404: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8405: <pre class="programlisting">
1.100 rillig 8406: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8407: </pre>
1.75 rillig 8408: <p>should be changed to:</p>
8409: <pre class="programlisting">
1.100 rillig 8410: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8411: </pre>
1.75 rillig 8412: <p>and it will do the right thing with the libraries.</p>
8413: </li>
1.128 wiz 8414: <li class="listitem">
1.136 dholland 8415: <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>
8416: 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 8417: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8418: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8419: <pre class="programlisting">
1.126 jakllsch 8420: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8421: </pre>
1.76 rillig 8422: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8423: shared library, any needed symlinks, and run
1.136 dholland 8424: <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 8425: </li>
1.128 wiz 8426: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8427: the <code class="filename">.la</code>
8428: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8429: </ol></div>
8430: </div>
1.148 ! asau 8431: <div class="sect2">
1.75 rillig 8432: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8433: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8434: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8435: package Makefile. This will override the package's own libtool
8436: in most cases. For older libtool using packages, libtool is
8437: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8438: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8439: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8440: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8441: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8442: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8443: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8444: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8445: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8446: libraries built and installed, then use
8447: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8448: <p>If your package makes use of the platform-independent library
1.87 wiz 8449: for loading dynamic shared objects, that comes with libtool
8450: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8451: <p>Some packages use libtool incorrectly so that the package
8452: may not work or build in some circumstances. Some of the more
8453: common errors are:</p>
1.148 ! asau 8454: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8455: <li class="listitem">
1.75 rillig 8456: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8457: executable or library. This in itself isn't a problem if one of two things
8458: has been done:</p>
1.128 wiz 8459: <div class="orderedlist"><ol class="orderedlist" type="1">
8460: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8461: <code class="filename">libfoo.la</code>, not
8462: <code class="filename">foo.la</code></p></li>
1.128 wiz 8463: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8464: </ol></div>
8465: </li>
1.128 wiz 8466: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8467: The function lt_dlinit() should be called and the macro
8468: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8469: executables.</p></li>
1.75 rillig 8470: </ul></div>
8471: </div>
1.148 ! asau 8472: <div class="sect2">
1.75 rillig 8473: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8474: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8475: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8476: to regenerate the configure script and Makefile.in makefile
8477: templates, then they should be executed in a pre-configure
8478: target.</p>
1.75 rillig 8479: <p>For packages that need only autoconf:</p>
8480: <pre class="programlisting">
1.100 rillig 8481: AUTOCONF_REQD= 2.50 # if default version is not good enough
8482: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8483: ...
1.1 grant 8484:
1.100 rillig 8485: pre-configure:
8486: cd ${WRKSRC} && autoconf
1.1 grant 8487:
1.100 rillig 8488: ...
1.87 wiz 8489: </pre>
1.75 rillig 8490: <p>and for packages that need automake and autoconf:</p>
8491: <pre class="programlisting">
1.100 rillig 8492: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8493: USE_TOOLS+= automake # use "automake14" for automake-1.4
8494: ...
8495:
8496: pre-configure:
8497: set -e; cd ${WRKSRC}; \
8498: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8499:
1.100 rillig 8500: ...
1.87 wiz 8501: </pre>
1.75 rillig 8502: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8503: require GNU Make.</p>
1.75 rillig 8504: <p>There are times when the configure process makes
1.87 wiz 8505: additional changes to the generated files, which then causes
8506: the build process to try to re-execute the automake sequence.
8507: This is prevented by touching various files in the configure
8508: stage. If this causes problems with your package you can set
8509: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8510: Makefile.</p>
1.75 rillig 8511: </div>
8512: </div>
1.148 ! asau 8513: <div class="sect1">
1.75 rillig 8514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8515: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148 ! asau 8516: <div class="sect2">
1.87 wiz 8517: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8518: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8519: <p>Compilers for the C, C++, and Fortran languages comes with
8520: the NetBSD base system. By default, pkgsrc assumes that a package
8521: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8522: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8523: <p>To declare which language's compiler a package needs, set
8524: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8525: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8526: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8527: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8528: written in C++, usually need a C compiler for the configure
8529: phase.</p>
8530: </div>
1.148 ! asau 8531: <div class="sect2">
1.87 wiz 8532: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8533: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8534: <p>If a program is written in Java, use the Java framework in
8535: pkgsrc. The package must include
8536: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8537: provides the following variables:</p>
1.148 ! asau 8538: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8539: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8540: dependency on the JDK is added. If
1.128 wiz 8541: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8542: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8543: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8544: JDK.</p></li>
1.128 wiz 8545: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8546: a package needs a Java2 implementation. The supported values
1.128 wiz 8547: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8548: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8549: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8550: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8551: above. This variable is not set by default.</p></li>
1.130 wiz 8552: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8553: automatically set to the runtime location of the used Java
8554: implementation dependency. It may be used to set
8555: <code class="varname">JAVA_HOME</code> to a good value if the program
8556: needs this variable to be defined.
8557: </p></li>
1.87 wiz 8558: </ul></div>
8559: </div>
1.148 ! asau 8560: <div class="sect2">
1.87 wiz 8561: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8562: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8563: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8564: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8565: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8566: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8567: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8568: that you want adjusted. Every occurrence of
8569: <code class="filename">*/bin/perl</code> will be replaced with the full
8570: path to the perl executable.</p>
8571: <p>If a particular version of perl is needed, set the
8572: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8573: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8574: <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 8575: about handling perl modules.</p>
8576: </div>
1.148 ! asau 8577: <div class="sect2">
1.87 wiz 8578: <div class="titlepage"><div><div><h3 class="title">
1.147 wiz 8579: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8580: <p><code class="varname">REPLACE_SH</code>,
8581: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8582: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8583: hash bangs in files. Please use the appropriate one, prefering
8584: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
8585: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8586: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8587: </div>
1.148 ! asau 8588: <div class="sect2">
1.147 wiz 8589: <div class="titlepage"><div><div><h3 class="title">
8590: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 8591: <p>Currently, there is no special handling for other languages
8592: in pkgsrc. If a compiler package provides a
8593: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8594: just add a (build) dependency on the appropriate compiler
8595: package.</p>
8596: </div>
8597: </div>
1.148 ! asau 8598: <div class="sect1">
1.87 wiz 8599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8600: <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 8601: <p>The most common failures when building a package are that
8602: some platforms do not provide certain header files, functions or
8603: libraries, or they provide the functions in a library that the
8604: original package author didn't know. To work around this, you
8605: can rewrite the source code in most cases so that it does not
8606: use the missing functions or provides a replacement function.</p>
1.148 ! asau 8607: <div class="sect2">
1.77 rillig 8608: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8609: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8610: <p>If a package already comes with a GNU configure script, the
8611: preferred way to fix the build failure is to change the
8612: configure script, not the code. In the other cases, you can
8613: utilize the C preprocessor, which defines certain macros
8614: depending on the operating system and hardware architecture it
8615: compiles for. These macros can be queried using for example
8616: <code class="varname">#if defined(__i386)</code>. Almost every operating
8617: system, hardware architecture and compiler has its own macro.
8618: For example, if the macros <code class="varname">__GNUC__</code>,
8619: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8620: are all defined, you know that you are using NetBSD on an i386
8621: compatible CPU, and your compiler is GCC.</p>
8622: <p>The list of the following macros for hardware and
8623: operating system depends on the compiler that is used. For
8624: example, if you want to conditionally compile code on Solaris,
8625: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8626: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 ! asau 8627: <div class="sect3">
1.75 rillig 8628: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8629: <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 8630: <p>To distinguish between 4.4 BSD-derived systems and the
8631: rest of the world, you should use the following code.</p>
8632: <pre class="programlisting">
1.100 rillig 8633: #include <sys/param.h>
8634: #if (defined(BSD) && BSD >= 199306)
8635: /* BSD-specific code goes here */
8636: #else
8637: /* non-BSD-specific code goes here */
8638: #endif
1.75 rillig 8639: </pre>
1.77 rillig 8640: <p>If this distinction is not fine enough, you can also test
8641: for the following macros.</p>
1.75 rillig 8642: <pre class="programlisting">
1.100 rillig 8643: FreeBSD __FreeBSD__
8644: DragonFly __DragonFly__
8645: Interix __INTERIX
8646: IRIX __sgi (TODO: get a definite source for this)
8647: Linux linux, __linux, __linux__
8648: NetBSD __NetBSD__
8649: OpenBSD __OpenBSD__
8650: Solaris sun, __sun
1.75 rillig 8651: </pre>
8652: </div>
1.148 ! asau 8653: <div class="sect3">
1.75 rillig 8654: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8655: <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 8656: <pre class="programlisting">
1.100 rillig 8657: i386 i386, __i386, __i386__
8658: MIPS __mips
8659: SPARC sparc, __sparc
1.75 rillig 8660: </pre>
8661: </div>
1.148 ! asau 8662: <div class="sect3">
1.75 rillig 8663: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8664: <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 8665: <pre class="programlisting">
1.100 rillig 8666: GCC __GNUC__ (major version), __GNUC_MINOR__
8667: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8668: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8669: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8670: </pre>
8671: </div>
8672: </div>
1.148 ! asau 8673: <div class="sect2">
1.78 rillig 8674: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8675: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8676: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8677: combinations of compiler version and architecture and almost
8678: always relation to optimisation being enabled. Common symptoms
8679: are gcc internal errors or never finishing compiling a
1.78 rillig 8680: file.</p>
8681: <p>Typically, a workaround involves testing the
8682: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8683: optimisation for that combination of file,
8684: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8685: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8686: number of examples.</p>
8687: </div>
1.148 ! asau 8688: <div class="sect2">
1.78 rillig 8689: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 8690: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8691: </h3></div></div></div>
1.92 rillig 8692: <p>This error message often means that a package did not
1.78 rillig 8693: link to a shared library it needs. The following functions are
8694: known to cause this error message over and over.</p>
8695: <div class="informaltable">
8696: <a name="undefined-reference-functions"></a><table border="1">
8697: <colgroup>
8698: <col>
8699: <col>
8700: <col>
8701: </colgroup>
8702: <thead><tr>
8703: <th>Function</th>
8704: <th>Library</th>
8705: <th>Affected platforms</th>
8706: </tr></thead>
8707: <tbody>
8708: <tr>
8709: <td>accept, bind, connect</td>
8710: <td>-lsocket</td>
8711: <td>Solaris</td>
8712: </tr>
8713: <tr>
8714: <td>crypt</td>
8715: <td>-lcrypt</td>
8716: <td>DragonFly, NetBSD</td>
8717: </tr>
8718: <tr>
8719: <td>dlopen, dlsym</td>
8720: <td>-ldl</td>
8721: <td>Linux</td>
8722: </tr>
8723: <tr>
8724: <td>gethost*</td>
8725: <td>-lnsl</td>
8726: <td>Solaris</td>
8727: </tr>
8728: <tr>
8729: <td>inet_aton</td>
8730: <td>-lresolv</td>
8731: <td>Solaris</td>
8732: </tr>
8733: <tr>
8734: <td>nanosleep, sem_*, timer_*</td>
8735: <td>-lrt</td>
8736: <td>Solaris</td>
8737: </tr>
8738: <tr>
8739: <td>openpty</td>
8740: <td>-lutil</td>
8741: <td>Linux</td>
8742: </tr>
8743: </tbody>
8744: </table>
8745: </div>
8746: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8747: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8748: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8749: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8750: bmake</strong></span>.</p>
1.148 ! asau 8751: <div class="sect3">
1.92 rillig 8752: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8753: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8754: <p>When you are using the SunPro compiler, there is another
8755: possibility. That compiler cannot handle the following code:</p>
8756: <pre class="programlisting">
1.100 rillig 8757: extern int extern_func(int);
1.93 rillig 8758:
1.100 rillig 8759: static inline int
8760: inline_func(int x)
8761: {
1.92 rillig 8762: return extern_func(x);
1.100 rillig 8763: }
1.93 rillig 8764:
1.100 rillig 8765: int main(void)
8766: {
1.92 rillig 8767: return 0;
1.100 rillig 8768: }
1.92 rillig 8769: </pre>
8770: <p>It generates the code for <code class="function">inline_func</code> even if
8771: that function is never used. This code then refers to
8772: <code class="function">extern_func</code>, which can usually not be resolved. To
8773: solve this problem you can try to tell the package to disable inlining
8774: of functions.</p>
8775: </div>
1.87 wiz 8776: </div>
1.148 ! asau 8777: <div class="sect2">
1.87 wiz 8778: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8779: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8780: <p>Sometimes packages fail to build because the compiler runs
8781: into an operating system specific soft limit. With the
8782: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8783: to unlimit the resources. Currently, the allowed values are
1.128 wiz 8784: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8785: Setting this variable is similar to running the shell builtin
1.110 hubertf 8786: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8787: segment size or maximum stack size of a process, respectively, to
8788: their hard limits.</p>
1.78 rillig 8789: </div>
1.75 rillig 8790: </div>
1.148 ! asau 8791: <div class="sect1">
1.75 rillig 8792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8793: <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 8794: <div class="sect2">
1.75 rillig 8795: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8796: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8797: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8798: with some operating systems cannot create more than one
8799: directory at a time. As such, you should call
8800: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8801: <pre class="programlisting">
1.100 rillig 8802: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8803: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8804: </pre>
1.128 wiz 8805: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8806: dir2</code></span>”</span> to the
1.87 wiz 8807: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8808: automatically do the right thing.</p>
1.75 rillig 8809: </div>
1.148 ! asau 8810: <div class="sect2">
1.75 rillig 8811: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8812: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8813: <p>In general, documentation should be installed into
1.87 wiz 8814: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8815: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8816: includes the version number of the package).</p>
1.84 wiz 8817: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8818: directory where HTML documentation is installed with the
1.128 wiz 8819: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8820: is needed because otherwise the documentation ends up in
8821: <code class="filename">${PREFIX}/share/doc/html</code> or other
8822: places.</p>
8823: <p>An exception to the above is that library API documentation
1.91 rillig 8824: 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 8825: browsers (devhelp) should be left at their default location, which
8826: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8827: documentation can be recognized from files ending in
8828: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8829: (It is also acceptable to install such files in
8830: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8831: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8832: <code class="filename">.devhelp*</code> file must be directly in that
8833: directory then, no additional subdirectory level is allowed in
8834: this case. This is usually achieved by using
1.128 wiz 8835: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8836: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8837: though.)</p>
1.75 rillig 8838: </div>
1.148 ! asau 8839: <div class="sect2">
1.75 rillig 8840: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8841: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8842: <p>Certain packages, most of them in the games category, install
1.87 wiz 8843: a score file that allows all users on the system to record their
8844: highscores. In order for this to work, the binaries need to be
8845: installed setgid and the score files owned by the appropriate
1.142 wiz 8846: group and/or owner (traditionally the "games" user/group). Set
8847: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8848: following variables, documented in more detail in
8849: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8850: behaviour: <code class="varname">GAMEDATAMODE</code>,
8851: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8852: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.114 jmcneill 8853: <p>A package should therefore never hard code file ownership or
1.87 wiz 8854: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8855: <code class="varname">INSTALL_GAME_DATA</code> to set these
8856: correctly.</p>
1.75 rillig 8857: </div>
1.148 ! asau 8858: <div class="sect2">
1.75 rillig 8859: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8860: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8861: <p><code class="varname">DESTDIR</code> support means that a package
8862: installs into a staging directory, not the final location of the
8863: files. Then a binary package is created which can be used for
8864: installation as usual. There are two ways: Either the package must
1.128 wiz 8865: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8866: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 ! asau 8867: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8868: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145 wiz 8869: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8870: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8871: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8872: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8873: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8874: the inclusion.</p></li>
1.128 wiz 8875: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8876: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8877: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8878: automatically. Many manual rules and pre/post-install often are
8879: incorrect; fix them.</p></li>
1.128 wiz 8880: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8881: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8882: <li class="listitem"><p>In general, packages should support
1.103 wiz 8883: <code class="varname">UNPRIVILEGED</code> to be able to use
8884: DESTDIR.</p></li>
8885: </ul></div>
8886: </div>
1.148 ! asau 8887: <div class="sect2">
1.103 wiz 8888: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8889: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8890: <p>Your package may also contain scripts with hardcoded paths to
8891: other interpreters besides (or as well as) perl. To correct the
8892: full pathname to the script interpreter, you need to set the
8893: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8894: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8895: <pre class="programlisting">
1.100 rillig 8896: REPLACE_INTERPRETER+= tcl
8897: REPLACE.tcl.old= .*/bin/tclsh
8898: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8899: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8900: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8901: </pre>
1.148 ! asau 8902: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8903: <h3 class="title">Note</h3>
8904: <p>Before March 2006, these variables were called
1.87 wiz 8905: <code class="varname">_REPLACE.*</code> and
8906: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8907: </div>
8908: </div>
1.148 ! asau 8909: <div class="sect2">
1.75 rillig 8910: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8911: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8912: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8913: the Makefile fragment
8914: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8915: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8916: configuration for such modules as well as various hooks to tune
8917: this configuration. See comments in this file for
8918: details.</p>
1.75 rillig 8919: <p>Perl5 modules will install into different places depending
1.87 wiz 8920: on the version of perl used during the build process. To
8921: address this, pkgsrc will append lines to the
8922: <code class="filename">PLIST</code> corresponding to the files listed in
8923: the installed <code class="filename">.packlist</code> file generated by
8924: most perl5 modules. This is invoked by defining
8925: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8926: paths to packlist files, e.g.:</p>
1.75 rillig 8927: <pre class="programlisting">
1.100 rillig 8928: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87 wiz 8929: </pre>
1.75 rillig 8930: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8931: <code class="varname">PERL5_SITEARCH</code>, and
8932: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8933: in which perl5 modules may be installed, and may be used by
8934: perl5 packages that don't have a packlist. These three
8935: variables are also substituted for in the
8936: <code class="filename">PLIST</code>.</p>
1.75 rillig 8937: </div>
1.148 ! asau 8938: <div class="sect2">
1.75 rillig 8939: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8940: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8941: <p>Some packages install info files or use the
1.128 wiz 8942: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8943: commands. <code class="varname">INFO_FILES</code> should be defined in
8944: the package Makefile so that <code class="filename">INSTALL</code> and
8945: <code class="filename">DEINSTALL</code> scripts will be generated to
8946: handle registration of the info files in the Info directory
1.128 wiz 8947: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8948: files registration is either provided by the system, or by a
8949: special purpose package automatically added as dependency if
8950: needed.</p>
1.75 rillig 8951: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8952: <code class="filename">${PREFIX}</code> where info files are primarily
8953: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8954: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8955: <p>The info files for the package should be listed in the
1.87 wiz 8956: package <code class="filename">PLIST</code>; however any split info files
8957: need not be listed.</p>
1.128 wiz 8958: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8959: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8960: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8961: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8962: should be noted with the <code class="varname">TEXINFO_REQD</code>
8963: variable in the package <code class="filename">Makefile</code>. By
8964: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8965: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8966: does not match the required minimum, a build dependency on the
1.91 rillig 8967: <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 8968: be added automatically.</p>
1.75 rillig 8969: <p>The build and installation process of the software provided
1.87 wiz 8970: by the package should not use the
1.110 hubertf 8971: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8972: info files is the task of the package
8973: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8974: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8975: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8976: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8977: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8978: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8979: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8980: no effect except the logging of a message. The script overriding
1.110 hubertf 8981: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8982: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8983: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8984: </div>
1.148 ! asau 8985: <div class="sect2">
1.75 rillig 8986: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8987: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8988: <p>All packages that install manual pages should install them
1.87 wiz 8989: into the same directory, so that there is one common place to look
8990: for them. In pkgsrc, this place is
8991: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8992: should be used in packages. The default for
8993: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8994: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8995: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 ! asau 8996: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8997: <h3 class="title">Note</h3>
1.87 wiz 8998: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8999: is far from complete.</p>
1.75 rillig 9000: </div>
1.81 rillig 9001: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 9002: <code class="filename">man/</code> as the top level directory for the man
9003: page file entries, and the pkgsrc framework will convert as
9004: needed. In all other places, the correct
9005: <code class="varname">PKGMANDIR</code> must be used.</p>
9006: <p>Packages that are
9007: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 9008: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 9009: <code class="filename">./configure</code>
9010: --mandir switch to set where the man pages should be installed.
9011: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9012: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9013: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9014: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 9015: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 9016: Or if the <code class="filename">./configure</code> script uses
9017: a non-standard use of --mandir, you can set
9018: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 9019: <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 9020: information on installation of compressed manual pages.</p>
1.75 rillig 9021: </div>
1.148 ! asau 9022: <div class="sect2">
1.75 rillig 9023: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 9024: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 9025: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 9026: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 9027: you need to take some extra steps to make sure they get registered
9028: in the database:</p>
1.128 wiz 9029: <div class="orderedlist"><ol class="orderedlist" type="1">
9030: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 9031: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 9032: takes care of rebuilding the GConf database at installation and
1.87 wiz 9033: deinstallation time, and tells the package where to install
1.107 rillig 9034: GConf data files using some standard configure arguments. It
1.87 wiz 9035: also disallows any access to the database directly from the
9036: package.</p></li>
1.128 wiz 9037: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 9038: <code class="filename">.schemas</code> files under
9039: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9040: installed under <code class="filename">${PREFIX}/etc</code>, you will
9041: need to manually patch the package.</p></li>
1.128 wiz 9042: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 9043: directory, as they will be handled automatically. See
1.110 hubertf 9044: <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 9045: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 9046: your <code class="filename">Makefile</code> with a list of all
9047: <code class="filename">.schemas</code> files installed by the package, if
9048: any. Names must not contain any directories in them.</p></li>
1.128 wiz 9049: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 9050: your <code class="filename">Makefile</code> with a
9051: list of all <code class="filename">.entries</code> files installed by the
9052: package, if any. Names must not contain any directories in
9053: them.</p></li>
1.75 rillig 9054: </ol></div>
9055: </div>
1.148 ! asau 9056: <div class="sect2">
1.75 rillig 9057: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 9058: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 9059: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 9060: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 9061: get registered in the database:</p>
1.128 wiz 9062: <div class="orderedlist"><ol class="orderedlist" type="1">
9063: <li class="listitem"><p>Include
1.119 mishka 9064: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9065: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 9066: takes care of rebuilding the scrollkeeper database at
9067: installation and deinstallation time, and disallows any access
9068: to it directly from the package.</p></li>
1.128 wiz 9069: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9070: <code class="filename">libdata/scrollkeeper</code> directory, as they
9071: will be handled automatically.</p></li>
1.128 wiz 9072: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 9073: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9074: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 9075: </ol></div>
9076: </div>
1.148 ! asau 9077: <div class="sect2">
1.75 rillig 9078: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9079: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9080: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9081: the fonts database in the directory where they get installed at
9082: installation and deinstallation time. This can be automatically
9083: done by using the pkginstall framework.</p>
1.75 rillig 9084: <p>You can list the directories where fonts are installed in the
1.87 wiz 9085: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9086: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9087: <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 9088: Also make sure that the database file
9089: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9090: <p>Note that you should not create new directories for fonts;
1.87 wiz 9091: instead use the standard ones to avoid that the user needs to
9092: manually configure his X server to find them.</p>
1.75 rillig 9093: </div>
1.148 ! asau 9094: <div class="sect2">
1.75 rillig 9095: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9096: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9097: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9098: take some extra steps to get them registered in the GTK2 database
9099: properly:</p>
1.128 wiz 9100: <div class="orderedlist"><ol class="orderedlist" type="1">
9101: <li class="listitem"><p>Include
1.87 wiz 9102: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9103: <code class="filename">buildlink3.mk</code> file. This takes care of
9104: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 9105: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 9106: your package installs GTK2 immodules.</p></li>
1.128 wiz 9107: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 9108: GTK2 loaders.</p></li>
1.128 wiz 9109: <li class="listitem">
1.87 wiz 9110: <p>Patch the package to not touch any of the GTK2
9111: databases directly. These are:</p>
1.148 ! asau 9112: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9113: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9114: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9115: </ul></div>
9116: </li>
1.128 wiz 9117: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 9118: any entries under the <code class="filename">libdata/gtk-2.0</code>
9119: directory, as they will be handled automatically.</p></li>
1.75 rillig 9120: </ol></div>
9121: </div>
1.148 ! asau 9122: <div class="sect2">
1.75 rillig 9123: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9124: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9125: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9126: registered in system-wide catalogs (like DTDs, sub-catalogs,
9127: etc.), you need to take some extra steps:</p>
1.128 wiz 9128: <div class="orderedlist"><ol class="orderedlist" type="1">
9129: <li class="listitem"><p>Include
1.87 wiz 9130: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9131: your <code class="filename">Makefile</code>, which takes care of
9132: registering those files in system-wide catalogs at
9133: installation and deinstallation time.</p></li>
1.128 wiz 9134: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9135: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9136: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9137: any XML catalogs installed by the package.</p></li>
1.128 wiz 9138: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9139: to be added to the SGML catalog. These come in groups of
9140: three strings; see xmlcatmgr(1) for more information
9141: (specifically, arguments recognized by the 'add' action).
9142: Note that you will normally not use this variable.</p></li>
1.128 wiz 9143: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9144: to be added to the XML catalog. These come in groups of three
9145: strings; see xmlcatmgr(1) for more information (specifically,
9146: arguments recognized by the 'add' action). Note that you will
9147: normally not use this variable.</p></li>
1.75 rillig 9148: </ol></div>
9149: </div>
1.148 ! asau 9150: <div class="sect2">
1.75 rillig 9151: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9152: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9153: <p>If a package provides extensions to the MIME database by
1.87 wiz 9154: installing <code class="filename">.xml</code> files inside
9155: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9156: need to take some extra steps to ensure that the database is kept
9157: consistent with respect to these new files:</p>
1.128 wiz 9158: <div class="orderedlist"><ol class="orderedlist" type="1">
9159: <li class="listitem"><p>Include
1.87 wiz 9160: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9161: (avoid using the <code class="filename">buildlink3.mk</code> file from
9162: this same directory, which is reserved for inclusion from
9163: other <code class="filename">buildlink3.mk</code> files). It takes
9164: care of rebuilding the MIME database at installation and
9165: deinstallation time, and disallows any access to it directly
9166: from the package.</p></li>
1.128 wiz 9167: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9168: <code class="filename">share/mime</code> directory,
9169: <span class="emphasis"><em>except</em></span> for files saved under
9170: <code class="filename">share/mime/packages</code>. The former are
9171: handled automatically by
9172: the update-mime-database program, but the latter are
9173: package-dependent and must be removed by the package that
9174: installed them in the first place.</p></li>
1.128 wiz 9175: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9176: from the PLIST. They will be handled by the shared-mime-info
9177: package.</p></li>
1.75 rillig 9178: </ol></div>
9179: </div>
1.148 ! asau 9180: <div class="sect2">
1.75 rillig 9181: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9182: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9183: <p>If a package uses intltool during its build, add
9184: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9185: which forces it to use the intltool package provided by pkgsrc,
9186: instead of the one bundled with the distribution file.</p>
1.75 rillig 9187: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9188: latest available version; this way, the package benefits of any
9189: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9190: </div>
1.148 ! asau 9191: <div class="sect2">
1.75 rillig 9192: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9193: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9194: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9195: the startup directory by default, but you can enable it, by adding
9196: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9197: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9198: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9199: it will automatically remove the scripts when the package is
9200: deinstalled.</p>
1.75 rillig 9201: </div>
1.148 ! asau 9202: <div class="sect2">
1.75 rillig 9203: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9204: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9205: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9206: the <code class="filename">ls-R</code> database of the tree needs to be
9207: updated.</p>
1.148 ! asau 9208: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9209: <h3 class="title">Note</h3>
1.125 wiz 9210: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9211: packages should install files
1.125 wiz 9212: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9213: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9214: </div>
1.128 wiz 9215: <div class="orderedlist"><ol class="orderedlist" type="1">
9216: <li class="listitem"><p>Include
1.125 wiz 9217: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9218: takes care of rebuilding the <code class="filename">ls-R</code>
9219: database at installation and deinstallation time.</p></li>
1.128 wiz 9220: <li class="listitem">
1.75 rillig 9221: <p>If your package installs files into a texmf
1.87 wiz 9222: tree other than the one
1.125 wiz 9223: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9224: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9225: trees that need database update.</p>
1.75 rillig 9226: <p>If your package also installs font map files that need
1.110 hubertf 9227: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9228: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9229: set <code class="varname">TEX_MAP_FILES</code> and/or
9230: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9231: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9232: be run automatically at installation/deinstallation to
9233: enable/disable font map files for TeX output
9234: drivers.</p>
1.75 rillig 9235: </li>
1.128 wiz 9236: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9237: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9238: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9239: </ol></div>
9240: </div>
1.148 ! asau 9241: <div class="sect2">
1.85 jmmv 9242: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9243: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9244: emulation</h3></div></div></div>
9245: <p>There are some packages that provide libraries and
9246: executables for running binaries from a one operating system
9247: on a different one (if the latter supports it). One example
9248: is running Linux binaries on NetBSD.</p>
1.91 rillig 9249: <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 9250: helps in extracting and packaging Linux rpm packages.</p>
9251: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9252: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9253: if all libraries for each installed executable can be found by
9254: the dynamic linker. Since the standard dynamic linker is run,
9255: this fails for emulation packages, because the libraries used
9256: by the emulation are not in the standard directories.</p>
9257: </div>
1.148 ! asau 9258: <div class="sect2">
1.87 wiz 9259: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9260: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9261: <p>If a package installs images under the
1.87 wiz 9262: <code class="filename">share/icons/hicolor</code> and/or updates the
9263: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9264: database, you need to take some extra steps to make sure that the
9265: shared theme directory is handled appropriately and that the cache
9266: database is rebuilt:</p>
1.128 wiz 9267: <div class="orderedlist"><ol class="orderedlist" type="1">
9268: <li class="listitem"><p>Include
1.87 wiz 9269: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 9270: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9271: entry that refers to the theme cache.</p></li>
1.128 wiz 9272: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9273: directories from the <code class="filename">share/icons/hicolor</code>
9274: hierarchy because they will be handled automatically.</p></li>
9275: </ol></div>
9276: <p>The best way to verify that the PLIST is correct with
9277: respect to the last two points is to regenerate it using
1.110 hubertf 9278: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9279: </div>
1.148 ! asau 9280: <div class="sect2">
1.85 jmmv 9281: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9282: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9283: <p>If a package installs <code class="filename">.desktop</code> files
9284: under <code class="filename">share/applications</code> and these include
9285: MIME information, you need to take extra steps to ensure that they
9286: are registered into the MIME database:</p>
1.128 wiz 9287: <div class="orderedlist"><ol class="orderedlist" type="1">
9288: <li class="listitem"><p>Include
1.85 jmmv 9289: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 9290: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9291: <code class="filename">share/applications/mimeinfo.cache</code> file.
9292: It will be handled automatically.</p></li>
9293: </ol></div>
9294: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9295: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9296: print-PLIST</strong></span>.</p>
1.75 rillig 9297: </div>
9298: </div>
1.148 ! asau 9299: <div class="sect1">
1.87 wiz 9300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9301: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9302: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9303: immediately. In this case, one can plainly mark a package as broken. For
9304: this, one just sets the variable <code class="varname">BROKEN</code> to the
9305: reason why the package is broken (similar to the
9306: <code class="varname">RESTRICTED</code> variable). A user trying to build
9307: the package will immediately be shown this message, and the build
9308: will not be even tried.</p>
9309: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9310: intervals.</p>
9311: </div>
1.75 rillig 9312: </div>
1.148 ! asau 9313: <div class="chapter">
1.75 rillig 9314: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9315: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9316: <p>To check out all the gotchas when building a package, here are
9317: the steps that I do in order to get a package working. Please note
9318: this is basically the same as what was explained in the previous
9319: sections, only with some debugging aids.</p>
1.148 ! asau 9320: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9321: <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>
9322: <li class="listitem">
1.91 rillig 9323: <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 9324: create a directory for a new package, change into it, then run
1.110 hubertf 9325: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9326: <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>
9327: <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>
9328: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9329: </li>
1.128 wiz 9330: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9331: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9332: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9333: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9334: configure step to the package's
9335: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 9336: <li class="listitem">
1.75 rillig 9337: <p>Make the package compile, doing multiple rounds of</p>
9338: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9339: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9340: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9341: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9342: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9343: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9344: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9345: <p>Doing this step as non-root user will ensure that no files
9346: are modified that shouldn't be, especially during the build
1.110 hubertf 9347: phase. <span class="command"><strong>mkpatches</strong></span>,
9348: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91 rillig 9349: 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 9350: package.</p>
1.75 rillig 9351: </li>
1.128 wiz 9352: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9353: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9354: <li class="listitem">
1.76 rillig 9355: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9356: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9357: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9358: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9359: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9360: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9361: <p>You usually need to be <code class="username">root</code> to do
9362: this. Look if there are any files left:</p>
1.75 rillig 9363: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9364: <p>If this reveals any files that are missing in
1.88 wiz 9365: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9366: </li>
1.128 wiz 9367: <li class="listitem">
1.88 wiz 9368: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9369: package again and make a binary package:</p>
1.75 rillig 9370: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9371: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9372: </li>
1.128 wiz 9373: <li class="listitem">
1.75 rillig 9374: <p>Delete the installed package:</p>
1.88 wiz 9375: <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 9376: </li>
1.128 wiz 9377: <li class="listitem">
1.110 hubertf 9378: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9379: command, which shouldn't find anything now:</p>
1.75 rillig 9380: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9381: </li>
1.128 wiz 9382: <li class="listitem">
1.75 rillig 9383: <p>Reinstall the binary package:</p>
1.93 rillig 9384: <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 9385: </li>
1.128 wiz 9386: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9387: <li class="listitem">
1.110 hubertf 9388: <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 9389: reports:</p>
1.75 rillig 9390: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9391: </li>
1.128 wiz 9392: <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 9393: </ul></div>
9394: </div>
1.148 ! asau 9395: <div class="chapter">
1.75 rillig 9396: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9397: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9398: <div class="toc">
9399: <p><b>Table of Contents</b></p>
9400: <dl>
1.106 rillig 9401: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9402: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9403: <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 9404: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 9405: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9406: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9407: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9408: </dl>
9409: </div>
1.148 ! asau 9410: <div class="sect1">
1.75 rillig 9411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9412: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9413: <p>Our policy is that we accept binaries only from pkgsrc
9414: developers to guarantee that the packages don't contain any
9415: trojan horses etc. This is not to annoy anyone but rather to
9416: protect our users! You're still free to put up your home-made
9417: binary packages and tell the world where to get them. NetBSD
9418: developers doing bulk builds and wanting to upload them please
1.110 hubertf 9419: 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 9420: </div>
1.148 ! asau 9421: <div class="sect1">
1.75 rillig 9422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9423: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9424: <p>First, check that your package is complete, compiles and
1.110 hubertf 9425: 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 9426: 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 9427: archive that contains all files that make up the package.
1.87 wiz 9428: Finally, send this package to the pkgsrc bug tracking system,
1.136 dholland 9429: 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 9430: that, go to the web page
1.110 hubertf 9431: <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 9432: which contains some instructions and a link to a form where you
9433: can submit packages. The
9434: <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
9435: also available as a substitute for either of the above two tools.
9436: </p>
1.87 wiz 9437: <p>In the form of the problem report, the category should be
1.128 wiz 9438: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9439: and version number, and the description field should contain a
9440: short description of your package (contents of the COMMENT
9441: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9442: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9443: <p>If you want to submit several packages, please send a
9444: separate PR for each one, it's easier for us to track things
9445: that way.</p>
9446: <p>Alternatively, you can also import new packages into
1.128 wiz 9447: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9448: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9449: for details.</p>
9450: </div>
1.148 ! asau 9451: <div class="sect1">
1.75 rillig 9452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9453: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9454: <p>Please note all package additions, updates, moves, and
1.93 rillig 9455: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9456: important to keep this file up to date and conforming to the
9457: existing format, because it will be used by scripts to
1.110 hubertf 9458: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9459: sites. Additionally, check the
1.76 rillig 9460: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9461: for the package you updated or removed, in case it was mentioned
9462: there.</p>
9463: <p>When the <code class="varname">PKGREVISION</code> of a package is
9464: bumped, the change should appear in
1.93 rillig 9465: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9466: related or otherwise relevant. Mass bumps that result from a
9467: dependency being updated should not be mentioned. In all other
9468: cases it's the developer's decision.</p>
9469: <p>There is a make target that helps in creating proper
1.110 hubertf 9470: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9471: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9472: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9473: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9474: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9475: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9476: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9477: For new packages, or package moves or removals, set the
9478: <code class="varname">CTYPE</code> variable on the command line to "Added",
9479: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9480: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9481: not the same as your NetBSD login name. The target also automatically
9482: removes possibly existing entries for the package in the
9483: <code class="filename">TODO</code> file. Don't forget to commit
9484: the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
1.126 jakllsch 9485: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9486: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9487: makes the cvs commands use the main repository.
9488: </p>
1.75 rillig 9489: </div>
1.148 ! asau 9490: <div class="sect1">
1.75 rillig 9491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140 wiz 9492: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9493: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9494: access to the pkgsrc repository.</p>
9495: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9496: Start by adding the directory and then files in the directory. Don't
9497: forget to add the new package to the category's
9498: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9499: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9500: <pre class="programlisting">
9501: <code class="prompt">$</code> cd .../pkgsrc/category
9502: <code class="prompt">$</code> cvs add pkgname
9503: <code class="prompt">$</code> cd pkgname
9504: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9505: <code class="prompt">$</code> cvs add patches/p*
9506: <code class="prompt">$</code> cvs status | less
1.141 wiz 9507: <code class="prompt">$</code> cvs commit
1.140 wiz 9508: <code class="prompt">$</code> cd ..
9509: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9510: <code class="prompt">$</code> cvs commit Makefile
1.140 wiz 9511: </pre>
1.87 wiz 9512: <p>The commit message of the initial import should include part of the
1.76 rillig 9513: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9514: what the package is/does.</p>
1.140 wiz 9515: <p>Also mention the new package in
9516: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9517: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9518: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9519: </div>
1.148 ! asau 9520: <div class="sect1">
1.75 rillig 9521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9522: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9523: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9524: changes between old and new versions into the commit log when updating
1.87 wiz 9525: a package. There are various reasons for this:</p>
1.148 ! asau 9526: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9527: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9528: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9529: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9530: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9531: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9532: repository is very useful for people who read the pkgsrc-changes mailing
9533: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9534: the package.</p></li>
1.75 rillig 9535: </ul></div>
1.87 wiz 9536: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9537: has been released, it should not automatically be upgraded in the CVS
9538: repository. We prefer to be conservative in the packages that are
9539: included in pkgsrc - development or beta packages are not really the
9540: best thing for most places in which pkgsrc is used. Please use your
9541: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9542: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9543: </div>
1.148 ! asau 9544: <div class="sect1">
1.75 rillig 9545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9546: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9547: <p>Renaming packages is not recommended.</p>
9548: <p>When renaming packages, be sure to fix any references to old name
9549: in other Makefiles, options, buildlink files, etc.</p>
9550: <p>Also When renaming a package, please define
9551: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9552: pattern(s) of the previous package name.
9553: This may be repeated for multiple renames.
9554: The new package would be an exact replacement.
9555: </p>
1.128 wiz 9556: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9557: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9558: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9559: not be an exact replacement but is a suggestion for the replaced
9560: functionality.</p>
9561: </div>
1.148 ! asau 9562: <div class="sect1">
1.122 reed 9563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9564: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9565: <p>It is preferred that packages are not renamed or moved, but if needed
9566: please follow these steps.
9567: </p>
1.128 wiz 9568: <div class="orderedlist"><ol class="orderedlist" type="1">
9569: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9570: <li class="listitem">
1.75 rillig 9571: <p>Remove all CVS dirs.</p>
1.87 wiz 9572: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9573: <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 9574: <p>and use that for further work.</p>
1.75 rillig 9575: </li>
1.128 wiz 9576: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9577: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9578: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9579: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9580: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9581: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9582: for doing an update using pkgsrc building; for example, it can
1.136 dholland 9583: 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 9584: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9585: new <code class="varname">PKGPATH</code> for that moved package. Note that
9586: it may have multiple matches, so the tool should also check on the
9587: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9588: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9589: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9590: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9591: place.</p></li>
1.128 wiz 9592: <li class="listitem">
1.75 rillig 9593: <p>Check if any package depends on it:
9594: </p>
9595: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9596: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9597: </li>
1.128 wiz 9598: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9599: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9600: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9601: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9602: <li class="listitem">
1.75 rillig 9603: <p>Commit the changed and removed files:</p>
9604: <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 9605: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9606: </li>
9607: </ol></div>
9608: </div>
9609: </div>
1.148 ! asau 9610: <div class="chapter">
1.75 rillig 9611: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9612: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9613: <p>This section contains the answers to questions that may
9614: arise when you are writing a package. If you don't find your
9615: question answered here, first have a look in the other chapters,
9616: and if you still don't have the answer, ask on the
9617: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 ! asau 9618: <div class="qandaset">
! 9619: <a name="idm11525568"></a><dl>
1.106 rillig 9620: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9621: MAKEFLAGS, .MAKEFLAGS and
9622: MAKE_FLAGS?</a>
9623: </dt>
1.106 rillig 9624: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9625: MAKE, GMAKE and
9626: MAKE_PROGRAM?</a>
9627: </dt>
1.106 rillig 9628: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9629: CC, PKG_CC and
9630: PKGSRC_COMPILER?</a>
9631: </dt>
1.106 rillig 9632: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9633: BUILDLINK_LDFLAGS,
9634: BUILDLINK_LDADD and
9635: BUILDLINK_LIBS?</a>
9636: </dt>
1.106 rillig 9637: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9638: VARNAME=BUILDLINK_PREFIX.foo
9639: say it's empty?</a>
9640: </dt>
1.106 rillig 9641: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9642: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9643: don't understand the := inside
9644: it.</a>
9645: </dt>
1.106 rillig 9646: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9647: developers?</a>
9648: </dt>
1.106 rillig 9649: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9650: documentation?</a>
9651: </dt>
1.106 rillig 9652: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9653: do?</a>
9654: </dt>
1.75 rillig 9655: </dl>
1.148 ! asau 9656: <table border="0" style="width: 100%;">
! 9657: <colgroup>
1.75 rillig 9658: <col align="left" width="1%">
1.128 wiz 9659: <col>
1.148 ! asau 9660: </colgroup>
1.75 rillig 9661: <tbody>
1.148 ! asau 9662: <tr class="question">
1.75 rillig 9663: <td align="left" valign="top">
1.148 ! asau 9664: <a name="devfaq.makeflags"></a><a name="idm11525376"></a><p><b>22.1.</b></p>
1.75 rillig 9665: </td>
9666: <td align="left" valign="top"><p>What is the difference between
9667: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9668: <code class="varname">MAKE_FLAGS</code>?</p></td>
9669: </tr>
9670: <tr class="answer">
1.91 rillig 9671: <td align="left" valign="top"></td>
1.75 rillig 9672: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.136 dholland 9673: 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 9674: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9675: the <code class="varname">MAKE_PROGRAM</code> when building the
9676: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9677: </tr>
1.148 ! asau 9678: <tr class="question">
1.75 rillig 9679: <td align="left" valign="top">
1.148 ! asau 9680: <a name="devfaq.make"></a><a name="idm11523264"></a><p><b>22.2.</b></p>
1.75 rillig 9681: </td>
9682: <td align="left" valign="top"><p>What is the difference between
9683: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9684: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9685: </tr>
9686: <tr class="answer">
1.91 rillig 9687: <td align="left" valign="top"></td>
1.75 rillig 9688: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.136 dholland 9689: <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 9690: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9691: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9692: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9693: Make program that is used for building the
9694: package.</p></td>
9695: </tr>
1.148 ! asau 9696: <tr class="question">
1.75 rillig 9697: <td align="left" valign="top">
1.148 ! asau 9698: <a name="devfaq.cc"></a><a name="idm11520960"></a><p><b>22.3.</b></p>
1.75 rillig 9699: </td>
9700: <td align="left" valign="top"><p>What is the difference between
9701: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9702: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9703: </tr>
9704: <tr class="answer">
1.91 rillig 9705: <td align="left" valign="top"></td>
1.75 rillig 9706: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9707: compiler, which can be configured by the pkgsrc user.
9708: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9709: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9710: path to a compiler, but the type of compiler that should be
1.76 rillig 9711: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9712: information about the latter variable.</p></td>
9713: </tr>
1.148 ! asau 9714: <tr class="question">
1.75 rillig 9715: <td align="left" valign="top">
1.148 ! asau 9716: <a name="devfaq.bl3flags"></a><a name="idm11518848"></a><p><b>22.4.</b></p>
1.75 rillig 9717: </td>
9718: <td align="left" valign="top"><p>What is the difference between
9719: <code class="varname">BUILDLINK_LDFLAGS</code>,
9720: <code class="varname">BUILDLINK_LDADD</code> and
9721: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9722: </tr>
9723: <tr class="answer">
1.91 rillig 9724: <td align="left" valign="top"></td>
1.75 rillig 9725: <td align="left" valign="top"><p>[FIXME]</p></td>
9726: </tr>
1.148 ! asau 9727: <tr class="question">
1.75 rillig 9728: <td align="left" valign="top">
1.148 ! asau 9729: <a name="devfaq.bl3prefix"></a><a name="idm11517696"></a><p><b>22.5.</b></p>
1.75 rillig 9730: </td>
1.110 hubertf 9731: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9732: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9733: say it's empty?</p></td>
9734: </tr>
9735: <tr class="answer">
1.91 rillig 9736: <td align="left" valign="top"></td>
1.75 rillig 9737: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9738: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9739: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9740: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9741: command.</p></td>
9742: </tr>
1.148 ! asau 9743: <tr class="question">
1.78 rillig 9744: <td align="left" valign="top">
1.148 ! asau 9745: <a name="devfaq.master_sites"></a><a name="idm11516160"></a><p><b>22.6.</b></p>
1.78 rillig 9746: </td>
9747: <td align="left" valign="top"><p>What does
9748: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9749: don't understand the <code class="literal">:=</code> inside
9750: it.</p></td>
9751: </tr>
9752: <tr class="answer">
1.91 rillig 9753: <td align="left" valign="top"></td>
1.78 rillig 9754: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9755: assignment operator, like you might expect at first sight.
9756: Instead, it is a degenerate form of
9757: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.136 dholland 9758: 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 9759: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9760: case of <code class="varname">MASTER_SITE_*</code>,
9761: <em class="replaceable"><code>old_string</code></em> is the empty string and
9762: <em class="replaceable"><code>new_string</code></em> is
9763: <code class="literal">package/</code>. That's where the
9764: <code class="literal">:</code> and the <code class="literal">=</code> fall
9765: together.</p></td>
9766: </tr>
1.148 ! asau 9767: <tr class="question">
1.78 rillig 9768: <td align="left" valign="top">
1.148 ! asau 9769: <a name="devfaq.mailinglists"></a><a name="idm11512192"></a><p><b>22.7.</b></p>
1.78 rillig 9770: </td>
9771: <td align="left" valign="top"><p>Which mailing lists are there for package
9772: developers?</p></td>
9773: </tr>
9774: <tr class="answer">
1.91 rillig 9775: <td align="left" valign="top"></td>
1.148 ! asau 9776: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9777: <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 9778: <dd><p>This is a list for technical discussions related
9779: to pkgsrc development, e.g. soliciting feedback for changes to
9780: pkgsrc infrastructure, proposed new features, questions related
9781: to porting pkgsrc to a new platform, advice for maintaining a
9782: package, patches that affect many packages, help requests moved
9783: from pkgsrc-users when an infrastructure bug is found,
9784: etc.</p></dd>
1.110 hubertf 9785: <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 9786: <dd><p>All bug reports in category "pkg" sent with
1.136 dholland 9787: <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 9788: directly; use one of the other mailing
9789: lists.</p></dd>
9790: </dl></div></td>
9791: </tr>
1.148 ! asau 9792: <tr class="question">
1.80 rillig 9793: <td align="left" valign="top">
1.148 ! asau 9794: <a name="devfaq.documentation"></a><a name="idm11510144"></a><p><b>22.8.</b></p>
1.80 rillig 9795: </td>
9796: <td align="left" valign="top"><p>Where is the pkgsrc
9797: documentation?</p></td>
9798: </tr>
9799: <tr class="answer">
1.91 rillig 9800: <td align="left" valign="top"></td>
1.80 rillig 9801: <td align="left" valign="top">
9802: <p>There are many places where you can find
9803: documentation about pkgsrc:</p>
1.148 ! asau 9804: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9805: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9806: of chapters that explain large parts of pkgsrc, but some
9807: chapters tend to be outdated. Which ones they are is hard to
9808: say.</p></li>
1.128 wiz 9809: <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 9810: about certain features, announcements of new parts of the pkgsrc
9811: infrastructure and sometimes even announcements that a certain
9812: feature has been marked as obsolete. The benefit here is that
9813: each message has a date appended to it.</p></li>
1.128 wiz 9814: <li class="listitem"><p>Many of the files in the
1.80 rillig 9815: <code class="filename">mk/</code> directory start with a comment that
9816: describes the purpose of the file and how it can be used by the
1.92 rillig 9817: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9818: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9819: help</strong></span>.</p></li>
1.128 wiz 9820: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9821: information, but they tend to be highly abbreviated, especially
9822: for actions that occur often. Some contain a detailed
9823: description of what has changed, but they are geared towards the
9824: other pkgsrc developers, not towards an average pkgsrc user.
9825: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9826: don't know what has been before, these messages may not be worth
9827: too much to you.</p></li>
1.128 wiz 9828: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9829: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9830: mind of the developer who wrote the code. To get this
1.110 hubertf 9831: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9832: to see who has written it and ask on the
9833: <code class="literal">tech-pkg</code> mailing list, so that others can
9834: find your questions later (see above). To be sure that the
9835: developer in charge reads the mail, you may CC him or
9836: her.</p></li>
9837: </ul></div>
9838: </td>
9839: </tr>
1.148 ! asau 9840: <tr class="question">
1.92 rillig 9841: <td align="left" valign="top">
1.148 ! asau 9842: <a name="devfaq.too-much-time"></a><a name="idm11498688"></a><p><b>22.9.</b></p>
1.92 rillig 9843: </td>
9844: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9845: do?</p></td>
9846: </tr>
9847: <tr class="answer">
9848: <td align="left" valign="top"></td>
9849: <td align="left" valign="top">
1.93 rillig 9850: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9851: anyway.</p>
1.148 ! asau 9852: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9853: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92 rillig 9854: <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
9855: will tell you about newer versions of installed packages that are
9856: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9857: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9858: — it contains a list of suggested new packages and a list of
1.92 rillig 9859: cleanups and enhancements for pkgsrc that would be nice to
9860: have.</p></li>
1.128 wiz 9861: <li class="listitem"><p>Review packages for which review was requested on
1.110 hubertf 9862: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92 rillig 9863: mailing list.</p></li>
9864: </ul></div>
9865: </td>
9866: </tr>
1.75 rillig 9867: </tbody>
9868: </table>
9869: </div>
9870: </div>
1.148 ! asau 9871: <div class="chapter">
1.85 jmmv 9872: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9873: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9874: <div class="toc">
9875: <p><b>Table of Contents</b></p>
9876: <dl>
1.106 rillig 9877: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9878: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9879: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9880: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9881: </dl>
9882: </div>
1.110 hubertf 9883: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9884: site</a>:</p>
9885: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9886: environment, an intuitive and attractive desktop for users, and the
9887: GNOME development platform, an extensive framework for building
9888: applications that integrate into the rest of the desktop.</p></blockquote></div>
9889: <p>pkgsrc provides a seamless way to automatically build and install
9890: a complete GNOME environment <span class="emphasis"><em>under many different
9891: platforms</em></span>. We can say with confidence that pkgsrc is one of
9892: the most advanced build and packaging systems for GNOME due to its
9893: included technologies buildlink3, the wrappers and tools framework and
9894: automatic configuration file management. Lots of efforts are put into
9895: achieving a completely clean deinstallation of installed software
9896: components.</p>
1.110 hubertf 9897: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9898: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9899: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9900: pkgsrc as its preferred packaging system, contributing lots of
9901: portability fixes to make GNOME build and install under it.</p>
9902: <p>This chapter is aimed at pkgsrc developers and other people
9903: interested in helping our GNOME porting and packaging efforts. It
9904: provides instructions on how to manage the existing packages and some
9905: important information regarding their internals.</p>
1.148 ! asau 9906: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9907: <h3 class="title">We need your help!</h3>
9908: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9909: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9910: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9911: work</a> list! There is still a long way to go to get a
9912: fully-functional GNOME desktop under NetBSD and we need your help to
9913: achieve it!</p>
9914: </div>
1.148 ! asau 9915: <div class="sect1">
1.85 jmmv 9916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9917: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9918: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 ! asau 9919: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9920: <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 9921: the core GNOME desktop environment. It only includes the necessary
9922: bits to get it to boot correctly, although it may lack important
9923: functionality for daily operation. The idea behind this package is
9924: to let end users build their own configurations on top of this one,
9925: first installing this meta package to achieve a functional setup and
9926: then adding individual applications.</p></li>
1.128 wiz 9927: <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 9928: complete installation of the GNOME platform and desktop as defined
9929: by the GNOME project; this is based on the components distributed in
9930: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9931: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9932: official FTP server. Developer-only tools found in those
9933: directories are not installed unless required by some other
9934: component to work properly. Similarly, packages from the bindings
9935: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9936: in unless required as a dependency for an end-user component. This
1.91 rillig 9937: 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 9938: <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 9939: Installs all the tools required to build a GNOME component when
9940: fetched from the CVS repository. These are required to let the
1.110 hubertf 9941: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9942: </ul></div>
9943: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9944: sorted in a way that eases updates: a package may depend on other
9945: packages listed before it but not on any listed after it. It is very
9946: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9947: change it to alphabetical sorting!</em></span></p>
9948: </div>
1.148 ! asau 9949: <div class="sect1">
1.85 jmmv 9950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9951: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9952: <p>Almost all GNOME applications are written in C and use a common
9953: set of tools as their build system. Things get different with the new
9954: bindings to other languages (such as Python), but the following will
9955: give you a general idea on the minimum required tools:</p>
1.148 ! asau 9956: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9957: <li class="listitem">
1.85 jmmv 9958: <p>Almost all GNOME applications use the GNU Autotools as their
9959: build system. As a general rule you will need to tell this to your
9960: package:</p>
1.100 rillig 9961: <pre class="programlisting">
9962: GNU_CONFIGURE=yes
1.85 jmmv 9963: USE_LIBTOOL=yes
1.100 rillig 9964: USE_TOOLS+=gmake
9965: </pre>
1.85 jmmv 9966: </li>
1.128 wiz 9967: <li class="listitem">
1.85 jmmv 9968: <p>If the package uses pkg-config to detect dependencies, add this
9969: tool to the list of required utilities:</p>
9970: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9971: <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 9972: the end of the build process to ensure that you did not miss to
9973: specify any dependency in your package and that the version
9974: requirements are all correct.</p>
9975: </li>
1.128 wiz 9976: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9977: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9978: to handle dependencies and to force the package to use the latest
9979: available version.</p></li>
1.128 wiz 9980: <li class="listitem">
1.85 jmmv 9981: <p>If the package uses gtk-doc (a documentation generation
9982: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9983: tool is rather big and the distfile should come with pregenerated
9984: documentation anyway; if it does not, it is a bug that you ought to
9985: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9986: the default):</p>
9987: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9988: <p>The default location of installed HTML files
9989: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9990: and should not be changed unless the package insists on installing
9991: them somewhere else. Otherwise programs as
1.110 hubertf 9992: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9993: do that with an entry similar to:</p>
9994: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9995: </li>
9996: </ul></div>
9997: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9998: files under the installation prefix to maintain databases. In this
9999: context, shared means that those exact same directories and files are
10000: used among several different packages, leading to conflicts in the
10001: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
10002: handle the most common cases, so you have to forget about using
10003: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
10004: omitting shared files from them. If you find yourself doing those,
10005: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
10006: <p>The following table lists the common situations that result in
10007: using shared directories or files. For each of them, the appropriate
10008: solution is given. After applying the solution be sure to
10009: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 10010: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 10011: <div class="table">
1.106 rillig 10012: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 10013: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 10014: <colgroup>
10015: <col>
10016: <col>
10017: </colgroup>
10018: <thead><tr>
10019: <th>If the package...</th>
10020: <th>Then...</th>
10021: </tr></thead>
10022: <tbody>
10023: <tr>
10024: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 10025: <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 10026: </tr>
10027: <tr>
10028: <td>Installs icons under the
10029: <code class="filename">share/icons/hicolor</code> hierarchy or updates
10030: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 10031: <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 10032: </tr>
10033: <tr>
10034: <td>Installs files under
10035: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 10036: <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 10037: </tr>
10038: <tr>
10039: <td>Installs <code class="filename">.desktop</code> files under
10040: <code class="filename">share/applications</code> and these include MIME
10041: information.</td>
1.110 hubertf 10042: <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 10043: </tr>
10044: </tbody>
1.91 rillig 10045: </table></div>
1.85 jmmv 10046: </div>
1.91 rillig 10047: <br class="table-break">
1.85 jmmv 10048: </div>
1.148 ! asau 10049: <div class="sect1">
1.85 jmmv 10050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10051: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 10052: <p>When seeing GNOME as a whole, there are two kinds of
10053: updates:</p>
1.148 ! asau 10054: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 10055: <dt><span class="term">Major update</span></dt>
10056: <dd>
10057: <p>Given that there is still a very long way for GNOME 3 (if it
10058: ever appears), we consider a major update one that goes from a
10059: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10060: where <code class="literal">Y</code> is even and greater than
10061: <code class="literal">X</code>. These are hard to achieve because they
10062: introduce lots of changes in the components' code and almost all
10063: GNOME distfiles are updated to newer versions. Some of them can
10064: even break API and ABI compatibility with the previous major
10065: version series. As a result, the update needs to be done all at
10066: once to minimize breakage.</p>
10067: <p>A major update typically consists of around 80 package
10068: updates and the addition of some new ones.</p>
10069: </dd>
10070: <dt><span class="term">Minor update</span></dt>
10071: <dd>
10072: <p>We consider a minor update one that goes from a
10073: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10074: one where <code class="literal">Y</code> is greater than
10075: <code class="literal">X</code>. These are easy to achieve because they do
10076: not update all GNOME components, can be done in an incremental way
10077: and do not break API nor ABI compatibility.</p>
10078: <p>A minor update typically consists of around 50 package
10079: updates, although the numbers here may vary a lot.</p>
10080: </dd>
10081: </dl></div>
10082: <p>In order to update the GNOME components in pkgsrc to a new stable
10083: release (either major or minor), the following steps should be
10084: followed:</p>
1.128 wiz 10085: <div class="orderedlist"><ol class="orderedlist" type="1">
10086: <li class="listitem">
1.85 jmmv 10087: <p>Get a list of all the tarballs that form the new release by
10088: using the following commands. These will leave the full list of the
1.120 snj 10089: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 10090: file:</p>
1.88 wiz 10091: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10092: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10093: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 10094: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10095: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10096: awk '{ print $9 }' >>list.txt</code></strong></pre>
10097: </li>
1.128 wiz 10098: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 10099: bump their version to the release you are updating them to. The
10100: three meta packages should be always consistent with versioning.
10101: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10102: in them.</p></li>
1.128 wiz 10103: <li class="listitem">
1.85 jmmv 10104: <p>For each meta package, update all its
10105: <code class="varname">DEPENDS</code> lines to match the latest versions as
10106: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10107: newer version (even if found in the FTP) because the meta packages
10108: are supposed to list the exact versions that form a specific GNOME
10109: release. Exceptions are permitted here if a newer version solves a
10110: serious issue in the overall desktop experience; these typically
10111: come in the form of a revision bump in pkgsrc, not in newer versions
10112: from the developers.</p>
10113: <p>Packages not listed in the <code class="filename">list.txt</code> file
10114: should be updated to the latest version available (if found in
10115: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 10116: 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 10117: </li>
1.128 wiz 10118: <li class="listitem">
1.85 jmmv 10119: <p>Generate a patch from the modified meta packages and extract the
10120: list of "new" lines. This will provide you an outline on what
10121: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10122: <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 10123: </li>
1.128 wiz 10124: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 10125: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 10126: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 10127: of <code class="filename">todo.txt</code> and update the packages listed in
10128: it in order. For major desktop updates none of these should be
1.93 rillig 10129: committed until the entire set is completed because there are chances
1.85 jmmv 10130: of breaking not-yet-updated packages.</p></li>
1.128 wiz 10131: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 10132: the tree one by one with appropriate log messages. At the end,
10133: commit the three meta package updates and all the corresponding
10134: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10135: <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>
10136: </ol></div>
10137: </div>
1.148 ! asau 10138: <div class="sect1">
1.85 jmmv 10139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10140: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10141: <p>GNOME is a very big component in pkgsrc which approaches 100
10142: packages. Please, it is very important that you always, always,
10143: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10144: 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 10145: their attention on portability issues and to ensure that future versions
10146: can be built out-of-the box on NetBSD. The less custom patches in
10147: pkgsrc, the easier further updates are. Those developers in charge of
10148: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10149: <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 10150: Bugzilla</a>. Not all components use these to track bugs, but most
10151: of them do. Do not be short on your reports: always provide detailed
10152: explanations of the current failure, how it can be improved to achieve
10153: maximum portability and, if at all possible, provide a patch against CVS
10154: head. The more verbose you are, the higher chances of your patch being
10155: accepted.</p>
10156: <p>Also, please avoid using preprocessor magic to fix portability
10157: issues. While the FreeBSD GNOME people are doing a great job in porting
10158: GNOME to their operating system, the official GNOME sources are now
10159: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10160: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10161: 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 10162: details.</p>
10163: </div>
10164: </div>
1.75 rillig 10165: </div>
1.148 ! asau 10166: <div class="part">
1.75 rillig 10167: <div class="titlepage"><div><div><h1 class="title">
10168: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 ! asau 10169: <div class="partintro">
1.75 rillig 10170: <div></div>
10171: <p>This part of the guide deals with everything
10172: from the infrastructure that is behind the interfaces described
10173: in the developer's guide. A casual package maintainer should not
10174: need anything from this part.</p>
10175: <div class="toc">
10176: <p><b>Table of Contents</b></p>
10177: <dl>
1.106 rillig 10178: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10179: <dd><dl>
1.106 rillig 10180: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10181: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10182: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10183: <dd><dl>
1.106 rillig 10184: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10185: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10186: </dl></dd>
1.106 rillig 10187: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10188: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10189: <dd><dl>
1.106 rillig 10190: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10191: <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 10192: </dl></dd>
1.106 rillig 10193: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10194: <dd><dl>
1.128 wiz 10195: <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>
10196: <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 10197: </dl></dd>
10198: </dl></dd>
1.106 rillig 10199: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10200: <dd><dl>
1.106 rillig 10201: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10202: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10203: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10204: <dd><dl>
1.106 rillig 10205: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10206: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10207: </dl></dd>
10208: </dl></dd>
1.106 rillig 10209: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10210: <dd><dl>
1.106 rillig 10211: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10212: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10213: </dl></dd>
10214: </dl>
10215: </div>
10216: </div>
1.148 ! asau 10217: <div class="chapter">
1.75 rillig 10218: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10219: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10220: <div class="toc">
10221: <p><b>Table of Contents</b></p>
10222: <dl>
1.106 rillig 10223: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10224: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10225: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10226: <dd><dl>
1.106 rillig 10227: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10228: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10229: </dl></dd>
1.106 rillig 10230: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10231: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10232: <dd><dl>
1.106 rillig 10233: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10234: <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 10235: </dl></dd>
1.106 rillig 10236: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10237: <dd><dl>
1.128 wiz 10238: <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>
10239: <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 10240: </dl></dd>
10241: </dl>
10242: </div>
10243: <p>The pkgsrc infrastructure consists of many small Makefile
10244: fragments. Each such fragment needs a properly specified
10245: interface. This chapter explains how such an interface looks
10246: like.</p>
1.148 ! asau 10247: <div class="sect1">
1.75 rillig 10248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10249: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10250: <p>Whenever a variable is defined in the pkgsrc
10251: infrastructure, the location and the way of definition provide
10252: much information about the intended use of that variable.
10253: Additionally, more documentation may be found in a header
10254: comment or in this pkgsrc guide.</p>
10255: <p>A special file is
10256: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10257: variables that are intended to be user-defined. They are either
10258: defined using the <code class="literal">?=</code> operator or they are
10259: left undefined because defining them to anything would
1.128 wiz 10260: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10261: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10262: file.</p>
10263: <p>Outside this file, the following conventions apply:
10264: Variables that are defined using the <code class="literal">?=</code>
10265: operator may be overridden by a package.</p>
10266: <p>Variables that are defined using the <code class="literal">=</code>
10267: operator may be used read-only at run-time.</p>
10268: <p>Variables whose name starts with an underscore must not be
10269: accessed outside the pkgsrc infrastructure at all. They may
10270: change without further notice.</p>
1.148 ! asau 10271: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10272: <h3 class="title">Note</h3>
10273: <p>These conventions are currently not applied
10274: consistently to the complete pkgsrc
10275: infrastructure.</p>
10276: </div>
10277: </div>
1.148 ! asau 10278: <div class="sect1">
1.81 rillig 10279: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10280: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10281: <p>All variables that contain lists of things should default
10282: to being empty. Two examples that do not follow this rule are
10283: <code class="varname">USE_LANGUAGES</code> and
10284: <code class="varname">DISTFILES</code>. These variables cannot simply be
10285: modified using the <code class="literal">+=</code> operator in package
10286: <code class="filename">Makefile</code>s (or other files included by
10287: them), since there is no guarantee whether the variable is
10288: already set or not, and what its value is. In the case of
1.128 wiz 10289: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10290: the default value and just define it as in the following
10291: example.</p>
10292: <pre class="programlisting">
1.100 rillig 10293: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10294: </pre>
10295: <p>Because of the selection of this default value, the same
10296: value appears in many package Makefiles. Similarly for
10297: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10298: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10299: doesn't stand out. Nevertheless it is mentioned in many
10300: files.</p>
10301: </div>
1.148 ! asau 10302: <div class="sect1">
1.81 rillig 10303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10304: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148 ! asau 10305: <div class="sect2">
1.75 rillig 10306: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10307: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10308: <p>Variable evaluation takes place either at load time or at
10309: runtime, depending on the context in which they occur. The
10310: contexts where variables are evaluated at load time are:</p>
1.148 ! asau 10311: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10312: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10313: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10314: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10315: <code class="literal">.for</code>,</p></li>
1.128 wiz 10316: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10317: </ul></div>
10318: <p>A special exception are references to the iteration
10319: variables of <code class="literal">.for</code> loops, which are expanded
10320: inline, no matter in which context they appear.</p>
10321: <p>As the values of variables may change during load time,
10322: care must be taken not to evaluate them by accident. Typical
10323: examples for variables that should not be evaluated at load time
10324: are <code class="varname">DEPENDS</code> and
10325: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10326: clear, here is an example:</p>
10327: <pre class="programlisting">
1.100 rillig 10328: CONFIGURE_ARGS= # none
10329: CFLAGS= -O
10330: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10331:
1.100 rillig 10332: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10333:
1.100 rillig 10334: CFLAGS+= -Wall
1.75 rillig 10335: </pre>
10336: <p>This code shows how the use of the <code class="literal">:=</code>
10337: operator can quickly lead to unexpected results. The first
10338: paragraph is fairly common code. The second paragraph evaluates
10339: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10340: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10341: <code class="literal">-Wall</code> is appended to the
10342: <code class="varname">CFLAGS</code>, but this addition will not appear in
10343: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10344: paragraphs from above typically occur in completely unrelated
10345: files.</p>
10346: </div>
1.148 ! asau 10347: <div class="sect2">
1.75 rillig 10348: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10349: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10350: <p>After all the files have been loaded, the values of the
10351: variables cannot be changed anymore. Variables that are used in
10352: the shell commands are expanded at this point.</p>
10353: </div>
10354: </div>
1.148 ! asau 10355: <div class="sect1">
1.75 rillig 10356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10357: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10358: <p>There are many ways in which the definition and use of a
10359: variable can be restricted in order to detect bugs and
10360: violations of the (mostly unwritten) policies. See the
10361: <code class="literal">pkglint</code> developer's documentation for further
10362: details.</p>
10363: </div>
1.148 ! asau 10364: <div class="sect1">
1.78 rillig 10365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10366: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10367: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10368: of the following classes. Cases where a file falls into more
10369: than one class should be avoided as it often leads to subtle
10370: bugs.</p>
1.148 ! asau 10371: <div class="sect2">
1.75 rillig 10372: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10373: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10374: <p>In a traditional imperative programming language some of
1.76 rillig 10375: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10376: procedures. They take some input parameters and—after
10377: inclusion—provide a result in output parameters. Since all
1.76 rillig 10378: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10379: care must be taken not to use parameter names that have already
10380: another meaning. For example, <code class="varname">PKGNAME</code> is a
10381: bad choice for a parameter name.</p>
10382: <p>Procedures are completely evaluated at preprocessing time.
10383: That is, when calling a procedure all input parameters must be
10384: completely resolvable. For example,
10385: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10386: parameter since it is very likely that further text will be
10387: added after calling the procedure, which would effectively apply
10388: the procedure to only a part of the variable. Also, references
10389: to other variables wit will be modified after calling the
10390: procedure.</p>
10391: <p>A procedure can declare its output parameters either as
10392: suitable for use in preprocessing directives or as only
10393: available at runtime. The latter alternative is for variables
10394: that contain references to other runtime variables.</p>
10395: <p>Procedures shall be written such that it is possible to
10396: call the procedure more than once. That is, the file must not
10397: contain multiple-inclusion guards.</p>
10398: <p>Examples for procedures are
1.76 rillig 10399: <code class="filename">mk/bsd.options.mk</code> and
10400: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10401: that the parameters are evaluated at load time, they should be
10402: assigned using the <code class="literal">:=</code> operator, which should
10403: be used only for this purpose.</p>
10404: </div>
1.148 ! asau 10405: <div class="sect2">
1.75 rillig 10406: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10407: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10408: <p>Action files take some input parameters and may define
10409: runtime variables. They shall not define loadtime variables.
10410: There are action files that are included implicitly by the
10411: pkgsrc infrastructure, while other must be included
10412: explicitly.</p>
10413: <p>An example for action files is
1.76 rillig 10414: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10415: </div>
10416: </div>
1.148 ! asau 10417: <div class="sect1">
1.81 rillig 10418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10419: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10420: <p>Package <code class="filename">Makefile</code>s usually consist of
10421: a set of variable definitions, and include the file
10422: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10423: Before that, they may also include various other
10424: <code class="filename">*.mk</code> files if they need to query the
10425: availability of certain features like the type of compiler or
10426: the X11 implementation. Due to the heavy use of preprocessor
10427: directives like <code class="literal">.if</code> and
10428: <code class="literal">.for</code>, the order in which the files are loaded
10429: matters.</p>
10430: <p>This section describes at which point the various files
10431: are loaded and gives reasons for that order.</p>
1.148 ! asau 10432: <div class="sect2">
1.81 rillig 10433: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10434: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10435: </h3></div></div></div>
10436: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10437: is to define some essential variables like
10438: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10439: <code class="varname">MACHINE_ARCH</code>.</p>
10440: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10441: 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 10442: After that, those variables
1.81 rillig 10443: that have not been overridden by the user are loaded from
10444: <code class="filename">mk/defaults/mk.conf</code>.</p>
10445: <p>After the user settings, the system settings and platform
10446: settings are loaded, which may override the user
10447: settings.</p>
10448: <p>Then, the tool definitions are loaded. The tool wrappers
10449: are not yet in effect. This only happens when building a
10450: package, so the proper variables must be used instead of the
10451: direct tool names.</p>
10452: <p>As the last steps, some essential variables from the
10453: wrapper and the package system flavor are loaded, as well as the
10454: variables that have been cached in earlier phases of a package
10455: build.</p>
10456: </div>
1.148 ! asau 10457: <div class="sect2">
1.81 rillig 10458: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10459: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10460: </h3></div></div></div>
1.81 rillig 10461: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10462: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10463: loaded, which fill default values for those variables that have
1.93 rillig 10464: not been defined by the package. These variables may later
1.81 rillig 10465: be used even in unrelated files.</p>
10466: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10467: provides the target <code class="literal">error-check</code> that is added
10468: as a special dependency to all other targets that use
10469: <code class="varname">DELAYED_ERROR_MSG</code> or
10470: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10471: <p>Then, the package-specific hacks from
10472: <code class="filename">hacks.mk</code> are included.</p>
10473: <p>Then, various other files follow. Most of them don't have
10474: any dependencies on what they need to have included before or
10475: after them, though some do.</p>
10476: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10477: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10478: restricts the use of these variables to all the files that have
10479: been included before. Appearances in later files will be
10480: silently ignored.</p>
10481: <p>Then, the files for the main targets are included, in the
10482: order of later execution, though the actual order should not
10483: matter.</p>
10484: <p>At last, some more files are included that don't set any
10485: interesting variables but rather just define make targets to be
10486: executed.</p>
10487: </div>
10488: </div>
1.75 rillig 10489: </div>
1.148 ! asau 10490: <div class="chapter">
1.75 rillig 10491: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10492: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10493: <div class="toc">
10494: <p><b>Table of Contents</b></p>
10495: <dl>
1.106 rillig 10496: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10497: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10498: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10499: <dd><dl>
1.106 rillig 10500: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10501: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10502: </dl></dd>
10503: </dl>
10504: </div>
10505: <p>The pkgsrc infrastructure consists of a large codebase,
10506: and there are many corners where every little bit of a file is
10507: well thought out, making pkgsrc likely to fail as soon as
10508: anything is changed near those parts. To prevent most changes
10509: from breaking anything, a suite of regression tests should go
10510: along with every important part of the pkgsrc infrastructure.
10511: This chapter describes how regression tests work in pkgsrc and
10512: how you can add new tests.</p>
1.148 ! asau 10513: <div class="sect1">
1.75 rillig 10514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10515: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10516: <p></p>
10517: </div>
1.148 ! asau 10518: <div class="sect1">
1.75 rillig 10519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10520: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10521: <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 10522: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10523: can simply run that command, which will run all tests in the
1.76 rillig 10524: <code class="filename">regress</code> category.</p>
1.75 rillig 10525: </div>
1.148 ! asau 10526: <div class="sect1">
1.75 rillig 10527: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10528: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10529: <p>Every directory in the <code class="filename">regress</code>
10530: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10531: is considered a regression test. This file is a shell program
1.110 hubertf 10532: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10533: The following functions can be overridden to suit your
10534: needs.</p>
1.148 ! asau 10535: <div class="sect2">
1.75 rillig 10536: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10537: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10538: <p>These functions do not take any parameters. They are all
1.128 wiz 10539: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10540: to check the exitcodes of any commands you run in the
10541: test.</p>
1.148 ! asau 10542: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10543: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10544: <dd><p>This function prepares the environment for the
10545: test. By default it does nothing.</p></dd>
10546: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10547: <dd><p>This function runs the actual test. By default,
10548: it calls <code class="varname">TEST_MAKE</code> with the arguments
10549: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10550: error messages into the file
10551: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10552: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10553: <dd><p>This function is run after the test and is
10554: typically used to compare the actual output from the one that is
10555: expected. It can make use of the various helper functions from
10556: the next section.</p></dd>
10557: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10558: <dd><p>This function cleans everything up after the
10559: test has been run. By default it does nothing.</p></dd>
10560: </dl></div>
10561: </div>
1.148 ! asau 10562: <div class="sect2">
1.75 rillig 10563: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10564: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148 ! asau 10565: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10566: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10567: <dd><p>This function compares the exitcode of the
1.110 hubertf 10568: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10569: If they differ, the test will fail.</p></dd>
10570: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10571: <dd><p>This function checks for each of its parameters
1.110 hubertf 10572: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10573: extended regular expression. If it does not, the test will
10574: fail.</p></dd>
10575: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10576: <dd><p>This function checks for each of its parameters
1.110 hubertf 10577: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10578: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10579: If any of the regular expressions matches, the test will
10580: fail.</p></dd>
10581: </dl></div>
10582: </div>
10583: </div>
10584: </div>
1.148 ! asau 10585: <div class="chapter">
1.75 rillig 10586: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10587: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10588: <div class="toc">
10589: <p><b>Table of Contents</b></p>
10590: <dl>
1.106 rillig 10591: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10592: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10593: </dl>
10594: </div>
10595: <p>The pkgsrc system has already been ported to many
10596: operating systems, hardware architectures and compilers. This
10597: chapter explains the necessary steps to make pkgsrc even more
10598: portable.</p>
1.148 ! asau 10599: <div class="sect1">
1.75 rillig 10600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10601: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10602: <p>To port pkgsrc to a new operating system (called
10603: <code class="literal">MyOS</code> in this example), you need to touch the
10604: following files:</p>
1.148 ! asau 10605: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10606: <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 10607: <dd><p>This file contains some basic definitions, for
10608: example the name of the C
10609: compiler.</p></dd>
1.76 rillig 10610: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10611: <dd><p>Insert code that defines the variables
10612: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10613: <code class="varname">LOWER_OS_VERSION</code>,
10614: <code class="varname">LOWER_VENDOR</code>,
10615: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10616: <code class="varname">APPEND_ELF</code>, and the other variables that
10617: appear in this file.</p></dd>
1.93 rillig 10618: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10619: <dd><p>This file contains the platform-specific
10620: definitions that are used by pkgsrc. Start by copying one of the
10621: other files and edit it to your
10622: needs.</p></dd>
1.93 rillig 10623: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10624: <dd><p>This file contains a list of directories,
10625: together with their permission bits and ownership. These
10626: directories will be created automatically with every package
1.98 wiz 10627: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10628: be removed.</p></dd>
1.93 rillig 10629: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10630: <dd><p>Just copy one of the pre-existing x11.dist files
10631: to your
1.76 rillig 10632: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10633: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10634: <dd><p>On some operating systems, the tools that are
10635: provided with the base system are not good enough for pkgsrc.
1.136 dholland 10636: 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 10637: narrow limit on the line length they can process. Therefore
10638: pkgsrc brings its own tools, which can be enabled
10639: here.</p></dd>
1.93 rillig 10640: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10641: <dd><p>This file defines the paths to all the tools
10642: that are needed by one or the other package in pkgsrc, as well
10643: as by pkgsrc itself. Find out where these tools are on your
10644: platform and add them.</p></dd>
10645: </dl></div>
10646: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10647: <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 10648: </div>
1.148 ! asau 10649: <div class="sect1">
1.75 rillig 10650: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10651: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10652: <p>TODO</p>
10653: </div>
10654: </div>
10655: </div>
1.148 ! asau 10656: <div class="appendix">
! 10657: <div class="titlepage"><div><div><h1 class="title">
! 10658: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10659: <div class="toc">
10660: <p><b>Table of Contents</b></p>
10661: <dl>
10662: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10663: <dd><dl>
10664: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10665: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10666: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10667: <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 10668: </dl></dd>
10669: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10670: </dl>
10671: </div>
10672: <p>We checked to find a piece of software that wasn't in the packages
10673: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10674: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10675: present in the tree is beyond us, but it's useful for the purposes of
10676: this exercise.</p>
1.148 ! asau 10677: <div class="sect1">
1.75 rillig 10678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10679: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 ! asau 10680: <div class="sect2">
1.75 rillig 10681: <div class="titlepage"><div><div><h3 class="title">
10682: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10683: <pre class="programlisting">
1.100 rillig 10684: # $NetBSD$
10685: #
1.1 grant 10686:
1.100 rillig 10687: DISTNAME= bison-1.25
10688: CATEGORIES= devel
10689: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10690:
1.136 dholland 10691: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 10692: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10693: COMMENT= GNU yacc clone
1.1 grant 10694:
1.100 rillig 10695: GNU_CONFIGURE= yes
10696: INFO_FILES= bison.info
1.1 grant 10697:
1.100 rillig 10698: .include "../../mk/bsd.pkg.mk"
1.1 grant 10699: </pre>
1.75 rillig 10700: </div>
1.148 ! asau 10701: <div class="sect2">
1.75 rillig 10702: <div class="titlepage"><div><div><h3 class="title">
10703: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10704: <pre class="programlisting">
1.100 rillig 10705: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.136 dholland 10706: 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 10707: of the NetBSD source tree is beyond me.
1.1 grant 10708: </pre>
1.75 rillig 10709: </div>
1.148 ! asau 10710: <div class="sect2">
1.75 rillig 10711: <div class="titlepage"><div><div><h3 class="title">
10712: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10713: <pre class="programlisting">
1.100 rillig 10714: @comment $NetBSD$
10715: bin/bison
10716: man/man1/bison.1.gz
10717: share/bison.simple
10718: share/bison.hairy
1.1 grant 10719: </pre>
1.75 rillig 10720: </div>
1.148 ! asau 10721: <div class="sect2">
1.75 rillig 10722: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10723: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10724: </h3></div></div></div>
1.75 rillig 10725: <p>The NetBSD package system comes with
1.91 rillig 10726: <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 10727: which helps to check the contents of these
10728: files. After installation it is quite easy to use, just change to the
10729: directory of the package you wish to examine and execute
1.110 hubertf 10730: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10731: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10732: looks fine.</pre>
10733: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10734: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10735: -Wall</strong></span> for a very thorough check.</p>
10736: </div>
10737: </div>
1.148 ! asau 10738: <div class="sect1">
1.75 rillig 10739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10740: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10741: <p>Create the directory where the package lives,
10742: plus any auxiliary directories:</p>
10743: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10744: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10745: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10746: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10747: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10748: <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 10749: then continue with fetching the distfile:</p>
10750: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10751: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10752: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10753: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10754: ftp: Error retrieving file: 500 Internal error
10755:
10756: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10757: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10758: ftp: Error retrieving file: 500 Internal error
10759:
10760: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10761: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10762: Successfully retrieved file.</pre>
10763: <p>Generate the checksum of the distfile into
1.76 rillig 10764: <code class="filename">distinfo</code>:</p>
1.88 wiz 10765: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10766: <p>Now compile:</p>
10767: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10768: >> Checksum OK for bison-1.25.tar.gz.
10769: ===> Extracting for bison-1.25
10770: ===> Patching for bison-1.25
10771: ===> Ignoring empty patch directory
10772: ===> Configuring for bison-1.25
10773: creating cache ./config.cache
10774: checking for gcc... cc
10775: checking whether we are using GNU C... yes
10776: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10777: checking how to run the C preprocessor... cc -E
10778: checking for minix/config.h... no
10779: checking for POSIXized ISC... no
10780: checking whether cross-compiling... no
10781: checking for ANSI C header files... yes
10782: checking for string.h... yes
10783: checking for stdlib.h... yes
10784: checking for memory.h... yes
10785: checking for working const... yes
10786: checking for working alloca.h... no
10787: checking for alloca... yes
10788: checking for strerror... yes
10789: updating cache ./config.cache
10790: creating ./config.status
10791: creating Makefile
10792: ===> Building for bison-1.25
10793: 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
10794: 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
10795: 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
10796: 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
10797: 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 10798: 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 10799: 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
10800: 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
10801: 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
10802: 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
10803: 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
10804: 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
10805: 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
10806: 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
10807: 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
10808: 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
10809: 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
10810: 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
10811: 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
10812: 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
10813: 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
10814: 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
10815: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10816: rm -f bison.s1
1.75 rillig 10817: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10818: <p>Everything seems OK, so install the files:</p>
10819: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10820: >> Checksum OK for bison-1.25.tar.gz.
10821: ===> Installing for bison-1.25
10822: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10823: rm -f /usr/pkg/bin/bison
10824: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10825: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10826: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10827: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10828: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10829: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10830: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10831: ===> Registering installation for bison-1.25</pre>
10832: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10833: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10834: binary package, do this now:</p>
10835: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10836: >> Checksum OK for bison-1.25.tar.gz.
10837: ===> Building package for bison-1.25
10838: Creating package bison-1.25.tgz
10839: Registering depends:.
1.75 rillig 10840: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10841: <p>Now that you don't need the source and object files
10842: any more, clean up:</p>
10843: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10844: ===> Cleaning for bison-1.25</pre>
10845: </div>
10846: </div>
1.148 ! asau 10847: <div class="appendix">
! 10848: <div class="titlepage"><div><div><h1 class="title">
! 10849: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10850: <div class="toc">
10851: <p><b>Table of Contents</b></p>
10852: <dl>
10853: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10854: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10855: </dl>
10856: </div>
1.148 ! asau 10857: <div class="sect1">
1.75 rillig 10858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10859: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10860: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10861: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10862: => figlet221.tar.gz doesn't seem to exist on this system.
10863: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10864: => [172219 bytes]
10865: Connected to ftp.plig.net.
10866: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10867: 331 Guest login ok, send your complete e-mail address as password.
10868: 230-You are user #5 of 500 simultaneous users allowed.
10869: 230-
1.68 rillig 10870: 230- ___ _ _ _
10871: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10872: 230- | _| _| . |_| . | | | . |_| . | _| . |
10873: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10874: 230- |_| |_| |___| |___|
10875: 230-
10876: 230-** Welcome to ftp.plig.org **
10877: 230-
10878: 230-Please note that all transfers from this FTP site are logged. If you
10879: 230-do not like this, please disconnect now.
10880: 230-
1.120 snj 10881: 230-This archive is available via
1.1 grant 10882: 230-
10883: 230-HTTP: http://ftp.plig.org/
10884: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10885: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10886: 230-
10887: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10888: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10889: 230-
10890: 230-
10891: 230 Logged in anonymously.
10892: Remote system type is UNIX.
10893: Using binary mode to transfer files.
10894: 200 Type okay.
10895: 250 "/pub" is new cwd.
10896: 250-"/pub/figlet" is new cwd.
10897: 250-
10898: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10899: 250-
1.75 rillig 10900: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10901: 250-
10902: 250-The official FIGlet web page is:
1.75 rillig 10903: 250- http://www.figlet.org/
1.1 grant 10904: 250-
10905: 250-If you have questions, please mailto:info@figlet.org. If you want to
10906: 250-contribute a font or something else, you can email us.
1.68 rillig 10907: 250
1.1 grant 10908: 250 "/pub/figlet/program" is new cwd.
10909: 250 "/pub/figlet/program/unix" is new cwd.
10910: local: figlet221.tar.gz remote: figlet221.tar.gz
10911: 502 Unimplemented command.
10912: 227 Entering Passive Mode (195,40,6,41,246,104)
10913: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10914: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10915: 226 Transfer completed.
10916: 172219 bytes received in 00:02 (75.99 KB/s)
10917: 221 Goodbye.
10918: => Checksum OK for figlet221.tar.gz.
10919: ===> Extracting for figlet-2.2.1nb2
10920: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10921: ===> Patching for figlet-2.2.1nb2
10922: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10923: ===> Overriding tools for figlet-2.2.1nb2
10924: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10925: ===> Configuring for figlet-2.2.1nb2
10926: ===> Building for figlet-2.2.1nb2
10927: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10928: chmod a+x figlet
10929: gcc -O2 -o chkfont chkfont.c
10930: => Unwrapping files-to-be-installed.
1.14 xtraeme 10931: <code class="prompt">#</code>
1.75 rillig 10932: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10933: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10934: ===> Installing for figlet-2.2.1nb2
10935: install -d -o root -g wheel -m 755 /usr/pkg/bin
10936: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10937: mkdir -p /usr/pkg/share/figlet
10938: cp figlet /usr/pkg/bin
10939: cp chkfont /usr/pkg/bin
10940: chmod 555 figlist showfigfonts
10941: cp figlist /usr/pkg/bin
10942: cp showfigfonts /usr/pkg/bin
10943: cp fonts/*.flf /usr/pkg/share/figlet
10944: cp fonts/*.flc /usr/pkg/share/figlet
10945: cp figlet.6 /usr/pkg/man/man6
10946: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10947: <code class="prompt">#</code></pre>
10948: </div>
1.148 ! asau 10949: <div class="sect1">
1.75 rillig 10950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10951: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10952: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10953: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10954: ===> Packaging figlet-2.2.1nb2
10955: ===> Building binary package for figlet-2.2.1nb2
10956: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10957: Using SrcDir value of /usr/pkg
1.68 rillig 10958: Registering depends:.
1.75 rillig 10959: <code class="prompt">#</code></pre>
10960: </div>
10961: </div>
1.148 ! asau 10962: <div class="appendix">
! 10963: <div class="titlepage"><div><div><h1 class="title">
! 10964: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10965: <div class="toc">
10966: <p><b>Table of Contents</b></p>
10967: <dl>
1.128 wiz 10968: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10969: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10970: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10971: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10972: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10973: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10974: source packages</a></span></dt>
10975: </dl>
10976: </div>
10977: <p>As in other big projects, the directory layout of pkgsrc
10978: is quite complex for newbies. This chapter explains where you
10979: find things on the FTP server. The base directory on
1.110 hubertf 10980: <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 10981: On other servers it may be different, but inside this directory,
10982: everything should look the same, no matter on which server you
10983: are. This directory contains some subdirectories, which are
10984: explained below.</p>
1.148 ! asau 10985: <div class="sect1">
1.76 rillig 10986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10987: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10988: <p>The directory <code class="filename">distfiles</code> contains lots
10989: of archive files from all pkgsrc packages, which are mirrored
10990: here. The subdirectories are called after their package names
10991: and are used when the distributed files have names that don't
10992: explicitly contain a version number or are otherwise too generic
10993: (for example <code class="filename">release.tar.gz</code>).</p>
10994: </div>
1.148 ! asau 10995: <div class="sect1">
1.76 rillig 10996: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10997: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10998: <p>This directory contains things that individual pkgsrc
10999: developers find worth publishing.</p>
11000: </div>
1.148 ! asau 11001: <div class="sect1">
1.76 rillig 11002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11003: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 11004: <p>This directory contains binary packages for the various
11005: platforms that are supported by pkgsrc.
11006: 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 11007: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 11008: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 11009: operating system for which the packages have been built. The
1.110 hubertf 11010: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 11011: command, so it may differ from the one you are used to
11012: hear.</p></li>
1.128 wiz 11013: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 11014: architecture of the platform for which the packages have been
1.110 hubertf 11015: built. It also includes the <code class="varname">ABI</code> (Application
11016: Binary Interface) for platforms that have several of
11017: them.</p></li>
1.128 wiz 11018: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 11019: the operating system. For version numbers that change often (for
11020: example NetBSD-current), the often-changing part should be
11021: replaced with an <code class="literal">x</code>, for example
11022: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 11023: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 11024: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 11025: for a stable branch, or <code class="literal">head</code> for packages
11026: built from the HEAD branch. The latter should only be used when
11027: the packages are updated on a regular basis. Otherwise the date
11028: from checking out pkgsrc should be appended, for example
11029: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 11030: </ul></div>
11031: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11032: can quickly click through the directories on the
11033: server and find the best binary packages for their machines. Since they
11034: usually know the operating system and the hardware architecture, OPSYS
11035: and ARCH are placed first. After these choices, they can select the
11036: best combination of OSVERSION and TAG together, since it is usually the
11037: case that packages stay compatible between different version of the
11038: operating system.</p>
11039: <p>In each of these directories, there is a
11040: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 11041: <code class="filename">All</code> which contains all binary packages.
11042: Besides that, there are various category directories that
11043: contain symbolic links to the real binary packages.</p>
11044: </div>
1.148 ! asau 11045: <div class="sect1">
1.76 rillig 11046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11047: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11048: <p>Here are the reports from bulk builds, for those who want
11049: to fix packages that didn't build on some of the platforms. The
1.128 wiz 11050: 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 11051: </div>
1.148 ! asau 11052: <div class="sect1">
1.108 rillig 11053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11054: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
11055: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11056: source packages</h2></div></div></div>
1.128 wiz 11057: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11058: that is the files that define how to create binary packages from
11059: source archives.</p>
11060: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11061: snapshot of the CVS repository, which is updated regularly. The
11062: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11063: directory, ready to be downloaded as a whole.</p>
1.76 rillig 11064: <p>In the directories for the quarterly branches, there is an
11065: additional file called
1.126 jakllsch 11066: <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 11067: which contains the state of pkgsrc when it was branched.</p>
11068: </div>
1.75 rillig 11069: </div>
1.148 ! asau 11070: <div class="appendix">
! 11071: <div class="titlepage"><div><div><h1 class="title">
! 11072: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 11073: <div class="toc">
11074: <p><b>Table of Contents</b></p>
11075: <dl>
1.79 rillig 11076: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 11077: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11078: </dl>
11079: </div>
1.79 rillig 11080: <p>This section contains information on editing the pkgsrc
11081: guide itself.</p>
1.148 ! asau 11082: <div class="sect1">
1.75 rillig 11083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 11084: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11085: <p>The pkgsrc guide's source code is stored in
11086: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11087: are created from it:</p>
1.148 ! asau 11088: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 11089: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11090: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
11091: <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>
11092: <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 11093: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 11094: <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 11095: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 11096: </ul></div>
11097: </div>
1.148 ! asau 11098: <div class="sect1">
1.75 rillig 11099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11100: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 11101: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 11102: <div class="procedure"><ol class="procedure" type="1">
1.148 ! asau 11103: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 11104: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 11105: documentation) installed. These are <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc</code></a> for creating the
11106: ASCII and HTML versions, and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc-print/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc-print</code></a> for the
1.79 rillig 11107: PostScript and PDF versions. You will need both packages
11108: installed, to make sure documentation is consistent across all
11109: formats.</p></li>
1.148 ! asau 11110: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 11111: right directory. All further steps will take place
11112: here.</p></li>
1.148 ! asau 11113: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 11114: <code class="filename">files/</code>.</p></li>
1.148 ! asau 11115: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 11116: guide for valid XML and to build the final output files. If you
11117: get any errors at this stage, you can just edit the files, as
11118: there are only symbolic links in the working directory, pointing
11119: to the files in <code class="filename">files/</code>.</p></li>
1.148 ! asau 11120: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 11121: commit)</strong></span></p></li>
1.148 ! asau 11122: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 11123: regenerate the output files with the proper RCS
11124: Ids.</p></li>
1.148 ! asau 11125: <li class="step">
1.110 hubertf 11126: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 11127: commit the files in both <code class="filename">pkgsrc/doc</code> and
11128: <code class="filename">htdocs</code>.</p>
1.148 ! asau 11129: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 11130: <h3 class="title">Note</h3>
11131: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 11132: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11133: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 11134: directory.</p>
11135: </div>
11136: </li>
1.79 rillig 11137: </ol></div>
1.75 rillig 11138: </div>
11139: </div>
11140: </div></body>
1.1 grant 11141: </html>
CVSweb <webmaster@jp.NetBSD.org>