Annotation of pkgsrc/doc/pkgsrc.html, revision 1.129
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.101 rillig 6: <link rel="stylesheet" href="/global.css" type="text/css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
1.128 wiz 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="The pkgsrc guide">
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.128 wiz 35: <div><div class="abstract" title="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.128 wiz 247: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 248: </dl></dd>
1.128 wiz 249: <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 250: <dd><dl>
1.128 wiz 251: <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 252: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
253: </dl></dd>
254: </dl></dd>
255: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
256: <dd><dl>
257: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
258: <dd><dl>
259: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
260: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
261: </dl></dd>
262: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
263: <dd><dl>
1.128 wiz 264: <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 265: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
266: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
267: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
268: </dl></dd>
269: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
270: <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>
271: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
272: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
273: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
274: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
275: <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>
276: </dl></dd>
277: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
278: <dd><dl>
279: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 280: <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 281: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 282: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 283: </dl></dd>
284: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
285: <dd><dl>
286: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
287: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
288: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
289: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 290: <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 291: <dd><dl>
292: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
293: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
294: </dl></dd>
1.128 wiz 295: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
299: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
300: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
301: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
302: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
303: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
304: <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 305: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
306: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
307: </dl></dd>
308: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
309: <dd><dl>
310: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
311: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
312: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
313: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
314: </dl></dd>
315: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
316: <dd><dl>
317: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
318: <dd><dl>
319: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 320: <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 321: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
322: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
323: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
324: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
325: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
326: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
327: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
328: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
329: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
330: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
331: </dl></dd>
1.128 wiz 332: <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 333: <dd><dl>
334: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
335: <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>
336: </dl></dd>
1.128 wiz 337: <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 338: <dd><dl>
339: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
340: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
341: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
342: </dl></dd>
343: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
344: <dd><dl>
345: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
346: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
347: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
348: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
349: </dl></dd>
1.128 wiz 350: <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 351: <dd><dl>
352: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
353: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 354: <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 355: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
356: </dl></dd>
1.128 wiz 357: <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 358: <dd><dl>
359: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
360: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
361: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
362: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
363: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
364: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
365: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
366: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 367: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 368: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 369: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
370: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
371: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
372: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
373: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
374: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
375: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
376: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 377: emulation</a></span></dt>
1.106 rillig 378: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
379: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 380: </dl></dd>
1.106 rillig 381: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 382: </dl></dd>
1.106 rillig 383: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
384: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 385: <dd><dl>
1.106 rillig 386: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
387: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
388: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
389: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
390: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 391: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
392: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 393: </dl></dd>
394: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
395: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
396: <dd><dl>
397: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
398: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
399: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
400: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 401: </dl></dd>
1.75 rillig 402: </dl></dd>
403: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
404: <dd><dl>
1.106 rillig 405: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 406: <dd><dl>
1.106 rillig 407: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
408: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
409: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 410: <dd><dl>
1.106 rillig 411: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
412: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 413: </dl></dd>
1.106 rillig 414: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
415: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 416: <dd><dl>
1.106 rillig 417: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
418: <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 419: </dl></dd>
1.106 rillig 420: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 421: <dd><dl>
1.128 wiz 422: <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>
423: <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 424: </dl></dd>
425: </dl></dd>
1.106 rillig 426: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 427: <dd><dl>
1.106 rillig 428: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
429: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
430: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 431: <dd><dl>
1.106 rillig 432: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
433: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 434: </dl></dd>
435: </dl></dd>
1.106 rillig 436: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 437: <dd><dl>
1.106 rillig 438: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
439: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 440: </dl></dd>
441: </dl></dd>
442: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
443: <dd><dl>
444: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
445: <dd><dl>
446: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
447: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
448: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 449: <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 450: </dl></dd>
451: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
452: </dl></dd>
453: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
454: <dd><dl>
455: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
456: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
457: </dl></dd>
1.76 rillig 458: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
459: <dd><dl>
1.128 wiz 460: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
461: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
462: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
463: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
464: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
465: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 466: source packages</a></span></dt>
467: </dl></dd>
1.75 rillig 468: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
469: <dd><dl>
1.79 rillig 470: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 471: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
472: </dl></dd>
473: </dl>
474: </div>
1.82 rillig 475: <div class="list-of-tables">
476: <p><b>List of Tables</b></p>
477: <dl>
478: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
479: </dt>
1.106 rillig 480: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 481: </dt>
1.106 rillig 482: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 483: </dt>
1.82 rillig 484: </dl>
485: </div>
1.128 wiz 486: <div class="chapter" title="Chapter 1. What is pkgsrc?">
1.75 rillig 487: <div class="titlepage"><div><div><h2 class="title">
488: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
489: <div class="toc">
490: <p><b>Table of Contents</b></p>
491: <dl>
492: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 493: <dd><dl>
494: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
495: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
496: </dl></dd>
1.75 rillig 497: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
498: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 499: <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 500: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
501: </dl>
502: </div>
1.128 wiz 503: <div class="sect1" title="1.1. Introduction">
1.75 rillig 504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
505: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 506: <p>There is a lot of software freely available for Unix-based
507: systems, which is usually available in form of the source code. Before
508: such software can be used, it needs to be configured to the local
509: system, compiled and installed, and this is exactly what The NetBSD
510: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
511: to handle binary packages, so that not every user has to build the
512: packages for himself, which is a time-costly task.</p>
1.75 rillig 513: <p>pkgsrc currently contains several thousand packages,
514: including:</p>
1.128 wiz 515: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
516: <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 517: web server</p></li>
1.128 wiz 518: <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 519: web browser</p></li>
1.128 wiz 520: <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 521: Desktop Environment</p></li>
1.128 wiz 522: <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 523: Desktop Environment</p></li>
524: </ul></div>
525: <p>...just to name a few.</p>
526: <p>pkgsrc has built-in support for handling varying dependencies,
527: such as pthreads and X11, and extended features such as IPv6 support on
528: a range of platforms.</p>
1.128 wiz 529: <div class="sect2" title="1.1.1. Why pkgsrc?">
1.82 rillig 530: <div class="titlepage"><div><div><h3 class="title">
531: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
532: <p>
533: pkgsrc provides the following key features:
534: </p>
1.128 wiz 535: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
536: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 537: and installation of binary packages. The source and latest
538: patches are retrieved from a master or mirror download site, checksum
539: verified, then built on your system. Support for binary-only
540: distributions is available for both native platforms and NetBSD
541: emulated platforms.</p></li>
1.128 wiz 542: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 543: including binaries, libraries, man pages and other
544: documentation.</p></li>
1.128 wiz 545: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82 rillig 546: are handled automatically. The configuration files of various
547: packages are handled automatically during updates, so local changes
548: are preserved.</p></li>
1.128 wiz 549: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 550: consists of highly portable code. This allows the greatest speed of
551: development when porting to new a platform. This portability also
552: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
553: platforms</em></span>.</p></li>
1.128 wiz 554: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 555: international encryption requirements and build-time options for a
556: large number of packages are all set in a simple, central
557: configuration file.</p></li>
1.128 wiz 558: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 559: freely available under a BSD license, so you may extend and adapt
560: pkgsrc to your needs. Support for local packages and patches is
561: available right out of the box, so you can configure it specifically
562: for your environment.</p></li>
563: </ul></div>
1.91 rillig 564: <p>The following principles are basic to pkgsrc:</p>
1.128 wiz 565: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
566: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 567: — That means, if a package contains bugs, it's better to find
1.91 rillig 568: them and to complain about them rather than to just install the package
569: and hope that it works. There are numerous checks in pkgsrc that try to
570: 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
571: of shell scripts), and post-installation checks (installed files,
572: references to shared libraries, script interpreters).</p></li>
1.128 wiz 573: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 574: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 575: pkgsrc has been ported to many operating systems. Care is taken that
576: packages behave the same on all platforms.</p></li>
577: </ul></div>
1.82 rillig 578: </div>
1.128 wiz 579: <div class="sect2" title="1.1.2. Supported platforms">
1.82 rillig 580: <div class="titlepage"><div><div><h3 class="title">
581: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
582: <p>pkgsrc consists of both a source distribution and a binary
583: distribution for these operating systems. After retrieving the required
584: source or binaries, you can be up and running with pkgsrc in just
585: minutes!</p>
1.75 rillig 586: <p>pkgsrc was derived from FreeBSD's ports system, and
587: initially developed for NetBSD only. Since then, pkgsrc has
588: grown a lot, and now supports the following platforms:</p>
1.82 rillig 589: <div class="table">
590: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 591: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 592: <colgroup>
593: <col>
594: <col>
595: </colgroup>
596: <thead><tr>
597: <th>Platform</th>
598: <th>Date Support Added</th>
599: </tr></thead>
600: <tbody>
601: <tr>
1.110 hubertf 602: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 603: <td align="center">Aug 1997</td>
604: </tr>
605: <tr>
1.110 hubertf 606: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 607: <td align="center">Mar 1999</td>
608: </tr>
609: <tr>
1.110 hubertf 610: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 611: <td align="center">Jun 1999</td>
612: </tr>
613: <tr>
614: <td>
1.110 hubertf 615: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
616: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 617: </td>
618: <td align="center">Oct 2001</td>
619: </tr>
620: <tr>
1.110 hubertf 621: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 622: <td align="center">Nov 2002</td>
623: </tr>
624: <tr>
1.110 hubertf 625: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 626: <td align="center">Nov 2002</td>
627: </tr>
628: <tr>
1.110 hubertf 629: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 630: <td align="center">Dec 2002</td>
631: </tr>
632: <tr>
633: <td>BSD/OS</td>
634: <td align="center">Dec 2003</td>
635: </tr>
636: <tr>
1.110 hubertf 637: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 638: <td align="center">Dec 2003</td>
639: </tr>
640: <tr>
641: <td>
1.110 hubertf 642: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 643: (Microsoft Windows Services for Unix)
644: </td>
645: <td align="center">Mar 2004</td>
646: </tr>
647: <tr>
1.110 hubertf 648: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 649: <td align="center">Oct 2004</td>
650: </tr>
651: <tr>
1.110 hubertf 652: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 653: <td align="center">Nov 2004</td>
654: </tr>
1.98 wiz 655: <tr>
1.110 hubertf 656: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 657: <td align="center">Apr 2007</td>
658: </tr>
1.128 wiz 659: <tr>
660: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
661: <td align="center">Sep 2010</td>
662: </tr>
1.82 rillig 663: </tbody>
1.91 rillig 664: </table></div>
1.82 rillig 665: </div>
1.91 rillig 666: <br class="table-break">
1.82 rillig 667: </div>
1.75 rillig 668: </div>
1.128 wiz 669: <div class="sect1" title="1.2. Overview">
1.75 rillig 670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
671: <a name="overview"></a>1.2. Overview</h2></div></div></div>
672: <p>This document is divided into three parts. The first,
1.110 hubertf 673: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 674: describes how one can use one of the packages in the Package
675: Collection, either by installing a precompiled binary package,
1.93 rillig 676: or by building one's own copy using the NetBSD package system.
1.110 hubertf 677: 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 678: package so it can be easily built by other NetBSD users without
679: knowing about the package's building details. The third part,
1.110 hubertf 680: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 681: is intended for those who want to understand how pkgsrc is
682: implemented.</p>
683: <p>This document is available in various formats:
1.110 hubertf 684: <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 685: </div>
1.128 wiz 686: <div class="sect1" title="1.3. Terminology">
1.75 rillig 687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
688: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 689: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
690: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 691: terminology used within this document.</p>
692: <div class="variablelist"><dl>
693: <dt><span class="term">Package</span></dt>
694: <dd><p>A set of files and building instructions
695: that describe what's necessary
696: to build a certain piece of software using
697: pkgsrc. Packages are traditionally stored under
1.76 rillig 698: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 699: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 700: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 701: is part of the NetBSD operating system and can be bootstrapped
702: to run on non-NetBSD operating systems as well. It handles
703: building (compiling), installing, and removing of
704: packages.</p></dd>
1.75 rillig 705: <dt><span class="term">Distfile</span></dt>
706: <dd><p>This term describes the file or files that are
707: provided by the author of the piece of software to
708: distribute his work. All the changes necessary to build on
709: NetBSD are reflected in the corresponding package. Usually
710: the distfile is in the form of a compressed tar-archive,
711: but other types are possible, too. Distfiles are usually
712: stored below
1.76 rillig 713: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 714: <dt><span class="term">Port</span></dt>
715: <dd><p>This is the term used by FreeBSD and OpenBSD people
716: for what we call a package.
1.128 wiz 717: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 718: architecture.</p></dd>
719: <dt><span class="term">Precompiled/binary package</span></dt>
720: <dd>
721: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 722: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 723: file so it can be installed on machines of the same
724: machine architecture without the need to
725: recompile. Packages are usually generated in
1.76 rillig 726: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.110 hubertf 727: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 728: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 729: especially in the context of precompiled packages.</p>
730: </dd>
731: <dt><span class="term">Program</span></dt>
1.88 wiz 732: <dd><p>The piece of software to be installed which will be
733: constructed from all the files in the distfile by the
734: actions defined in the corresponding package.</p></dd>
1.75 rillig 735: </dl></div>
1.128 wiz 736: <div class="sect2" title="1.3.1. Roles involved in pkgsrc">
1.75 rillig 737: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 738: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75 rillig 739: <div class="variablelist"><dl>
740: <dt><span class="term">pkgsrc users</span></dt>
741: <dd>
742: <p>The
743: pkgsrc users are people who use the packages provided by pkgsrc.
744: Typically they are system administrators. The people using the
1.128 wiz 745: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
746: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 747: <p>There are two kinds of pkgsrc users: Some only want to
748: install pre-built binary packages. Others build the pkgsrc
749: packages from source, either for installing them directly or for
1.110 hubertf 750: 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 751: documentation.</p>
752: </dd>
753: <dt><span class="term">package maintainers</span></dt>
754: <dd><p>A
1.110 hubertf 755: 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 756: <dt><span class="term">infrastructure developers</span></dt>
757: <dd><p>These people are involved in all those files
1.76 rillig 758: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 759: 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 760: too.</p></dd>
761: </dl></div>
762: </div>
763: </div>
1.128 wiz 764: <div class="sect1" title="1.4. Typography">
1.75 rillig 765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
766: <a name="typography"></a>1.4. Typography</h2></div></div></div>
767: <p>When giving examples for commands, shell prompts are used to
768: show if the command should/can be issued as root, or if
1.128 wiz 769: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.75 rillig 770: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
771: shell prompt, assuming they use the C-shell or tcsh.</p>
772: </div>
773: </div>
1.128 wiz 774: <div class="part" title="Part I. The pkgsrc user's guide">
1.75 rillig 775: <div class="titlepage"><div><div><h1 class="title">
776: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
777: <div class="toc">
778: <p><b>Table of Contents</b></p>
779: <dl>
780: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
781: <dd><dl>
782: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
783: <dd><dl>
784: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.128 wiz 785: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 786: </dl></dd>
787: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
788: <dd><dl>
789: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
790: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
791: </dl></dd>
792: </dl></dd>
793: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
794: <dd><dl>
1.82 rillig 795: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
796: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
797: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
798: <dd><dl>
799: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
800: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
801: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
802: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
803: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
804: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
805: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 806: </dl></dd>
807: </dl></dd>
808: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
809: <dd><dl>
810: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
811: <dd><dl>
812: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
813: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 814: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
815: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
816: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
817: <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>
818: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
819: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 820: </dl></dd>
821: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
822: <dd><dl>
823: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
824: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
825: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
826: </dl></dd>
827: </dl></dd>
828: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
829: <dd><dl>
830: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
831: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 832: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 833: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 834: <dd><dl>
1.103 wiz 835: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 836: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
837: <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 838: </dl></dd>
1.103 wiz 839: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
840: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 841: </dl></dd>
842: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
843: <dd><dl>
844: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
845: <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 846: </dl></dd>
847: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
848: builds)</a></span></dt>
1.75 rillig 849: <dd><dl>
1.106 rillig 850: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
851: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
852: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
853: <dd><dl>
854: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
855: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
856: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
857: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
858: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
859: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
860: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
861: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
862: </dl></dd>
863: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 864: <dd><dl>
865: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
866: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
867: </dl></dd>
1.106 rillig 868: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
869: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
870: </dl></dd>
871: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
872: <dd><dl>
1.128 wiz 873: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
874: <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 875: </dl></dd>
876: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
877: <dd><dl>
878: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
879: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
880: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
881: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
882: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
883: <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>
884: <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 885: <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 886: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.128 wiz 887: <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
888: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
889: <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 890: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
891: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
892: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.128 wiz 893: <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 894: <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 895: <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 896: </dl></dd>
897: </dl>
898: </div>
1.128 wiz 899: <div class="chapter" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">
1.75 rillig 900: <div class="titlepage"><div><div><h2 class="title">
901: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
902: <div class="toc">
903: <p><b>Table of Contents</b></p>
904: <dl>
905: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
906: <dd><dl>
907: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.128 wiz 908: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 909: </dl></dd>
910: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
911: <dd><dl>
912: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
913: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
914: </dl></dd>
915: </dl>
916: </div>
1.91 rillig 917: <p>Before you download and extract the files, you need to decide
918: where you want to extract them. When using pkgsrc as root user, pkgsrc
919: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
920: free to install the sources and binary packages wherever you want in
921: your filesystem, provided that the pathname does not contain white-space
922: or other characters that are interpreted specially by the shell and some
923: other programs. A safe bet is to use only letters, digits, underscores
924: and dashes.</p>
1.128 wiz 925: <div class="sect1" title="2.1. Getting pkgsrc for the first time">
1.75 rillig 926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
927: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
928: <p>Before you download any pkgsrc files, you should decide
929: whether you want the <span class="emphasis"><em>current</em></span> branch or the
930: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
931: quarterly basis from the current branch and only gets modified
932: for security updates. The names of the stable branches are built
933: from the year and the quarter, for example
1.124 snj 934: <code class="literal">2009Q1</code>.</p>
1.75 rillig 935: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 936: want to download pkgsrc. You can get it as a tar file or via CVS.
937: Both ways are described here.</p>
938: <div class="sect2" title="2.1.1. As tar file">
1.75 rillig 939: <div class="titlepage"><div><div><h3 class="title">
940: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
941: <p>The primary download location for all pkgsrc files is
1.110 hubertf 942: <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 943: number of subdirectories for different purposes, which are
1.110 hubertf 944: 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 945: <p>The tar file for the current branch is in the directory
1.110 hubertf 946: <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 947: It is autogenerated daily.</p>
1.124 snj 948: <p>The tar file for the stable branch 2009Q1 is in the
949: 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 950: <p>To download a pkgsrc stable tarball, run:</p>
951: <pre class="screen">
1.126 jakllsch 952: <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>
953: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 954: stable branch to be downloaded, for example,
1.128 wiz 955: <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span>.</p>
1.112 weinem 956: <p>Then, extract it with:</p>
1.126 jakllsch 957: <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 958: <p>This will create the directory <code class="filename">pkgsrc/</code>
959: in <code class="filename">/usr/</code> and all the package source will be
960: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
961: <p>To download pkgsrc-current, run:</p>
962: <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 963: </div>
1.128 wiz 964: <div class="sect2" title="2.1.2. Via anonymous CVS">
1.75 rillig 965: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 966: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
967: <p>To fetch a specific pkgsrc stable branch, run:</p>
968: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
969: </pre>
970: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
971: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span></p>
972: <p>This will create the directory <code class="filename">pkgsrc/</code>
973: in your <code class="filename">/usr/</code> directory and all the package source
974: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
975: <p>To fetch the pkgsrc current branch, run:</p>
976: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 grant 977: </pre>
1.128 wiz 978: <p>Refer to <a class="ulink" href="http://NetBSD.org/FIXME" target="_top">list of available CVS mirrors</a> to choose faster one.</p>
979: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
980: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
981: </pre>
982: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
983: For Bourne shells, you can set it in your <code class="filename">.profile</code>
984: or better globally in <code class="filename">/etc/profile</code>:</p>
985: <pre class="programlisting">
986: # set CVS remote shell command
987: CVS_RSH=ssh
988: export CVS_RSH
989: </pre>
990: <p>By default, CVS doesn't do things like most people would expect it to do.
991: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
992: in your home directory and saving the following lines to it.
993: This file will save you lots of headache and some bug reports, so we strongly recommend it.
994: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 995: <pre class="programlisting">
996: # recommended CVS configuration file from the pkgsrc guide
1.128 wiz 997: cvs -q -z3
1.101 rillig 998: checkout -P
1.103 wiz 999: update -dP
1000: diff -upN
1.101 rillig 1001: rdiff -u
1.128 wiz 1002: release -d
1.101 rillig 1003: </pre>
1.75 rillig 1004: </div>
1005: </div>
1.128 wiz 1006: <div class="sect1" title="2.2. Keeping pkgsrc up-to-date">
1.75 rillig 1007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1008: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1009: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1010: (which also works if you have first installed it via a tar
1011: file). It saves bandwidth and hard disk activity, compared to
1012: downloading the tar file again.</p>
1.128 wiz 1013: <div class="sect2" title="2.2.1. Via tar files">
1.75 rillig 1014: <div class="titlepage"><div><div><h3 class="title">
1015: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.128 wiz 1016: <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1017: <h3 class="title">Warning</h3>
1.77 rillig 1018: <p>When updating from a tar file, you first need to
1019: completely remove the old pkgsrc directory. Otherwise those
1020: files that have been removed from pkgsrc in the mean time will
1021: not be removed on your local disk, resulting in inconsistencies.
1022: When removing the old files, any changes that you have done to
1023: the pkgsrc files will be lost after updating. Therefore updating
1024: via CVS is strongly recommended.</p>
1.75 rillig 1025: </div>
1.82 rillig 1026: <p>Note that by default the distfiles and the binary packages
1027: are saved in the pkgsrc tree, so don't forget to rescue them
1028: before updating. You can also configure pkgsrc to use other than
1029: the default directories by setting the
1030: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1031: 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 1032: <p>To update pkgsrc from a tar file, download the tar file as
1033: explained above. Then, make sure that you have not made any
1034: changes to the files in the pkgsrc directory. Remove the pkgsrc
1035: directory and extract the new tar file. Done.</p>
1036: </div>
1.128 wiz 1037: <div class="sect2" title="2.2.2. Via CVS">
1.75 rillig 1038: <div class="titlepage"><div><div><h3 class="title">
1039: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1040: <p>To update pkgsrc via CVS, make sure the environment
1041: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.113 weinem 1042: change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1043: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
1044: <code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1.128 wiz 1045: <div class="sect3" title="2.2.2.1. Switching between different pkgsrc branches">
1.75 rillig 1046: <div class="titlepage"><div><div><h4 class="title">
1047: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1048: <p>When updating pkgsrc, the CVS program keeps track of the
1049: branch you selected. But if you, for whatever reason, want to
1050: switch from the stable branch to the current one, you can do it
1.128 wiz 1051: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1052: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1053: back to the stable branch, add the
1.128 wiz 1054: <span class="quote">“<span class="quote">-rpkgsrc-2009Q3</span>”</span> option.</p>
1.75 rillig 1055: </div>
1.128 wiz 1056: <div class="sect3" title="2.2.2.2. What happens to my changes when updating?">
1.75 rillig 1057: <div class="titlepage"><div><div><h4 class="title">
1058: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1059: <p>When you update pkgsrc, the CVS program will only touch
1060: those files that are registered in the CVS repository. That
1061: means that any packages that you created on your own will stay
1062: unmodified. If you change files that are managed by CVS, later
1063: updates will try to merge your changes with those that have been
1064: done by others. See the CVS manual, chapter
1.128 wiz 1065: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1066: </div>
1067: </div>
1068: </div>
1069: </div>
1.128 wiz 1070: <div class="chapter" title="Chapter 3. Using pkgsrc on systems other than NetBSD">
1.75 rillig 1071: <div class="titlepage"><div><div><h2 class="title">
1072: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1073: <div class="toc">
1074: <p><b>Table of Contents</b></p>
1075: <dl>
1.82 rillig 1076: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1077: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1078: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1079: <dd><dl>
1080: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1081: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1082: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1083: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1084: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1085: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1086: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1087: </dl></dd>
1088: </dl>
1089: </div>
1.128 wiz 1090: <div class="sect1" title="3.1. Binary distribution">
1.75 rillig 1091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1092: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1093: <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 1094: </div>
1.128 wiz 1095: <div class="sect1" title="3.2. Bootstrapping pkgsrc">
1.82 rillig 1096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1097: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1098: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1099: <pre class="screen">
1100: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1101: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1102: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1103: </pre>
1.110 hubertf 1104: <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 1105: pkgsrc before bootstrapping. The given
1.110 hubertf 1106: <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.87 wiz 1107: <code class="filename">/usr/pkg</code> for the
1108: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1109: and <code class="filename">/var/db/pkg</code> for the package database
1110: directory where pkgsrc will do its internal bookkeeping.
1111: However, these can also be set using command-line
1112: arguments.</p>
1.128 wiz 1113: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1114: <h3 class="title">Note</h3>
1.110 hubertf 1115: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1116: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1117: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1118: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1119: </div>
1120: </div>
1.128 wiz 1121: <div class="sect1" title="3.3. Platform-specific notes">
1.75 rillig 1122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1123: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1124: <p>Here are some platform-specific notes you should be aware of.</p>
1.128 wiz 1125: <div class="sect2" title="3.3.1. Darwin (Mac OS X)">
1.75 rillig 1126: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1127: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.126 jakllsch 1128: <p>Darwin 5.x and up are supported. Before you start, you
1129: will need to download and install the Mac OS X Developer Tools
1130: from Apple's Developer Connection. See
1131: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1132: for details. Also, make sure you install X11 (an optional
1133: package included with the Developer Tools) if you intend to
1134: build packages that use the X11 Window System.</p>
1.75 rillig 1135: </div>
1.128 wiz 1136: <div class="sect2" title="3.3.2. FreeBSD">
1.75 rillig 1137: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1138: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1139: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1140: other versions may work.</p>
1.75 rillig 1141: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1142: with the FreeBSD userland tools. There are several steps:</p>
1.128 wiz 1143: <div class="orderedlist"><ol class="orderedlist" type="1">
1144: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 1145: <code class="filename">/var/db/pkg</code>. It is therefore
1146: recommended that you choose a different location (e.g.
1147: <code class="filename">/usr/pkgdb</code>) by
1148: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1149: <li class="listitem">
1.75 rillig 1150: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1151: good idea to move them out of the way to avoid confusion, e.g.</p>
1152: <pre class="screen">
1153: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1154: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1155: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1156: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1157: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1158: </pre>
1.75 rillig 1159: </li>
1.128 wiz 1160: <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 1161: <code class="filename">/etc/mk.conf.example</code> file
1162: when you use the bootstrap script.</p></li>
1.75 rillig 1163: </ol></div>
1164: </div>
1.128 wiz 1165: <div class="sect2" title="3.3.3. Interix">
1.75 rillig 1166: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1167: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1168: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1169: providing a Unix-like environment with a tighter kernel integration than
1170: available with Cygwin. It is part of the Windows Services for Unix
1171: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1172: (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 1173: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1174: are not officially supported. (The main difference in 3.0/3.1 is lack
1175: of pthreads, but other parts of libc may also be lacking.)</p>
1.129 ! wiz 1176: <p>Services for Unix Applications (aka SUA) is an integrated
! 1177: component of Windows Server 2003 R2 (5.2), Windows Vista and
! 1178: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
! 1179: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
! 1180: 6.1 (64bit) subsystems have been tested. Other versions may
! 1181: work as well. The Interix 5.x subsystem has not yet been tested
! 1182: with pkgsrc.</p>
1.128 wiz 1183: <div class="sect3" title="3.3.3.1. When installing Interix/SFU">
1.75 rillig 1184: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1185: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1186: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1187: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.128 wiz 1188: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1189: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1190: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1191: <li class="listitem"><p>Remote Connectivity</p></li>
1192: <li class="listitem"><p>Interix SDK</p></li>
1.75 rillig 1193: </ul></div>
1194: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1195: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1196: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1197: pkgsrc (or from a binary package).</p>
1.75 rillig 1198: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1199: not need to be installed, but Remote Connectivity itself should be
1200: installed in order to have a working inetd.</p>
1.75 rillig 1201: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1202: behavior for Interix programs, and whether to make pathnames default to
1203: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1204: enabled. (Without case-sensitivity, a large number of packages including
1205: perl will not build.)</p>
1.75 rillig 1206: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1207: works (via the Data Execution Prevention feature). In order to use
1208: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1209: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1210: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1211: support contract; however, Debian Interix Port has made most Interix
1212: 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 1213: <p>In addition to the hotfix noted above, it may be necessary to
1214: disable Data Execution Prevention entirely to make Interix functional.
1215: This may happen only with certain types of CPUs; the cause is not fully
1216: understood at this time. If gcc or other applications still segfault
1217: repeatedly after installing one of the hotfixes note above, the
1218: following option can be added to the appropriate "boot.ini" line on the
1219: Windows boot drive: /NoExecute=AlwaysOff
1220: (WARNING, this will disable DEP completely, which may be a security
1221: risk if applications are often run as a user in the Administrators
1222: group!)</p>
1.75 rillig 1223: </div>
1.128 wiz 1224: <div class="sect3" title="3.3.3.2. What to do if Interix/SFU is already installed">
1.75 rillig 1225: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1226: <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 1227: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1228: with pkgsrc, note the following things.</p>
1.128 wiz 1229: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1230: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1231: Windows Services for UNIX, then click Change. In the installer, choose
1232: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 wiz 1233: <li class="listitem">
1.75 rillig 1234: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1235: change the following registry key:</p>
1.75 rillig 1236: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1237: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1238: </li>
1.128 wiz 1239: <li class="listitem">
1.75 rillig 1240: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1241: following registry key:</p>
1.75 rillig 1242: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1243: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1244: </li>
1245: </ul></div>
1246: </div>
1.128 wiz 1247: <div class="sect3" title="3.3.3.3. Important notes for using pkgsrc">
1.75 rillig 1248: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1249: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1250: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1251: running "pkg_add") must be a member of the local Administrators
1252: group. Such a user must also be used to run the bootstrap. This is
1253: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1254: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1255: automatically complain if this is not the case. This ensures that
1256: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1257: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1258: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1259: NOT be used in conjunction with pkgsrc. If you choose to use them at
1260: the same time as the pkgsrc packages, ensure that you use the proper
1261: pkg_* tools for each type of binary package.</p>
1.75 rillig 1262: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1263: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1264: don't have a termcap/terminfo entry for it, but the following .termcap
1265: entry provides adequate emulation in most cases:</p>
1.75 rillig 1266: <pre class="programlisting">
1.100 rillig 1267: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1268: </pre>
1.75 rillig 1269: </div>
1.128 wiz 1270: <div class="sect3" title="3.3.3.4. Limitations of the Interix platform">
1.75 rillig 1271: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1272: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1273: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1274: for a full Unix-like platform, it has some drawbacks that should
1275: be noted for those desiring to make the most of Interix.</p>
1.128 wiz 1276: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1277: <li class="listitem">
1.75 rillig 1278: <p><span class="strong"><strong>X11:</strong></span></p>
1279: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1280: and can run X11 based applications, but it does
1281: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1282: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1283: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1284: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1285: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1286: and the free X11 server included with
1.110 hubertf 1287: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1288: </li>
1.128 wiz 1289: <li class="listitem">
1.75 rillig 1290: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1291: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1292: Win32 applications, it does not currently support various X11
1293: protocol extensions for acceleration (such as MIT-SHM or DGA).
1294: Most interactive applications to a local X server will run
1295: reasonably fast, but full motion video and other graphics
1296: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1297: </li>
1.128 wiz 1298: <li class="listitem">
1.75 rillig 1299: <p><span class="strong"><strong>Audio:</strong></span></p>
1300: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1301: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1302: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1303: <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 1304: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1305: server component. To output audio via an Interix host, the
1.91 rillig 1306: <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 1307: must also be installed.</p>
1.75 rillig 1308: </li>
1.128 wiz 1309: <li class="listitem">
1.75 rillig 1310: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1311: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1312: is not currently possible to access CD/DVD drives, USB devices,
1313: or SCSI devices through non-filesystem means. Among other things,
1314: this makes it impossible to use Interix directly for CD/DVD
1315: burning.</p>
1.75 rillig 1316: </li>
1.128 wiz 1317: <li class="listitem">
1.75 rillig 1318: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1319: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1320: drives are also not directly accessible in Interix. However,
1321: support is in work to make tape drive access possible by using
1322: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1323: esound server).</p>
1.75 rillig 1324: </li>
1325: </ul></div>
1326: </div>
1.128 wiz 1327: <div class="sect3" title="3.3.3.5. Known issues for pkgsrc on Interix">
1.75 rillig 1328: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1329: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1330: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1331: Windows system; any member of the local Administrators group will
1332: suffice. However, some packages currently assume that the user
1333: named "root" is the privileged user. To accommodate these, you
1334: may create such a user; make sure it is in the local group
1335: Administrators (or your language equivalent).</p>
1.110 hubertf 1336: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1337: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1338: time being, install packages as the local Administrator (or
1339: your language equivalent), or run the following command after
1340: installing a package to work around the issue:</p>
1.75 rillig 1341: <pre class="screen">
1.87 wiz 1342: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1343: </pre>
1.75 rillig 1344: </div>
1345: </div>
1.128 wiz 1346: <div class="sect2" title="3.3.4. IRIX">
1.75 rillig 1347: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1348: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1349: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1350: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1351: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1352: 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 1353: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.110 hubertf 1354: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87 wiz 1355: etc.</p>
1.86 schwarz 1356: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1357: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1358: you start out using "abi=n32", that's what all your packages will be built
1359: with.</p>
1360: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1361: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1362: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1363: try to link n32 object files with lib64 or vice versa. Check your
1364: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1365: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1366: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1367: as it appears that IRIX linker occasionally runs into issues when trying to
1368: link over a network-mounted file system.</p>
1.75 rillig 1369: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1370: as imake(1), but you may want to set some options depending on your local
1371: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1372: course, your compiler's man pages for details.</p>
1.75 rillig 1373: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1374:
1.87 wiz 1375: </p>
1.75 rillig 1376: <pre class="programlisting">
1.100 rillig 1377: PKGSRC_COMPILER= mipspro
1.87 wiz 1378: </pre>
1.75 rillig 1379: <p>
1.1 grant 1380:
1.110 hubertf 1381: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1382: are using gcc and may end up passing invalid flags to the compiler. Note that
1383: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1384: default.</p>
1.75 rillig 1385: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1386: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1387: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1388: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1389: '--preserve-path' flag.</p>
1.75 rillig 1390: </div>
1.128 wiz 1391: <div class="sect2" title="3.3.5. Linux">
1.75 rillig 1392: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1393: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1394: <p>Some versions of Linux (for example Debian GNU/Linux) need
1395: either libtermcap or libcurses (libncurses). Installing the
1396: distributions libncurses-dev package (or equivalent) should fix
1397: the problem.</p>
1398: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1399: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1400: i386 have been tested.</p>
1.75 rillig 1401: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1402: directory:</p>
1.75 rillig 1403: <pre class="programlisting">
1.100 rillig 1404: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1405: ac_cv___attribute__=yes ./bootstrap
1.87 wiz 1406: </pre>
1.128 wiz 1407: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1408: <h3 class="title">Note</h3>
1409: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1410: </div>
1411: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1412: function, which icc does not support. #undef'ing __attribute__ has the
1413: unfortunate side-effect of breaking many of the Linux header files, which
1414: cannot be compiled properly without __attribute__. The test must be
1415: overridden so that __attribute__ is assumed supported by the
1416: compiler.</p>
1.75 rillig 1417: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.110 hubertf 1418: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1419: <pre class="programlisting">
1.100 rillig 1420: PKGSRC_COMPILER= icc
1.87 wiz 1421: </pre>
1.75 rillig 1422: <p>The default installation directory for icc is
1.87 wiz 1423: <code class="filename">/opt/intel_cc_80</code>, which
1424: is also the pkgsrc default. If you have installed it into a different
1425: directory, set <code class="varname">ICCBASE</code> in
1.110 hubertf 1426: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1427: <pre class="programlisting">
1.100 rillig 1428: ICCBASE= /opt/icc
1.87 wiz 1429: </pre>
1.75 rillig 1430: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1431: provided by icc, so binaries can be run on other systems which do not
1432: have the shared libraries installed.</p>
1433: <p>Libtool, however, extracts a list of libraries from the
1.110 hubertf 1434: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87 wiz 1435: records it, throwing away the -Bstatic and -Bdynamic options
1436: interspersed between the libraries. This means that
1437: libtool-linked C++ shared libraries will have a runtime
1438: dependency on the icc libraries until this is fixed in
1439: libtool.</p>
1.75 rillig 1440: </div>
1.128 wiz 1441: <div class="sect2" title="3.3.6. OpenBSD">
1.75 rillig 1442: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1443: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1444: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1445: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1446: with the OpenBSD userland tools. There are several steps:</p>
1.128 wiz 1447: <div class="orderedlist"><ol class="orderedlist" type="1">
1448: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 1449: <code class="filename">/var/db/pkg</code>. It is therefore
1450: recommended that you choose a different location (e.g.
1451: <code class="filename">/usr/pkgdb</code>) by
1452: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1453: <li class="listitem">
1.75 rillig 1454: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1455: good idea to move them out of the way to avoid confusion, e.g.</p>
1456: <pre class="screen">
1457: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1458: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1459: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1460: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1461: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1462: </pre>
1.75 rillig 1463: </li>
1.128 wiz 1464: <li class="listitem">
1.110 hubertf 1465: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1466: <code class="filename">/etc/mk.conf.example</code> file
1467: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1468: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1469: as well. You can work around this by enclosing all the pkgsrc-specific parts
1470: of the file with:</p>
1471: <pre class="programlisting">
1.100 rillig 1472: .ifdef BSD_PKG_MK
1473: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1474: .else
1475: # OpenBSD stuff
1476: .endif
1.87 wiz 1477: </pre>
1.75 rillig 1478: </li>
1479: </ol></div>
1480: </div>
1.128 wiz 1481: <div class="sect2" title="3.3.7. Solaris">
1.75 rillig 1482: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1483: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1484: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1485: You will need a working C compiler. Both gcc 2.95.3 and
1486: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1487: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1488: process and to build packages.</p>
1.128 wiz 1489: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1490: <li class="listitem"><p>SUNWsprot</p></li>
1491: <li class="listitem"><p>SUNWarc</p></li>
1492: <li class="listitem"><p>SUNWbtool</p></li>
1493: <li class="listitem"><p>SUNWtoo</p></li>
1494: <li class="listitem"><p>SUNWlibm</p></li>
1.75 rillig 1495: </ul></div>
1.78 rillig 1496: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1497: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1498: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1499: your $prefix are in your <code class="varname">PATH</code>. This includes
1500: <code class="filename">/usr/ccs/{bin,lib}</code>
1501: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.128 wiz 1502: <div class="sect3" title="3.3.7.1. If you are using gcc">
1.75 rillig 1503: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1504: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1505: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1506: for building all packages.</p>
1.75 rillig 1507: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1508: then either build gcc from
1.91 rillig 1509: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
1.87 wiz 1510: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1511: <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 1512: </div>
1.128 wiz 1513: <div class="sect3" title="3.3.7.2. If you are using Sun WorkShop">
1.75 rillig 1514: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1515: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1516: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1517: 5.0)</p>
1.128 wiz 1518: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1519: <li class="listitem"><p>SPROcc
1.87 wiz 1520: - Sun WorkShop Compiler C 5.0</p></li>
1.128 wiz 1521: <li class="listitem"><p>SPROcpl
1.87 wiz 1522: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 wiz 1523: <li class="listitem"><p>SPROild
1.87 wiz 1524: - Sun WorkShop Incremental Linker</p></li>
1.128 wiz 1525: <li class="listitem"><p>SPROlang
1.87 wiz 1526: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1527: </ul></div>
1.96 rillig 1528: <p>You should set the following variables in your
1.110 hubertf 1529: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1530: <pre class="programlisting">
1.100 rillig 1531: CC= cc
1532: CXX= CC
1533: CPP= cc -E
1534: CXXCPP= CC -E
1.96 rillig 1535: </pre>
1.128 wiz 1536: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1537: <h3 class="title">Note</h3>
1538: <p>The <code class="varname">CPP</code> setting might break some
1539: packages that use the C preprocessor for processing things other
1540: than C source code.</p>
1541: </div>
1.75 rillig 1542: </div>
1.128 wiz 1543: <div class="sect3" title="3.3.7.3. Building 64-bit binaries with SunPro">
1.75 rillig 1544: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1545: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1546: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1547: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1548: <pre class="programlisting">
1.100 rillig 1549: PKGSRC_COMPILER= sunpro
1550: ABI= 64
1.96 rillig 1551: </pre>
1.128 wiz 1552: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1553: <h3 class="title">Note</h3>
1554: <p>This setting has been tested for the SPARC
1555: architecture. Intel and AMD machines need some more
1556: work.</p>
1557: </div>
1.75 rillig 1558: </div>
1.128 wiz 1559: <div class="sect3" title="3.3.7.4. Common problems">
1.75 rillig 1560: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1561: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110 hubertf 1562: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1563: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1564: The workaround is to use another shell for the configure
1.91 rillig 1565: 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 1566: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1567: <pre class="programlisting">
1.100 rillig 1568: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1569: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1570: </pre>
1.91 rillig 1571: <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 1572: </div>
1573: </div>
1574: </div>
1575: </div>
1.128 wiz 1576: <div class="chapter" title="Chapter 4. Using pkgsrc">
1.75 rillig 1577: <div class="titlepage"><div><div><h2 class="title">
1578: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1579: <div class="toc">
1580: <p><b>Table of Contents</b></p>
1581: <dl>
1582: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1583: <dd><dl>
1584: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1585: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1586: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1587: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1588: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1589: <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>
1590: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1591: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1592: </dl></dd>
1593: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1594: <dd><dl>
1595: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1596: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1597: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1598: </dl></dd>
1599: </dl>
1600: </div>
1601: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1602: is to only install the package tools and to use binary packages
1.128 wiz 1603: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1604: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1605: of pkgsrc, too. Then you are able to build your own packages,
1606: and you can still use binary packages from someone else.</p>
1.128 wiz 1607: <div class="sect1" title="4.1. Using binary packages">
1.75 rillig 1608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1609: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1610: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1611: server and its mirrors, there are collections of binary packages,
1612: ready to be installed. These binary packages have been built using the
1613: default settings for the directories, that is:</p>
1.128 wiz 1614: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1615: <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>
1616: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1617: <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 1618: </ul></div>
1619: <p>If you cannot use these directories for whatever reasons (maybe
1620: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1621: 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.128 wiz 1622: <div class="sect2" title="4.1.1. Finding binary packages">
1.75 rillig 1623: <div class="titlepage"><div><div><h3 class="title">
1624: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1625: <p>To install binary packages, you first need to know from where
1626: to get them. The first place where you should look is on the main
1.110 hubertf 1627: 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 1628: <p>This directory contains binary packages for multiple
1629: platforms. First, select your operating system. (Ignore the
1630: directories with version numbers attached to it, they just exist for
1631: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1632: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1633: <p>In this directory, you often find a file called
1634: <code class="filename">bootstrap.tar.gz</code> which contains the package
1635: management tools. If the file is missing, it is likely that your
1636: operating system already provides those tools. Download the file and
1637: extract it in the <code class="filename">/</code> directory. It will create
1638: the directories <code class="filename">/usr/pkg</code> (containing the tools
1639: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1640: (the database of installed packages).</p>
1.75 rillig 1641: </div>
1.128 wiz 1642: <div class="sect2" title="4.1.2. Installing binary packages">
1.75 rillig 1643: <div class="titlepage"><div><div><h3 class="title">
1644: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1645: <p>In the directory from the last section, there is a
1646: subdirectory called <code class="filename">All</code>, which contains all the
1647: binary packages that are available for the platform, excluding those
1648: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1649: medium you are using).</p>
1.109 rillig 1650: <p>To install packages directly from an FTP or HTTP server, run
1651: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1652: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1653: <pre class="screen">
1654: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1655: <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>
1656: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1657: </pre>
1658: <p>Instead of URLs, you can also use local paths, for example if
1659: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1660: repository. If you want to install packages from multiple sources,
1661: you can separate them by a semicolon in
1662: <code class="varname">PKG_PATH</code>.</p>
1663: <p>After these preparations, installing a package is very
1664: easy:</p>
1665: <pre class="screen">
1666: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1667: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1668: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1669: </pre>
1.75 rillig 1670: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1671: package in question will be installed, too, assuming they are
1672: present where you install from.</p>
1.128 wiz 1673: <p>Adding packages might install vulnerable packages.
1674: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1675: regularly, especially after installing new packages, and verify
1676: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1677: <p>After you've installed packages, be sure to have
1.88 wiz 1678: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1679: <code class="varname">PATH</code> so you can actually start the just
1680: installed program.</p>
1.75 rillig 1681: </div>
1.128 wiz 1682: <div class="sect2" title="4.1.3. Deinstalling packages">
1.75 rillig 1683: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1684: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1685: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1686: installed from source code or from a binary package. The
1.110 hubertf 1687: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1688: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1689: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1690: name can be given with or without version number. Wildcards can
1691: also be used to deinstall a set of packages, for example
1692: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1693: so that the shell does not expand them before
1694: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1695: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1696: removes all the packages that require the package in question
1697: and then removes the package itself. For example:
1.82 rillig 1698:
1.88 wiz 1699: </p>
1.82 rillig 1700: <pre class="screen">
1.88 wiz 1701: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1702: </pre>
1.82 rillig 1703: <p>
1704:
1.88 wiz 1705: will remove jpeg and all the packages that used it; this allows
1706: upgrading the jpeg package.</p>
1.82 rillig 1707: </div>
1.128 wiz 1708: <div class="sect2" title="4.1.4. Getting information about installed packages">
1.82 rillig 1709: <div class="titlepage"><div><div><h3 class="title">
1710: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1711: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1712: installed packages or binary package files.</p>
1.82 rillig 1713: </div>
1.128 wiz 1714: <div class="sect2" title="4.1.5. Checking for security vulnerabilities in installed packages">
1.82 rillig 1715: <div class="titlepage"><div><div><h3 class="title">
1716: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1717: <p>
1.88 wiz 1718: The NetBSD Security-Officer and Packages Groups maintain a list of
1719: known security vulnerabilities to packages which are (or have been)
1720: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1721: 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 1722: </p>
1.82 rillig 1723: <p>
1.125 wiz 1724: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1725: this list can be downloaded
1726: automatically, and a security audit of all packages installed on a system
1727: can take place.
1728: </p>
1.82 rillig 1729: <p>
1.125 wiz 1730: There are two components to auditing. The first
1731: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1732: is for downloading
1.88 wiz 1733: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1734: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1735: installed packages are vulnerable. If a package is vulnerable, you
1736: will see output similar to the following:
1737: </p>
1.82 rillig 1738: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1739: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1740: <p>
1.125 wiz 1741: You may wish to have the
1.110 hubertf 1742: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1743: file downloaded daily so that
1744: it remains current. This may be done by adding an appropriate entry
1745: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1746: </p>
1747: <pre class="screen">
1748: # download vulnerabilities file
1749: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1750: </pre>
1751: <p>
1752: will update the vulnerability list every day at 3AM. You may wish to do
1753: this more often than once a day.
1754:
1755: In addition, you may wish to run the package audit from the daily
1756: security script. This may be accomplished by adding the following
1757: line to <code class="filename">/etc/security.local</code>:
1758: </p>
1759: <pre class="screen">
1760: /usr/sbin/pkg_admin audit
1761: </pre>
1762: <p>
1.88 wiz 1763: </p>
1.82 rillig 1764: </div>
1.128 wiz 1765: <div class="sect2" title="4.1.6. Finding if newer versions of your installed packages are in pkgsrc">
1.82 rillig 1766: <div class="titlepage"><div><div><h3 class="title">
1767: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1768: <p>
1.112 weinem 1769: 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 1770: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1771: argument to check if your packages are up-to-date, e.g.
1772: </p>
1773: <pre class="screen">
1774: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1775: ...
1.88 wiz 1776: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1777: </pre>
1.110 hubertf 1778: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1779: package on your system and rebuild any dependencies.
1780: </p>
1.82 rillig 1781: </div>
1.128 wiz 1782: <div class="sect2" title="4.1.7. Other administrative functions">
1.82 rillig 1783: <div class="titlepage"><div><div><h3 class="title">
1784: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1785: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1786: administrative functions on the package system.</p>
1.82 rillig 1787: </div>
1.128 wiz 1788: <div class="sect2" title="4.1.8. A word of warning">
1.82 rillig 1789: <div class="titlepage"><div><div><h3 class="title">
1790: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1791: <p>Please pay very careful attention to the warnings
1.110 hubertf 1792: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88 wiz 1793: inherent dangers of installing binary packages which you did
1794: not create yourself, and the security holes that can be
1795: introduced onto your system by indiscriminate adding of such
1796: files.</p>
1.75 rillig 1797: <p>The same warning of course applies to every package you
1.88 wiz 1798: install from source when you haven't completely read and
1799: understood the source code of the package, the compiler that
1800: is used to build the package and all the other tools that are
1801: involved.</p>
1.75 rillig 1802: </div>
1803: </div>
1.128 wiz 1804: <div class="sect1" title="4.2. Building packages from source">
1.75 rillig 1805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1806: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1807: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1808: directory now contains a set of packages, organized into
1809: categories. You can browse the online index of packages, or run
1.110 hubertf 1810: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1811: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 1812: 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 1813: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1814: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1815: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1816: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1817: different <code class="varname">LOCALBASE</code> definitions on the same
1818: system (inside a chroot is an exception). </p>
1819: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1820: 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 1821: instructions how to create your own packages.</p>
1.128 wiz 1822: <div class="sect2" title="4.2.1. Requirements">
1.75 rillig 1823: <div class="titlepage"><div><div><h3 class="title">
1824: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1825: <p>To build packages from source, you need a working C
1.88 wiz 1826: compiler. On NetBSD, you need to install the
1.128 wiz 1827: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1828: sets. If you want to build X11-related packages, the
1.128 wiz 1829: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1830: sets are required, too.</p>
1.75 rillig 1831: </div>
1.128 wiz 1832: <div class="sect2" title="4.2.2. Fetching distfiles">
1.75 rillig 1833: <div class="titlepage"><div><div><h3 class="title">
1834: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1835: <p>The first step for building a package is downloading the
1.88 wiz 1836: distfiles (i.e. the unmodified source). If they have not yet been
1837: downloaded, pkgsrc will fetch them automatically.</p>
1838: <p>If you have all files that you need in the
1839: <code class="filename">distfiles</code> directory,
1840: you don't need to connect. If the distfiles are on CD-ROM, you can
1841: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1842: </p>
1.82 rillig 1843: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1844: <p>
1.110 hubertf 1845: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1846: <p>By default a list of distribution sites will be randomly
1847: intermixed to prevent huge load on servers which holding popular
1848: packages (for example, SourceForge.net mirrors). Thus, every
1849: time when you need to fetch yet another distfile all the mirrors
1850: will be tried in new (random) order. You can turn this feature
1851: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1852: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1853: <p>You can overwrite some of the major distribution sites to
1854: fit to sites that are close to your own. By setting one or two
1855: variables you can modify the order in which the master sites are
1856: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1857: delimited list of domain suffixes.
1858: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1859: contains a whitespace delimited list of regular expressions. It
1860: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1861: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1862: some examples. This may save some of your bandwidth and
1863: time.</p>
1.75 rillig 1864: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1865: if you want to keep the settings, by editing the
1.110 hubertf 1866: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1867: and adding the definitions there.</p>
1.82 rillig 1868: <p>
1.88 wiz 1869: If a package depends on many other packages (such as
1.93 rillig 1870: <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 1871: alternate between periods of
1872: downloading source, and compiling. To ensure you have all the source
1873: downloaded initially you can run the command:
1874: </p>
1.82 rillig 1875: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1876: <p>
1.88 wiz 1877: which will output and run a set of shell commands to fetch the
1878: necessary files into the <code class="filename">distfiles</code> directory. You can
1879: also choose to download the files manually.
1880: </p>
1.75 rillig 1881: </div>
1.128 wiz 1882: <div class="sect2" title="4.2.3. How to build and install">
1.75 rillig 1883: <div class="titlepage"><div><div><h3 class="title">
1884: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1885: <p>
1.88 wiz 1886: Once the software has downloaded, any patches will be applied, then it
1887: will be compiled for you. This may take some time depending on your
1888: computer, and how many other packages the software depends on and their
1889: compile time.
1890: </p>
1.128 wiz 1891: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1892: <h3 class="title">Note</h3>
1893: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1894: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1895: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1896: </div>
1.87 wiz 1897: <p>For example, type</p>
1.88 wiz 1898: <pre class="screen">
1899: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1900: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1901: </pre>
1.75 rillig 1902: <p>at the shell prompt to build the various components of the
1.88 wiz 1903: package.</p>
1.82 rillig 1904: <p>The next stage is to actually install the newly compiled
1.88 wiz 1905: program onto your system. Do this by entering:
1.82 rillig 1906:
1.88 wiz 1907: </p>
1.82 rillig 1908: <pre class="screen">
1.88 wiz 1909: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1910: </pre>
1.82 rillig 1911: <p>
1912:
1.88 wiz 1913: while you are still in the directory for whatever package you
1914: are installing.</p>
1.82 rillig 1915: <p>Installing the package on your system may require you to
1.88 wiz 1916: be root. However, pkgsrc has a
1917: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1918: to only become root for the actual installation step.</p>
1.82 rillig 1919: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1920: You can now enter:
1.82 rillig 1921:
1.88 wiz 1922: </p>
1.82 rillig 1923: <pre class="screen">
1.88 wiz 1924: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1925: </pre>
1.82 rillig 1926: <p>
1927:
1.88 wiz 1928: to remove the compiled files in the work directory, as you shouldn't need
1929: them any more. If other packages were also added to your system
1930: (dependencies) to allow your program to compile, you can tidy these up
1931: also with the command:</p>
1.82 rillig 1932: <pre class="screen">
1.88 wiz 1933: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1934: </pre>
1.75 rillig 1935: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 1936: 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 1937: <p>The program is installed under the default root of the
1938: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1939: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1940: variable in your environment, and it will use that value as the
1941: root of your packages tree. So, to use
1942: <code class="filename">/usr/local</code>, set
1943: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1944: Please note that you should use a directory which is dedicated to
1945: packages and not shared with other programs (i.e., do not try and
1946: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1947: to add any of your own files or directories (such as
1948: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1949: <code class="filename">pkgsrc/</code>) below the
1950: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1951: conflicts between programs and other files installed by the
1952: package system and whatever else may have been installed
1953: there.</p>
1.110 hubertf 1954: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1955: alter some configuration options at build time. Have a look at
1956: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1957: of what will be set there by default. Environment variables such
1958: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1959: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1960: set them each time you want to use pkgsrc.</p>
1.128 wiz 1961: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1962: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1963: or being installed. This may be for debugging purposes, or out of
1964: simple curiosity. A number of utility values have been added to
1965: help with this.</p>
1.128 wiz 1966: <div class="orderedlist"><ol class="orderedlist" type="1">
1967: <li class="listitem">
1.110 hubertf 1968: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 1969: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1970: information will be displayed. For example,</p>
1.75 rillig 1971: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1972: <p>will show all the commands that are invoked, up to and
1.128 wiz 1973: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1974: </li>
1.128 wiz 1975: <li class="listitem">
1.110 hubertf 1976: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1977: definition, then the <code class="varname">VARNAME</code> definition
1978: should be used, in conjunction with the show-var
1.110 hubertf 1979: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1980: variable <code class="varname">LOCALBASE</code>:</p>
1981: <pre class="screen">
1982: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1983: /usr/pkg
1984: <code class="prompt">%</code>
1.88 wiz 1985: </pre>
1.75 rillig 1986: </li>
1987: </ol></div>
1988: <p>If you want to install a binary package that you've either
1.88 wiz 1989: created yourself (see next section), that you put into
1990: pkgsrc/packages manually or that is located on a remote FTP
1991: server, you can use the "bin-install" target. This target will
1.110 hubertf 1992: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1993: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1994: sites searched is kept in the variable
1995: <code class="varname">BINPKG_SITES</code>, which defaults to
1.110 hubertf 1996: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 1997: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1998: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1999: details.</p>
2000: <p>A final word of warning: If you set up a system that has a
2001: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2002: set that before any packages are installed, as you cannot use
2003: several directories for the same purpose. Doing so will result in
2004: pkgsrc not being able to properly detect your installed packages,
2005: and fail miserably. Note also that precompiled binary packages are
2006: usually built with the default <code class="varname">LOCALBASE</code> of
2007: <code class="filename">/usr/pkg</code>, and that you should
2008: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2009: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2010: </div>
2011: </div>
2012: </div>
1.128 wiz 2013: <div class="chapter" title="Chapter 5. Configuring pkgsrc">
1.75 rillig 2014: <div class="titlepage"><div><div><h2 class="title">
2015: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2016: <div class="toc">
2017: <p><b>Table of Contents</b></p>
2018: <dl>
2019: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2020: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2021: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2022: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2023: <dd><dl>
1.103 wiz 2024: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 2025: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2026: <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 2027: </dl></dd>
1.103 wiz 2028: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2029: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2030: </dl>
2031: </div>
1.104 rillig 2032: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2033: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2034: that file depends on the installation. On NetBSD, when you use
1.110 hubertf 2035: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89 rillig 2036: <code class="filename">/etc/</code>. In all other cases the default location is
2037: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2038: bootstrap program to install the binary packages.</p>
2039: <p>During the bootstrap, an example configuration file is created. To
2040: use that, you have to create the directory
2041: <code class="filename">${PREFIX}/etc</code> and copy the example file
2042: there.</p>
2043: <p>The format of the configuration file is that of the usual
2044: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2045: is done by setting variables in this file. Note that you can define all
2046: kinds of variables, and no special error checking (for example for
2047: spelling mistakes) takes place, so you have to try it out to see if it
2048: works.</p>
1.128 wiz 2049: <div class="sect1" title="5.1. General configuration">
1.75 rillig 2050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2051: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2052: <p>In this section, you can find some variables that apply to all
1.89 rillig 2053: pkgsrc packages. A complete list of the variables that can be
2054: configured by the user is available in
2055: <code class="filename">mk/defaults/mk.conf</code>, together with some
2056: comments that describe each variable's intent.</p>
1.128 wiz 2057: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2058: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2059: packages will be installed. The default is
1.76 rillig 2060: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2061: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 2062: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2063: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 2064: installed. The default is
1.76 rillig 2065: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 2066: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2067: X11 is installed on the system. The default is
1.76 rillig 2068: <code class="filename">/usr/X11R6</code>.</p></li>
1.128 wiz 2069: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2070: downloaded copies of the original source distributions used
2071: for building pkgsrc packages. The default is
1.76 rillig 2072: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 2073: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2074: database about installed packages is stored. The default is
2075: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 wiz 2076: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2077: If set, override the packages'
2078: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 2079: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2080: Backup location(s) for distribution files and patch files
2081: if not found locally or in
1.76 rillig 2082: <code class="filename">${MASTER_SITES}</code> or
2083: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2084: The defaults are
1.76 rillig 2085: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2086: and
1.76 rillig 2087: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 2088: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2089: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2090: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 2091: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2092: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2093: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2094: List of acceptable licenses. License names are case-sensitive.
2095: Whenever you try to build a package whose license is not in this
2096: list, you will get an error message. If the license condition is
2097: simple enough, the error message will include specific
2098: instructions on how to change this variable.</p></li>
1.75 rillig 2099: </ul></div>
2100: </div>
1.128 wiz 2101: <div class="sect1" title="5.2. Variables affecting the build process">
1.75 rillig 2102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2103: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2104: <p>XXX
2105: </p>
1.128 wiz 2106: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2107: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2108: directory for the binary packages. The default is
1.76 rillig 2109: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 2110: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2111: The top level directory where, if defined, the separate
2112: working directories will get created, and symbolically
1.76 rillig 2113: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2114: This is useful for building packages on several
1.76 rillig 2115: architectures, then <code class="filename">${PKGSRCDIR}</code>
2116: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2117: is local to every architecture. (It should be noted that
2118: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2119: — it is an internal definition which refers to the
1.75 rillig 2120: root of the pkgsrc tree. It is possible to have many
2121: pkgsrc tree instances.)</p></li>
1.128 wiz 2122: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2123: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2124: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2125: information.</p></li>
1.128 wiz 2126: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2127: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2128: BSD-style Makefile. If this is not set,
2129: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2130: <code class="filename">/dev/null</code> to avoid picking up
2131: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 wiz 2132: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2133: By default, dependencies are only installed, and no binary
2134: package is created for them. You can set this variable to
2135: <code class="literal">package</code> to automatically create binary
2136: packages after installing dependencies.</p></li>
1.75 rillig 2137: </ul></div>
2138: </div>
1.128 wiz 2139: <div class="sect1" title="5.3. Variables affecting the installation process">
1.75 rillig 2140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2141: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103 wiz 2142: <p>A growing number of packages support installation into a
2143: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2144: to be built, before the actual filesystem is touched. DESTDIR
2145: support exists in two variations:</p>
1.128 wiz 2146: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2147: <li class="listitem"><p>Basic DESTDIR support means that the package
1.103 wiz 2148: installation and packaging is still run as
2149: root.</p></li>
1.128 wiz 2150: <li class="listitem"><p>Full DESTDIR support can run the complete build,
1.103 wiz 2151: installation and packaging as normal user. Root privileges are
2152: only needed to add packages.</p></li>
2153: </ul></div>
1.123 snj 2154: <p>To use the DESTDIR support, set
2155: <code class="varname">USE_DESTDIR=yes</code> to get the full support for packages
2156: that support it and with fallback to basic support. </p>
1.103 wiz 2157: <p>DESTDIR support changes the behaviour of various targets
2158: slightly. To install a package after building it, use
2159: <code class="literal">package-install</code>. <code class="literal">package</code> and
2160: <code class="literal">install</code> don't do that any
2161: longer. <code class="literal">package-install</code> can be used as
2162: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2163: will ask for the root password to install the package and fail,
2164: <code class="literal">package-install</code> will ask again.</p>
2165: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2166: clean</code></strong> needs to be run as root.</p>
1.118 imil 2167: <p>Considering the <code class="filename">foo/bar</code> package,
2168: DESTDIR full support can be tested using the following commands
2169:
2170: </p>
2171: <pre class="programlisting">
2172: <code class="prompt">$</code> id
2173: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2174: <code class="prompt">$</code> mkdir $HOME/packages
2175: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2176: </pre>
2177: <p>
2178:
2179: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2180: should be needed
2181:
2182: </p>
2183: <pre class="programlisting">
1.123 snj 2184: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.118 imil 2185: </pre>
2186: <p>
2187:
2188: Create a package without root privileges
2189:
2190: </p>
2191: <pre class="programlisting">
1.123 snj 2192: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.118 imil 2193: </pre>
2194: <p>
2195:
2196: For the following command, you must be able to gain root
2197: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
2198:
2199: </p>
2200: <pre class="programlisting">
1.123 snj 2201: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.118 imil 2202: </pre>
2203: <p>
2204:
2205: Then, as a simple user
2206:
2207: </p>
2208: <pre class="programlisting">
2209: <code class="prompt">$</code> make clean
2210: </pre>
2211: <p>
2212:
2213: </p>
1.103 wiz 2214: </div>
1.128 wiz 2215: <div class="sect1" title="5.4. Selecting and configuring the compiler">
1.103 wiz 2216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2217: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.128 wiz 2218: <div class="sect2" title="5.4.1. Selecting the compiler">
1.78 rillig 2219: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2220: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2221: <p>By default, pkgsrc will use GCC to build packages. This may be
2222: overridden by setting the following variables in /etc/mk.conf:</p>
2223: <div class="variablelist"><dl>
2224: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2225: <dd>
2226: <p>This is a list of values specifying the chain of
2227: compilers to invoke when building packages. Valid values
2228: are:</p>
1.128 wiz 2229: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2230: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2231: distributed C/C++ (chainable)</p></li>
1.128 wiz 2232: <li class="listitem"><p><code class="varname">ccache</code>:
1.89 rillig 2233: compiler cache (chainable)</p></li>
1.128 wiz 2234: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2235: GNU C/C++ Compiler</p></li>
1.128 wiz 2236: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2237: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.128 wiz 2238: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2239: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 2240: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2241: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2242: </ul></div>
2243: <p>The default is
1.128 wiz 2244: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 2245: <code class="varname">ccache</code> and/or
2246: <code class="varname">distcc</code> with an appropriate
2247: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 2248: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2249: variable should always be terminated with a value for
2250: a real compiler. Note that only one real compiler
1.128 wiz 2251: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2252: is not allowed).</p>
1.89 rillig 2253: </dd>
2254: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2255: <dd><p>This specifies the minimum version of GCC to use
2256: when building packages. If the system GCC doesn't
2257: satisfy this requirement, then pkgsrc will build and
2258: install one of the GCC packages to use instead.</p></dd>
2259: </dl></div>
2260: </div>
1.128 wiz 2261: <div class="sect2" title="5.4.2. Additional flags to the compiler (CFLAGS)">
1.89 rillig 2262: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2263: <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 2264: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2265: please make sure to use the <code class="literal">+=</code> operator
2266: instead of the <code class="literal">=</code> operator:</p>
2267: <pre class="programlisting">
1.100 rillig 2268: CFLAGS+= -your -flags
1.78 rillig 2269: </pre>
2270: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2271: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2272: need to add their own flags. You may want to take a look
2273: 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 2274: package if you're interested in optimization specifically
2275: for the current CPU. </p>
1.78 rillig 2276: </div>
1.128 wiz 2277: <div class="sect2" title="5.4.3. Additional flags to the linker (LDFLAGS)">
1.88 wiz 2278: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2279: <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 2280: <p>If you want to pass flags to the linker, both in the configure
2281: step and the build step, you can do this in two ways. Either set
2282: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2283: between the two is that <code class="varname">LIBS</code> will be appended to
2284: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2285: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2286: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2287: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2288: <code class="varname">CFLAGS</code>, if you do not wish to override these
2289: settings, use the <code class="literal">+=</code> operator:</p>
2290: <pre class="programlisting">
1.100 rillig 2291: LDFLAGS+= -your -linkerflags
1.88 wiz 2292: </pre>
2293: </div>
1.78 rillig 2294: </div>
1.128 wiz 2295: <div class="sect1" title="5.5. Developer/advanced settings">
1.78 rillig 2296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2297: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2298: <p>XXX
2299: </p>
1.128 wiz 2300: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2301: <li class="listitem">
1.75 rillig 2302: <p><code class="varname">PKG_DEVELOPER</code>:
2303: Run some sanity checks that package developers want:
2304: </p>
1.128 wiz 2305: <div class="itemizedlist"><ul class="itemizedlist" type="circle">
2306: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2307: fuzz</p></li>
1.128 wiz 2308: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2309: binaries will find their shared libs.</p></li>
1.75 rillig 2310: </ul></div>
2311: <p>
1.87 wiz 2312: </p>
1.75 rillig 2313: </li>
1.128 wiz 2314: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 2315: of debugging output which is displayed whilst making and
2316: installing the package. The default value for this is 0,
2317: which will not display the commands as they are executed
2318: (normal, default, quiet operation); the value 1 will display
2319: all shell commands before their invocation, and the value 2
2320: will display both the shell commands before their invocation,
1.110 hubertf 2321: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2322: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2323: </ul></div>
2324: <p>
2325: </p>
2326: </div>
1.128 wiz 2327: <div class="sect1" title="5.6. Selecting Build Options">
1.75 rillig 2328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2329: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2330: <p>Some packages have build time options, usually to select
2331: between different dependencies, enable optional support for big
2332: dependencies or enable experimental features.</p>
1.75 rillig 2333: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2334: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2335: show-options</strong></span>, for example:</p>
1.75 rillig 2336: <pre class="programlisting">
2337: The following options are supported by this package:
2338: ssl Enable SSL support.
2339: Exactly one of the following gecko options is required:
2340: firefox Use firefox as gecko rendering engine.
2341: mozilla Use mozilla as gecko rendering engine.
2342: At most one of the following database options may be selected:
2343: mysql Enable support for MySQL database.
2344: pgsql Enable support for PostgreSQL database.
1.1 grant 2345:
1.75 rillig 2346: These options are enabled by default: firefox
2347: These options are currently enabled: mozilla ssl
1.1 grant 2348: </pre>
1.75 rillig 2349: <p>The following variables can be defined in
1.110 hubertf 2350: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2351: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2352: which can be used to select or disable options for all packages
2353: that support them, and
2354: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2355: which can be used to select or disable options specifically for
2356: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2357: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2358: are disabled. A few examples:</p>
1.75 rillig 2359: <pre class="screen">
1.110 hubertf 2360: <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 2361: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2362: PKG_OPTIONS.kdebase= debug -sasl
2363: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2364: <p>It is important to note that options that were specifically
1.120 snj 2365: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2366: you do not wish to include the option. If you are unsure you can view
2367: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2368: <p>The following settings are consulted in the order given, and
2369: the last setting that selects or disables an option is
2370: used:</p>
1.128 wiz 2371: <div class="orderedlist"><ol class="orderedlist" type="1">
2372: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2373: maintainer</p></li>
1.128 wiz 2374: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2375: variables (see below)</p></li>
1.128 wiz 2376: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2377: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2378: </ol></div>
2379: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2380: selected is used, all others are automatically disabled. If an
2381: option of the group is explicitly disabled, the previously
2382: selected option, if any, is used. It is an error if no option
2383: from a required group of options is selected, and building the
2384: package will fail.</p>
2385: <p>Before the options framework was introduced, build options
2386: were selected by setting a variable (often named
2387: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2388: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2389: transition to the options framework for the user, these legacy
2390: variables are converted to the appropriate options setting
2391: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2392: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2393: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2394: directly. Support for the legacy variables will be removed
2395: eventually.</p>
1.75 rillig 2396: </div>
2397: </div>
1.128 wiz 2398: <div class="chapter" title="Chapter 6. Creating binary packages">
1.75 rillig 2399: <div class="titlepage"><div><div><h2 class="title">
2400: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2401: <div class="toc">
2402: <p><b>Table of Contents</b></p>
2403: <dl>
2404: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2405: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2406: </dl>
2407: </div>
1.128 wiz 2408: <div class="sect1" title="6.1. Building a single binary package">
1.75 rillig 2409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2410: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2411: <p>Once you have built and installed a package, you can create
2412: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110 hubertf 2413: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 2414: the same package on a group of hosts and wasting CPU time. It also
2415: provides a simple means for others to install your package, should
2416: you distribute it.</p>
2417: <p>To create a binary package, change into the appropriate
1.110 hubertf 2418: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2419: package</strong></span>:</p>
2420: <pre class="screen">
2421: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2422: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2423: </pre>
2424: <p>This will build and install your package (if not already done),
2425: and then build a binary package from what was installed. You can
1.110 hubertf 2426: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2427: it. Binary packages are created by default in
2428: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2429: 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 2430: 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 2431: <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 2432: such a binary package.</p>
1.75 rillig 2433: </div>
1.128 wiz 2434: <div class="sect1" title="6.2. Settings for creation of binary packages">
1.75 rillig 2435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2436: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2437: <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 2438: </div>
2439: </div>
1.128 wiz 2440: <div class="chapter" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">
1.106 rillig 2441: <div class="titlepage"><div><div><h2 class="title">
2442: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2443: builds)</h2></div></div></div>
2444: <div class="toc">
2445: <p><b>Table of Contents</b></p>
2446: <dl>
2447: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2448: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2449: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2450: <dd><dl>
2451: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2452: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2453: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2454: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2455: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2456: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2457: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2458: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2459: </dl></dd>
2460: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 2461: <dd><dl>
2462: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2463: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2464: </dl></dd>
1.106 rillig 2465: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2466: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2467: </dl>
2468: </div>
2469: <p>When you have multiple machines that should run the same packages,
2470: it is wasted time if they all build their packages themselves from
2471: source. There are two ways of getting a set of binary packages: The old
2472: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2473: system. This chapter describes how to set them up so that the packages
2474: are most likely to be usable later.</p>
1.128 wiz 2475: <div class="sect1" title="7.1. Think first, build later">
1.106 rillig 2476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2477: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2478: <p>Since a bulk build takes several days or even weeks to finish, you
2479: should think about the setup before you start everything. Pay attention
2480: to at least the following points:</p>
1.128 wiz 2481: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2482: <li class="listitem">
1.106 rillig 2483: <p>If you want to upload the binary packages to
2484: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2485: packages:</p>
1.128 wiz 2486: <div class="itemizedlist"><ul class="itemizedlist" type="circle">
2487: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.106 rillig 2488: by a NetBSD developer on a trusted machine (that is, where you and only
2489: you have root access).</p></li>
1.128 wiz 2490: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.124 snj 2491: the stable branches (like 2009Q1), so that users browsing the available
1.106 rillig 2492: collections can see at a glance how old the packages
2493: are.</p></li>
1.128 wiz 2494: <li class="listitem"><p>The packages must be built as root, since some packages
1.106 rillig 2495: require set-uid binaries at runtime, and creating those packages as
2496: unprivileged user doesn't work well at the moment.</p></li>
2497: </ul></div>
2498: </li>
1.128 wiz 2499: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.106 rillig 2500: your system. Most bulk builds run as root, so they should be run at least
2501: in a chroot environment or something even more restrictive, depending on
2502: what the operating system provides. There have been numerous cases where
2503: certain packages tried to install files outside the
2504: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2505: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2506: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2507: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2508: that you don't need any package during the build.</p></li>
2509: </ul></div>
2510: </div>
1.128 wiz 2511: <div class="sect1" title="7.2. Requirements of a bulk build">
1.106 rillig 2512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2513: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2514: <p>A complete bulk build requires lots of disk space. Some of the
2515: disk space can be read-only, some other must be writable. Some can be on
2516: remote filesystems (such as NFS) and some should be local. Some can be
2517: temporary filesystems, others must survive a sudden reboot.</p>
1.128 wiz 2518: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2519: <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2520: <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2521: <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2522: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2523: <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2524: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.106 rillig 2525: </ul></div>
1.75 rillig 2526: </div>
1.128 wiz 2527: <div class="sect1" title="7.3. Running an old-style bulk build">
1.75 rillig 2528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2529: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.128 wiz 2530: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.116 rillig 2531: <h3 class="title">Note</h3>
2532: <p>There are two ways of doing a bulk build. The old-style
1.128 wiz 2533: one and the new-style <span class="quote">“<span class="quote">pbulk</span>”</span>. The latter is the recommended
1.116 rillig 2534: way.</p>
1.106 rillig 2535: </div>
1.128 wiz 2536: <div class="sect2" title="7.3.1. Configuration">
1.75 rillig 2537: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2538: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.128 wiz 2539: <div class="sect3" title="7.3.1.1. build.conf">
1.75 rillig 2540: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2541: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93 rillig 2542: </h4></div></div></div>
1.76 rillig 2543: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2544: configuration file for bulk builds. You can configure how your
2545: copy of pkgsrc is kept up to date, how the distfiles are
2546: downloaded, how the packages are built and how the report is
2547: generated. You can find an annotated example file in
2548: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2549: it, copy <code class="filename">build.conf-example</code> to
2550: <code class="filename">build.conf</code> and edit it, following the
2551: comments in that file.</p>
1.75 rillig 2552: </div>
1.128 wiz 2553: <div class="sect3" title="7.3.1.2. mk.conf">
1.75 rillig 2554: <div class="titlepage"><div><div><h4 class="title">
1.110 hubertf 2555: <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 2556: </h4></div></div></div>
1.110 hubertf 2557: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87 wiz 2558: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2559: details of the default settings. You will want to ensure that
2560: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.125 wiz 2561: As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.104 rillig 2562: completely bypasses the license check.</p>
1.87 wiz 2563: <pre class="programlisting">
1.100 rillig 2564: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2565: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2566: BSDSRCDIR= /usr/src
2567: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2568: OBJHOSTNAME?= yes # use work.`hostname`
2569: FAILOVER_FETCH= yes # insist on the correct checksum
2570: PKG_DEVELOPER?= yes
1.125 wiz 2571: SKIP_LICENSE_CHECK= yes
1.100 rillig 2572: </pre>
1.75 rillig 2573: <p>Some options that are especially useful for bulk builds
2574: can be found at the top lines of the file
1.76 rillig 2575: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2576: options of these are briefly described here.</p>
1.128 wiz 2577: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2578: <li class="listitem"><p>If you are on a slow machine, you may want to
1.87 wiz 2579: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.128 wiz 2580: <span class="quote">“<span class="quote">no</span>”</span>.</p></li>
2581: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.87 wiz 2582: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2583: to the directory where all log files are created. Otherwise the
2584: log files are created in the pkgsrc directory.</p></li>
1.128 wiz 2585: <li class="listitem"><p>Another important variable is
1.87 wiz 2586: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2587: should be always available while building other
2588: packages.</p></li>
1.75 rillig 2589: </ul></div>
2590: <p>Some other options are scattered in the pkgsrc
2591: infrastructure:</p>
1.128 wiz 2592: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2593: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2594: should be set to <code class="literal">yes</code>. The purpose of the
2595: bulk builds is creating binary packages, no matter if they
2596: are vulnerable or not. Leaving this variable unset would
2597: prevent the bulk build system from even trying to build
2598: them, so possible building errors would not show
2599: up.</p></li>
2600: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2601: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.128 wiz 2602: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed set of files
1.87 wiz 2603: matches the <code class="filename">PLIST</code>.</p></li>
1.128 wiz 2604: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2605: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.128 wiz 2606: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed
2607: <span class="quote">“<span class="quote">#!</span>”</span>-scripts will find their
1.87 wiz 2608: interpreter.</p></li>
1.128 wiz 2609: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2610: set to <span class="quote">“<span class="quote"><code class="literal">yes</code></span>”</span> to run each
1.91 rillig 2611: package's self-test before installing it. Note that some
1.128 wiz 2612: packages make heavy use of <span class="quote">“<span class="quote">good</span>”</span> random
1.91 rillig 2613: numbers, so you need to assure that the machine on which you
2614: are doing the bulk builds is not completely idle. Otherwise
2615: some test programs will seem to hang, while they are just
2616: waiting for new random data to be
2617: available.</p></li>
1.75 rillig 2618: </ul></div>
2619: </div>
1.128 wiz 2620: <div class="sect3" title="7.3.1.3. pre-build.local">
1.75 rillig 2621: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2622: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93 rillig 2623: </h4></div></div></div>
1.75 rillig 2624: <p>It is possible to configure the bulk build to perform
1.87 wiz 2625: certain site-specific tasks at the end of the pre-build
2626: stage. If the file
2627: <code class="filename">pre-build.local</code> exists in
2628: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110 hubertf 2629: (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.87 wiz 2630: stage. An example use of
2631: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2632: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2633: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2634: <p>to prevent the system from trying to build a particular package
1.87 wiz 2635: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2636: </div>
2637: </div>
1.128 wiz 2638: <div class="sect2" title="7.3.2. Other environmental considerations">
1.75 rillig 2639: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2640: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2641: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2642: deleted at the start of bulk builds, make sure your login
2643: shell is placed somewhere else. Either drop it into
2644: <code class="filename">/usr/local/bin</code> (and adjust your login
2645: shell in the passwd file), or (re-)install it via
1.110 hubertf 2646: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.87 wiz 2647: you can login after a reboot (remember that your current
2648: process won't die if the package is removed, you just can't
2649: start any new instances of the shell any more). Also, if you
2650: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2651: version of ssh for some reason, be sure to install ssh before
2652: starting it from <code class="filename">rc.local</code>:</p>
2653: <pre class="programlisting">
1.100 rillig 2654: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2655: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2656: /usr/pkg/etc/rc.d/sshd
2657: fi
2658: </pre>
1.75 rillig 2659: <p>Not doing so will result in you being not able to log in
1.87 wiz 2660: via ssh after the bulk build is finished or if the machine
2661: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2662: </div>
1.128 wiz 2663: <div class="sect2" title="7.3.3. Operation">
1.75 rillig 2664: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2665: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75 rillig 2666: <p>Make sure you don't need any of the packages still
1.87 wiz 2667: installed.</p>
1.128 wiz 2668: <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 2669: <h3 class="title">Warning</h3>
1.99 rillig 2670: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2671: configuration files and some more files from
2672: <code class="filename">/var</code>, <code class="filename">/home</code> and
2673: possibly other locations will be removed! So don't run a bulk
2674: build with privileges that might harm your
2675: system.</em></span></p>
1.75 rillig 2676: </div>
2677: <p>Be sure to remove all other things that might
1.87 wiz 2678: interfere with builds, like some libs installed in
2679: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2680: <pre class="screen">
2681: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2682: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2683: </pre>
1.75 rillig 2684: <p>If for some reason your last build didn't complete (power
1.87 wiz 2685: failure, system panic, ...), you can continue it by
2686: running:</p>
1.75 rillig 2687: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2688: <p>At the end of the bulk build, you will get a summary via mail,
2689: and find build logs in the directory specified by
2690: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2691: file.</p>
1.75 rillig 2692: </div>
1.128 wiz 2693: <div class="sect2" title="7.3.4. What it does">
1.75 rillig 2694: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2695: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75 rillig 2696: <p>The bulk builds consist of three steps:</p>
2697: <div class="variablelist"><dl>
2698: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2699: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2700: cleans out any broken distfiles, and removes all
2701: packages installed.</p></dd>
1.75 rillig 2702: <dt><span class="term">2. the bulk build</span></dt>
1.128 wiz 2703: <dd><p>This is basically <span class="quote">“<span class="quote">make bulk-package</span>”</span> with
1.87 wiz 2704: an optimised order in which packages will be
2705: built. Packages that don't require other packages will
2706: be built first, and packages with many dependencies will
2707: be built later.</p></dd>
1.75 rillig 2708: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2709: <dd><p>Generates a report that's placed in the directory
2710: specified in the <code class="filename">build.conf</code> file
2711: named <code class="filename">broken.html</code>, a short version
2712: of that report will also be mailed to the build's
2713: admin.</p></dd>
1.75 rillig 2714: </dl></div>
1.87 wiz 2715: <p>During the build, a list of broken packages will be compiled
2716: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2717: <code class="filename">.../.broken.${MACHINE}</code> if
2718: <code class="varname">OBJMACHINE</code> is set), individual build logs
2719: of broken builds can be found in the package's
2720: directory. These files are used by the bulk-targets to mark
2721: broken builds to not waste time trying to rebuild them, and
2722: they can be used to debug these broken package builds
2723: later.</p>
1.75 rillig 2724: </div>
1.128 wiz 2725: <div class="sect2" title="7.3.5. Disk space requirements">
1.75 rillig 2726: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2727: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75 rillig 2728: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2729: NetBSD 2.0/i386:</p>
1.128 wiz 2730: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2731: <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
2732: <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
2733: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.87 wiz 2734: </ul></div>
2735: <p>Note that all pkgs will be de-installed as soon as they are
2736: turned into a binary package, and that sources are removed,
2737: so there is no excessively huge demand to disk
2738: space. Afterwards, if the package is needed again, it will
1.110 hubertf 2739: be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.87 wiz 2740: there are no cycles wasted by recompiling.</p>
1.75 rillig 2741: </div>
1.128 wiz 2742: <div class="sect2" title="7.3.6. Setting up a sandbox for chrooted builds">
1.75 rillig 2743: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2744: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2745: <p>If you don't want all the packages nuked from a machine
2746: (rendering it useless for anything but pkg compiling), there
2747: is the possibility of doing the package bulk build inside a
2748: chroot environment.</p>
2749: <p>The first step is to set up a chroot sandbox,
2750: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2751: using null mounts, or manually.</p>
2752: <p>There is a shell script called
2753: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2754: up the sandbox environment using null mounts. It will also
2755: create a script called <code class="filename">sandbox</code> in the
2756: root of the sandbox environment, which will allow the null
1.110 hubertf 2757: mounts to be activated using the <span class="command"><strong>sandbox
1.87 wiz 2758: mount</strong></span> command and deactivated using the
1.110 hubertf 2759: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87 wiz 2760: <p>To set up a sandbox environment by hand, after extracting all
1.110 hubertf 2761: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87 wiz 2762: distribution DESTDIR=/usr/sandbox</strong></span> in
2763: <code class="filename">/usr/src/etc</code>, be sure the following items
2764: are present and properly configured:</p>
1.128 wiz 2765: <div class="procedure"><ol class="procedure" type="1">
2766: <li class="step" title="Step 1">
1.75 rillig 2767: <p>Kernel</p>
2768: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2769: </li>
1.128 wiz 2770: <li class="step" title="Step 2">
1.76 rillig 2771: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2772: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2773: </li>
1.128 wiz 2774: <li class="step" title="Step 3">
1.91 rillig 2775: <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 2776: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2777: </li>
1.128 wiz 2778: <li class="step" title="Step 4">
1.75 rillig 2779: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2780: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2781: </li>
1.128 wiz 2782: <li class="step" title="Step 5">
1.91 rillig 2783: <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 2784: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2785: </li>
1.128 wiz 2786: <li class="step" title="Step 6">
1.76 rillig 2787: <p><code class="filename">/usr/src</code> (system sources,
1.126 jakllsch 2788: 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 2789: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2790: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2791: </li>
1.128 wiz 2792: <li class="step" title="Step 7">
1.76 rillig 2793: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2794: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2795: </li>
1.128 wiz 2796: <li class="step" title="Step 8">
1.76 rillig 2797: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2798: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2799: </li>
1.128 wiz 2800: <li class="step" title="Step 9">
1.75 rillig 2801: <p>Checkout pkgsrc via cvs into
1.87 wiz 2802: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2803: <pre class="screen">
2804: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2805: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2806: </pre>
1.75 rillig 2807: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2808: you do development in, as this will likely cause problems!</p>
1.75 rillig 2809: </li>
1.128 wiz 2810: <li class="step" title="Step 10"><p>Make
1.87 wiz 2811: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2812: <code class="filename">.../distfiles</code> point somewhere
2813: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.128 wiz 2814: <li class="step" title="Step 11"><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>
2815: <li class="step" title="Step 12"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2816: </ol></div>
2817: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2818: the build with the following steps:</p>
2819: <pre class="screen">
2820: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2821: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2822: </pre>
2823: <p>This will just jump inside the sandbox and start building. At
2824: the end of the build, mail will be sent with the results of
2825: the build. Created binary pkgs will be in
2826: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2827: (wherever that points/mounts to/from).</p>
1.75 rillig 2828: </div>
1.128 wiz 2829: <div class="sect2" title="7.3.7. Building a partial set of packages">
1.75 rillig 2830: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2831: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2832: <p>In addition to building a complete set of all packages in
2833: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2834: may be used to build a subset of the packages contained in
2835: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.110 hubertf 2836: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.128 wiz 2837: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2838: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
2839: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
2840: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
2841: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.75 rillig 2842: </ul></div>
1.87 wiz 2843: <p>will define the set of packages which should be built.
2844: The bulk build code will also include any packages which are
2845: needed as dependencies for the explicitly listed packages.</p>
2846: <p>One use of this is to do a bulk build with
2847: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2848: periodically to have a complete set of the binary packages
2849: needed for your site available without the overhead of
2850: building extra packages that are not needed.</p>
1.75 rillig 2851: </div>
1.128 wiz 2852: <div class="sect2" title="7.3.8. Uploading results of a bulk build">
1.75 rillig 2853: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2854: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2855: <p>This section describes how pkgsrc developers can upload binary
2856: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2857: <p>If you would like to automatically create checksum files for the
2858: binary packages you intend to upload, remember to set
2859: <code class="varname">MKSUMS=yes</code> in your
2860: <code class="filename">mk/bulk/build.conf</code>.</p>
2861: <p>If you would like to PGP sign the checksum files (highly
2862: recommended!), remember to set
2863: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2864: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2865: your GPG password to sign the files before uploading everything.</p>
2866: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2867: set properly in your <code class="filename">mk/bulk/build.conf</code>
2868: file, i.e. adjust it to something like one of the following:</p>
1.126 jakllsch 2869: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload </pre>
2870: <p>Please use appropriate values for "packages-20xxQy",
1.87 wiz 2871: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2872: is different from your local login, write your login directly
2873: into the variable, e.g. my local account is "feyrer", but for my
2874: login "hubertf", I use:</p>
1.126 jakllsch 2875: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 2876: <p>A separate <code class="filename">upload</code> directory is used
2877: here to allow "closing" the directory during upload. To do
2878: so, run the following command on ftp.NetBSD.org next:</p>
1.126 jakllsch 2879: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87 wiz 2880: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2881: only appropriate for packages for the NetBSD operating
2882: system. Binary packages for other operating systems should go
2883: into <code class="filename">/pub/pkgsrc</code>.</p>
2884: <p>Before uploading the binary pkgs, ssh authentication needs
2885: to be set up. This example shows how to set up temporary keys
2886: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2887: (assuming that no keys should be present there usually):</p>
2888: <pre class="screen">
2889: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 2890: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2891: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 2892: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
2893: </pre>
2894: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
2895: append it to your <code class="filename">~/.ssh/authorized_keys</code>
2896: file on ftp.NetBSD.org. You can remove the key after the
2897: upload is done!</p>
2898: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 2899: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 2900: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2901: <p>Now after all this works, you can exit the sandbox and start
2902: the upload:</p>
2903: <pre class="screen">
2904: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 2905: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 2906: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2907: </pre>
1.110 hubertf 2908: <p>The upload process may take quite some time. Use <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
2909: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.87 wiz 2910: upload. The upload script will take care of not uploading
1.127 spz 2911: restricted packages.</p>
1.128 wiz 2912: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 2913: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 2914: Gdd:x! </pre>
2915: <p>Use whatever is needed to remove the key you've entered
2916: before! Last, move the uploaded packages out of the
2917: <code class="filename">upload</code> directory to have them accessible
2918: to everyone:</p>
2919: <pre class="screen">
1.126 jakllsch 2920: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 2921: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2922: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 2923: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
2924: </pre>
1.75 rillig 2925: </div>
2926: </div>
1.128 wiz 2927: <div class="sect1" title="7.4. Running a pbulk-style bulk build">
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.128 wiz 2931: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
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.128 wiz 2935: <div class="sect2" title="7.4.1. Preparation">
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.128 wiz 2945: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
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.128 wiz 2960: <div class="sect2" title="7.4.2. Configuration">
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.128 wiz 2967: <div class="sect1" title="7.5. Creating a multiple CD-ROM packages collection">
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.128 wiz 2978: <div class="sect2" title="7.5.1. Example of cdpack">
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.128 wiz 3013: <div class="chapter" title="Chapter 8. Directory layout of the installed files">
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.128 wiz 3050: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
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.128 wiz 3067: <div class="sect1" title="8.1. File system layout in ${LOCALBASE}">
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.90 rillig 3073: <div class="variablelist"><dl>
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.128 wiz 3133: <div class="sect1" title="8.2. File system layout in ${VARBASE}">
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.90 rillig 3137: <div class="variablelist"><dl>
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.128 wiz 3154: <div class="chapter" title="Chapter 9. Frequently Asked Questions">
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.128 wiz 3183: <div class="sect1" title="9.1. Are there any mailing lists for pkg-related discussion?">
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.128 wiz 3187: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
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.128 wiz 3214: <div class="sect1" title="9.2. Where's the pkgviews documentation?">
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.128 wiz 3221: <div class="sect1" title="9.3. Utilities for package management (pkgtools)">
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.128 wiz 3230: <div class="itemizedlist"><ul class="itemizedlist" 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.128 wiz 3233: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
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.128 wiz 3246: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
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.128 wiz 3263: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
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.128 wiz 3280: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
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.128 wiz 3292: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
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.128 wiz 3299: <div class="sect1" title="9.4. How to use pkgsrc as non-root">
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.128 wiz 3320: <div class="sect1" title="9.5. How to resume transfers when fetching distfiles?">
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.110 hubertf 3329: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.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.128 wiz 3344: <div class="sect1" title="9.6. How can I install/use modular X.org from pkgsrc?">
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.128 wiz 3354: <div class="note" title="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.128 wiz 3360: <div class="sect1" title="9.7. How to fetch files from behind a firewall">
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.128 wiz 3375: <div class="sect1" title="9.8. How do I tell make fetch to do passive FTP?">
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.128 wiz 3381: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
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.128 wiz 3395: <div class="sect1" title="9.9. How to fetch all distfiles at once">
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
3400: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75 rillig 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.110 hubertf 3405: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 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.128 wiz 3427: <div class="sect1" title="9.10. What does “Don't know how to make /usr/share/tmac/tmac.andoc” mean?">
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.128 wiz 3441: <div class="sect1" title="9.11. What does “Could not find bsd.own.mk” mean?">
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.128 wiz 3453: <div class="sect1" title="9.12. Using 'sudo' with pkgsrc">
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.110 hubertf 3457: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75 rillig 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.128 wiz 3471: <div class="sect1" title="9.13. How do I change the location of configuration files?">
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.128 wiz 3493: <div class="sect1" title="9.14. Automated security checks">
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
3508: is kept up to date by the NetBSD security officer and the NetBSD
3509: packages team, and is distributed from the NetBSD ftp server:</p>
1.110 hubertf 3510: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities</a></p>
1.75 rillig 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.128 wiz 3526: <div class="sect1" title="9.15. Why do some packages ignore my CFLAGS?">
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.110 hubertf 3533: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 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.128 wiz 3548: <div class="sect1" title="9.16. A package does not build. What shall I do?">
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">
3552: <li class="step" title="Step 1"><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.128 wiz 3558: <li class="step" title="Step 2"><p>Make sure that you don't have any CVS conflicts.
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.128 wiz 3562: <li class="step" title="Step 3"><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.128 wiz 3565: <li class="step" title="Step 4"><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.128 wiz 3569: <div class="sect1" title="9.17. What does “Makefile appears to contain unresolved cvs/rcs/??? merge conflicts” mean?">
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.128 wiz 3584: <div class="part" title="Part II. The pkgsrc developer's guide">
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.128 wiz 3587: <div class="partintro" title="The pkgsrc developer's guide">
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.128 wiz 3660: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3661: </dl></dd>
1.128 wiz 3662: <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 3663: <dd><dl>
1.128 wiz 3664: <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 3665: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3666: </dl></dd>
3667: </dl></dd>
3668: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3669: <dd><dl>
3670: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3671: <dd><dl>
3672: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3673: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3674: </dl></dd>
3675: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3676: <dd><dl>
1.128 wiz 3677: <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 3678: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3679: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3680: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3681: </dl></dd>
3682: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3683: <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>
3684: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3685: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3686: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3687: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3688: <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>
3689: </dl></dd>
3690: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3691: <dd><dl>
3692: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 3693: <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 3694: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3695: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3696: </dl></dd>
3697: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3698: <dd><dl>
3699: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3700: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3701: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3702: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 3703: <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 3704: <dd><dl>
3705: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3706: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3707: </dl></dd>
1.128 wiz 3708: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3709: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3710: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3711: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3712: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3713: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3714: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3715: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3716: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3717: <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 3718: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3719: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3720: </dl></dd>
3721: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3722: <dd><dl>
3723: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3724: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3725: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3726: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3727: </dl></dd>
3728: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3729: <dd><dl>
3730: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3731: <dd><dl>
3732: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 3733: <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 3734: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3735: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3736: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3737: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3738: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3739: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3740: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3741: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3742: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3743: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3744: </dl></dd>
1.128 wiz 3745: <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 3746: <dd><dl>
3747: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3748: <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>
3749: </dl></dd>
1.128 wiz 3750: <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 3751: <dd><dl>
3752: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3753: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3754: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3755: </dl></dd>
3756: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3757: <dd><dl>
3758: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3759: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3760: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3761: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3762: </dl></dd>
1.128 wiz 3763: <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 3764: <dd><dl>
3765: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3766: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 3767: <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 3768: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3769: </dl></dd>
1.128 wiz 3770: <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 3771: <dd><dl>
3772: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3773: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3774: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3775: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3776: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3777: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3778: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3779: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3780: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3781: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3782: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3783: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3784: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3785: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3786: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3787: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3788: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3789: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3790: emulation</a></span></dt>
1.106 rillig 3791: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3792: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3793: </dl></dd>
1.106 rillig 3794: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3795: </dl></dd>
1.106 rillig 3796: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3797: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3798: <dd><dl>
1.106 rillig 3799: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3800: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3801: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3802: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3803: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3804: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3805: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3806: </dl></dd>
3807: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3808: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3809: <dd><dl>
3810: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3811: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3812: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3813: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3814: </dl></dd>
1.75 rillig 3815: </dl>
3816: </div>
1.77 rillig 3817: </div>
1.128 wiz 3818: <div class="chapter" title="Chapter 10. Creating a new pkgsrc package from scratch">
1.77 rillig 3819: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3820: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3821: <div class="toc">
3822: <p><b>Table of Contents</b></p>
3823: <dl>
1.106 rillig 3824: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3825: <dd><dl>
1.106 rillig 3826: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3827: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3828: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3829: </dl></dd>
1.106 rillig 3830: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3831: <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 3832: </dl>
3833: </div>
1.77 rillig 3834: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3835: most likely have a URL from where you can download the source
3836: code. Starting with this URL, creating a package involves only a
3837: few steps.</p>
1.128 wiz 3838: <div class="procedure"><ol class="procedure" type="1">
3839: <li class="step" title="Step 1"><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>
3840: <li class="step" title="Step 2"><p>Then, choose one of the top-level directories as the
1.91 rillig 3841: category in which you want to place your package. You can also create a
3842: directory of your own (maybe called <code class="filename">local</code>). In that
3843: category directory, create another directory for your package and change
3844: into it.</p></li>
1.128 wiz 3845: <li class="step" title="Step 3"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3846: you for a URL. Enter the URL of the distribution file (in most cases a
3847: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3848: of your package are created automatically. The distribution file is
3849: extracted automatically to fill in some details in the
3850: <code class="filename">Makefile</code> that would otherwise have to be done
3851: manually.</p></li>
1.128 wiz 3852: <li class="step" title="Step 4">
1.91 rillig 3853: <p>Examine the extracted files to determine the dependencies of
3854: your package. Ideally, this is mentioned in some
3855: <code class="filename">README</code> file, but things may differ. For each of
3856: these dependencies, look where it exists in pkgsrc, and if there is a
3857: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3858: line to your package <code class="filename">Makefile</code> which includes that
3859: file just before the last line. If the
3860: <code class="filename">buildlink3.mk</code> file does not exist, add a
3861: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3862: version of the dependency and where it can be found in pkgsrc. This line
3863: should be placed in the third paragraph. If the dependency is only
3864: needed for building the package, but not when using it, use
3865: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3866: Your package may then look like this:</p>
1.77 rillig 3867: <pre class="programlisting">
1.100 rillig 3868: [...]
1.77 rillig 3869:
1.100 rillig 3870: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3871: DEPENDS+= screen-[0-9]*:../../misc/screen
3872: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3873:
1.100 rillig 3874: [...]
1.77 rillig 3875:
1.100 rillig 3876: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3877: .include "../../devel/glib2/buildlink3.mk"
3878: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3879: </pre>
3880: </li>
1.128 wiz 3881: <li class="step" title="Step 5"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
3882: 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 3883: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3884: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3885: -e</strong></span>, which outputs additional
3886: explanations.</p></li>
1.128 wiz 3887: <li class="step" title="Step 6"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3888: 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 3889: over there, you can hopefully continue here.</p></li>
1.128 wiz 3890: <li class="step" title="Step 7"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3891: directory from the extracted files. Besides these files, a lot of cache
3892: files and other system information has been saved in the working
3893: directory, which may become wrong after you edited the
3894: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 3895: <li class="step" title="Step 8"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 3896: 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.128 wiz 3897: <li class="step" title="Step 9"><p>When the package builds fine, the next step is to install
1.110 hubertf 3898: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3899: everything works.</p></li>
1.128 wiz 3900: <li class="step" title="Step 10"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3901: contains a list of the files that are installed by the package, is
1.110 hubertf 3902: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3903: >PLIST</strong></span> to generate a probably correct list. Check
3904: the file using your preferred text editor to see if the list of
3905: files looks plausible.</p></li>
1.128 wiz 3906: <li class="step" title="Step 11"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3907: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.128 wiz 3908: <li class="step" title="Step 12"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3909: has been registered in the database of installed files, but with an
1.110 hubertf 3910: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3911: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3912: registered with the list of files from
3913: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 3914: <li class="step" title="Step 13"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3915: package from the set of installed files.</p></li>
1.77 rillig 3916: </ol></div>
1.128 wiz 3917: <div class="sect1" title="10.1. Common types of packages">
1.91 rillig 3918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3919: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.128 wiz 3920: <div class="sect2" title="10.1.1. Perl modules">
1.91 rillig 3921: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3922: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3923: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3924: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3925: </div>
1.128 wiz 3926: <div class="sect2" title="10.1.2. KDE applications">
1.91 rillig 3927: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3928: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91 rillig 3929: <p>KDE applications should always include
3930: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3931: settings that are typical of KDE packages.</p>
3932: </div>
1.128 wiz 3933: <div class="sect2" title="10.1.3. Python modules and programs">
1.118 imil 3934: <div class="titlepage"><div><div><h3 class="title">
3935: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3936: <p>Python modules and programs packages are easily created using a
3937: set of predefined variables.</p>
1.128 wiz 3938: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3939: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3940: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, set the
3941: <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">“<span class="quote">yes</span>”</span> so
1.118 imil 3942: pkgsrc will make use of this framework.
1.128 wiz 3943: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3944: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
1.118 imil 3945: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3946: to the name of the script.</p>
3947: <p>
3948: If the default Python versions are not supported by the software, set the
3949: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
3950: the software is known to work with, from the most recent to the older
3951: one, e.g.
3952: </p>
3953: <pre class="programlisting">
1.126 jakllsch 3954: PYTHON_VERSIONS_ACCEPTED= 25 24
1.118 imil 3955: </pre>
3956: <p>
3957: If the packaged software is a Python module, include
1.128 wiz 3958: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 3959: In this case, the package directory should be called
1.128 wiz 3960: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3961: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3962: </p>
3963: <pre class="programlisting">
3964: DISTNAME= foopymodule-1.2.10
3965: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3966: </pre>
3967: <p>If it is an application, also include
1.128 wiz 3968: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>
3969: before <span class="quote">“<span class="quote">extension.mk</span>”</span>.</p>
1.118 imil 3970: <p>If the packaged software, either it is an application or a module, is
3971: egg-aware, you only need to include
1.128 wiz 3972: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
1.118 imil 3973: <p>In order to correctly set the path to the Python interpreter, use the
3974: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
3975: that must be corrected. For example :
3976: </p>
3977: <pre class="programlisting">
3978: REPLACE_PYTHON= ${WRKSRC}/*.py
3979: </pre>
3980: </div>
1.91 rillig 3981: </div>
1.128 wiz 3982: <div class="sect1" title="10.2. Examples">
1.91 rillig 3983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3984: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.128 wiz 3985: <div class="sect2" title="10.2.1. How the www/nvu package came into pkgsrc">
1.91 rillig 3986: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3987: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.128 wiz 3988: <div class="sect3" title="10.2.1.1. The initial package">
1.91 rillig 3989: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3990: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3991: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3992: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3993: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3994: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3995: <pre class="programlisting">
1.100 rillig 3996: <code class="prompt">$</code> mkdir www/nvu
3997: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3998: </pre>
3999: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 4000: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 4001: <pre class="programlisting">
1.100 rillig 4002: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 4003: </pre>
4004: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4005: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 4006: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 4007: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4008: <code class="varname">COMMENT</code> fields. Then the package
4009: <code class="filename">Makefile</code> looked like that:</p>
4010: <pre class="programlisting">
1.100 rillig 4011: # $NetBSD$
4012: #
1.91 rillig 4013:
1.100 rillig 4014: DISTNAME= nvu-1.0-sources
4015: PKGNAME= nvu-1.0
4016: CATEGORIES= www
4017: MASTER_SITES= http://cvs.nvu.com/download/
4018: EXTRACT_SUFX= .tar.bz2
4019:
4020: MAINTAINER= rillig@NetBSD.org
4021: HOMEPAGE= http://cvs.nvu.com/
4022: COMMENT= Web Authoring System
1.91 rillig 4023:
1.100 rillig 4024: # url2pkg-marker (please do not remove this line.)
4025: .include "../../mk/bsd.pkg.mk"
1.91 rillig 4026: </pre>
4027: <p>Then, I quit the editor and watched pkgsrc downloading a large
4028: source archive:</p>
4029: <pre class="programlisting">
1.100 rillig 4030: url2pkg> Running "make makesum" ...
4031: => Required installed package digest>=20010302: digest-20060826 found
4032: => Fetching nvu-1.0-sources.tar.bz2
4033: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4034: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4035: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4036: url2pkg> Running "make extract" ...
4037: => Required installed package digest>=20010302: digest-20060826 found
4038: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4039: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4040: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4041: ===> Installing dependencies for nvu-1.0
4042: ===> Overriding tools for nvu-1.0
4043: ===> Extracting for nvu-1.0
4044: url2pkg> Adjusting the Makefile.
1.91 rillig 4045:
1.100 rillig 4046: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 4047:
1.100 rillig 4048: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 4049: </pre>
4050: </div>
1.128 wiz 4051: <div class="sect3" title="10.2.1.2. Fixing all kinds of problems to make the package work">
1.91 rillig 4052: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4053: <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 4054: <p>Now that the package has been extracted, let's see what's inside
4055: it. The package has a <code class="filename">README.txt</code>, but that only
4056: says something about mozilla, so it's probably useless for seeing what
4057: dependencies this package has. But since there is a GNU configure script
4058: in the package, let's hope that it will complain about everything it
4059: needs.</p>
4060: <pre class="programlisting">
1.100 rillig 4061: <code class="prompt">$</code> bmake
4062: => Required installed package digest>=20010302: digest-20060826 found
4063: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4064: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4065: ===> Patching for nvu-1.0
4066: ===> Creating toolchain wrappers for nvu-1.0
4067: ===> Configuring for nvu-1.0
4068: [...]
4069: configure: error: Perl 5.004 or higher is required.
4070: [...]
4071: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4072: [...]
1.91 rillig 4073: </pre>
4074: <p>That worked quite well. So I opened the package Makefile in my
4075: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 4076: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 4077: package have changed now, and since a perl wrapper is automatically
1.128 wiz 4078: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 4079: from scratch.</p>
4080: <pre class="programlisting">
1.100 rillig 4081: <code class="prompt">$</code> bmake clean
4082: ===> Cleaning for nvu-1.0
4083: <code class="prompt">$</code> bmake
4084: [...]
4085: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4086: GNU Make. You will not be able to build Mozilla without GNU Make.
4087: [...]
1.91 rillig 4088: </pre>
1.128 wiz 4089: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 4090: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4091: <pre class="programlisting">
1.100 rillig 4092: [...]
4093: checking for GTK - version >= 1.2.0... no
4094: *** Could not run GTK test program, checking why...
4095: [...]
1.91 rillig 4096: </pre>
4097: <p>Now to the other dependencies. The first question is: Where is the
4098: GTK package hidden in pkgsrc?</p>
4099: <pre class="programlisting">
1.100 rillig 4100: <code class="prompt">$</code> echo ../../*/gtk*
4101: [many packages ...]
4102: <code class="prompt">$</code> echo ../../*/gtk
4103: ../../x11/gtk
4104: <code class="prompt">$</code> echo ../../*/gtk2
4105: ../../x11/gtk2
4106: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4107: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4108: </pre>
4109: <p>The first try was definitely too broad. The second one had exactly
4110: one result, which is very good. But there is one pitfall with GNOME
4111: packages. Before GNOME 2 had been released, there were already many
4112: GNOME 1 packages in pkgsrc. To be able to continue to use these
4113: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 4114: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 4115: whether this was the case here, and indeed it was.</p>
4116: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4117: file, adding the dependency is very easy. I just inserted an
4118: <code class="literal">.include</code> line before the last line of the package
4119: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4120: <pre class="programlisting">
1.100 rillig 4121: [...]
4122: .include "../../x11/gtk2/buildlink3.mk"
4123: .include "../../mk/bsd.pkg.mk
1.91 rillig 4124: </pre>
1.110 hubertf 4125: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 4126: was:</p>
4127: <pre class="programlisting">
1.100 rillig 4128: [...]
4129: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4130: checking for GTK - version >= 1.2.0... no
4131: *** Could not run GTK test program, checking why...
4132: *** The test program failed to compile or link. See the file config.log for the
4133: *** exact error that occured. This usually means GTK was incorrectly installed
4134: *** or that you have moved GTK since it was installed. In the latter case, you
4135: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4136: configure: error: Test for GTK failed.
4137: [...]
1.91 rillig 4138: </pre>
1.128 wiz 4139: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
4140: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 4141: told me that this package really wanted to have the GNOME 1 version of
4142: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 4143: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 4144: So I changed the <code class="literal">x11/gtk2</code> to
4145: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4146: and tried again.</p>
4147: <pre class="programlisting">
1.100 rillig 4148: [...]
4149: 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
4150: In file included from xpidl.c:42:
4151: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4152: In file included from xpidl.c:42:
4153: xpidl.h:132: error: parse error before "IDL_ns"
4154: [...]
1.91 rillig 4155: </pre>
4156: <p>The package still does not find all of its dependencies. Now the
4157: question is: Which package provides the
4158: <code class="filename">libIDL/IDL.h</code> header file?</p>
4159: <pre class="programlisting">
1.100 rillig 4160: <code class="prompt">$</code> echo ../../*/*idl*
4161: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4162: <code class="prompt">$</code> echo ../../*/*IDL*
4163: ../../net/libIDL
1.91 rillig 4164: </pre>
4165: <p>Let's take the one from the second try. So I included the
4166: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4167: again. But the error didn't change. After digging through some of the
4168: code, I concluded that the build process of the package was broken and
4169: couldn't have ever worked, but since the Mozilla source tree is quite
4170: large, I didn't want to fix it. So I added the following to the package
4171: <code class="filename">Makefile</code> and tried again:</p>
4172: <pre class="programlisting">
1.100 rillig 4173: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4174: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4175: </pre>
4176: <p>The latter line is needed because the package expects the library
4177: <code class="filename">libIDL.so</code>, but only
4178: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4179: wrapper to rewrite that on the fly.</p>
4180: <p>The next problem was related to a recent change of the FreeType
4181: 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>
4182: which patch files were relevant for this issue and copied them to the
4183: <code class="filename">patches</code> directory. Then I retried, fixed the
4184: patches so that they applied cleanly and retried again. This time,
4185: everything worked.</p>
4186: </div>
1.128 wiz 4187: <div class="sect3" title="10.2.1.3. Installing the package">
1.91 rillig 4188: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4189: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 4190: <pre class="programlisting">
1.100 rillig 4191: <code class="prompt">$</code> bmake CHECK_FILES=no install
4192: [...]
4193: <code class="prompt">$</code> bmake print-PLIST >PLIST
4194: <code class="prompt">$</code> bmake deinstall
4195: <code class="prompt">$</code> bmake install
1.91 rillig 4196: </pre>
4197: </div>
4198: </div>
4199: </div>
1.77 rillig 4200: </div>
1.128 wiz 4201: <div class="chapter" title="Chapter 11. Package components - files, directories and contents">
1.75 rillig 4202: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4203: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4204: <div class="toc">
4205: <p><b>Table of Contents</b></p>
4206: <dl>
1.128 wiz 4207: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4208: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 4209: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4210: <dd><dl>
4211: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4212: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4213: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4214: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4215: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4216: </dl></dd>
4217: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4218: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4219: <dd><dl>
4220: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4221: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4222: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4223: </dl></dd>
1.128 wiz 4224: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4225: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4226: </dl>
4227: </div>
1.87 wiz 4228: <p>Whenever you're preparing a package, there are a number of
4229: files involved which are described in the following
4230: sections.</p>
1.128 wiz 4231: <div class="sect1" title="11.1. Makefile">
1.75 rillig 4232: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4233: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 4234: </h2></div></div></div>
1.75 rillig 4235: <p>Building, installation and creation of a binary package are all
1.87 wiz 4236: controlled by the package's <code class="filename">Makefile</code>.
4237: The <code class="filename">Makefile</code> describes various things about
4238: a package, for example from where to get it, how to configure,
4239: build, and install it.</p>
1.76 rillig 4240: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4241: sections that describe the package.</p>
1.75 rillig 4242: <p>In the first section there are the following variables, which
1.87 wiz 4243: should appear exactly in the order given here. The order and
4244: grouping of the variables is mostly historical and has no further
4245: meaning.</p>
1.128 wiz 4246: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4247: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4248: distribution file to be downloaded from the package's
4249: website.</p></li>
1.128 wiz 4250: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4251: package, as used by pkgsrc. You only need to provide it if
4252: <code class="varname">DISTNAME</code> (which is the default) is not a good
4253: name for the package in pkgsrc. Usually it is the pkgsrc
4254: directory name together with the version number. It must match the
4255: regular expression
4256: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4257: starts with a letter or digit, and contains only letters, digits,
4258: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 4259: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.87 wiz 4260: the package file to create if the <code class="varname">PKGNAME</code>
4261: isn't unique on a SVR4 system. The default is
4262: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4263: <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 4264: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4265: does not produce an unique package name on a SVR4 system.
4266: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4267: characters.</p></li>
1.128 wiz 4268: <li class="listitem">
1.75 rillig 4269: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4270: which the package fits in. You can choose any of the top-level
4271: directories of pkgsrc for it.</p>
1.75 rillig 4272: <p>Currently the following values are available for
1.87 wiz 4273: <code class="varname">CATEGORIES</code>. If more than
4274: one is used, they need to be separated by spaces:</p>
1.75 rillig 4275: <pre class="programlisting">
1.100 rillig 4276: archivers cross geography meta-pkgs security
4277: audio databases graphics misc shells
4278: benchmarks devel ham multimedia sysutils
4279: biology editors inputmethod net textproc
4280: cad emulators lang news time
4281: chat finance mail parallel wm
4282: comms fonts math pkgtools www
4283: converters games mbone print x11
4284: </pre>
1.75 rillig 4285: </li>
1.128 wiz 4286: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4287: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4288: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4289: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 4290: <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 4291: </ul></div>
4292: <p>The second section contains information about separately
1.87 wiz 4293: downloaded patches, if any.
4294: </p>
1.128 wiz 4295: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4296: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4297: Name(s) of additional files that contain distribution patches.
4298: There is no default. pkgsrc will look for them at
4299: <code class="varname">PATCH_SITES</code>.
4300: They will automatically be uncompressed before patching if
4301: the names end with <code class="filename">.gz</code> or
4302: <code class="filename">.Z</code>.</p></li>
1.128 wiz 4303: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4304: Primary location(s) for distribution patch files (see
4305: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4306: </ul></div>
4307: <p>The third section contains the following variables.
1.87 wiz 4308: </p>
1.128 wiz 4309: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4310: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4311: address of the person who feels responsible for this package,
4312: and who is most likely to look at problems or questions regarding
4313: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
4314: Other developers may contact the <code class="varname">MAINTAINER</code>
4315: before making changes to the package, but are not required to
4316: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4317: to yourself. If you really can't maintain the package for future
4318: updates, set it to
1.110 hubertf 4319: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 4320: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4321: of <code class="varname">MAINTAINER</code> when you do not want other
4322: developers to update or change the package without contacting
4323: you first. A package Makefile should contain one of
4324: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4325: not both. </p></li>
1.128 wiz 4326: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4327: find more information about the package.</p></li>
1.128 wiz 4328: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4329: description of the package (should not include the package
4330: name).</p></li>
1.75 rillig 4331: </ul></div>
4332: <p>Other variables that affect the build:
1.87 wiz 4333: </p>
1.128 wiz 4334: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
1.75 rillig 4335: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4336: interesting distribution files of the package are found. The
4337: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4338: works for most packages.</p>
1.75 rillig 4339: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4340: (most GNU software does, for instance), but extracts itself in
4341: the current directory, you should set
4342: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4343: <p>If a package doesn't create a subdirectory with the
4344: name of <code class="varname">DISTNAME</code> but some different name,
4345: set <code class="varname">WRKSRC</code> to point to the proper name in
4346: <code class="filename">${WRKDIR}</code>, for example
4347: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4348: <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 4349: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4350: taken from the <code class="varname">WRKDIR_BASENAME</code>
4351: variable. By default, its value is
4352: <code class="filename">work</code>. If you want to use the same
4353: pkgsrc tree for building different kinds of binary packages,
4354: you can change the variable according to your needs. Two
4355: other variables handle common cases of setting
4356: <code class="varname">WRKDIR_BASENAME</code> individually. If
4357: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4358: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4359: the host's name is attached to the directory name. If
4360: <code class="varname">OBJMACHINE</code> is defined, the platform name
4361: is attached, which might look like
4362: <code class="filename">work.i386</code> or
4363: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4364: </li></ul></div>
4365: <p>Please pay attention to the following gotchas:</p>
1.128 wiz 4366: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4367: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4368: installed in compressed form by the package. For packages using
4369: BSD-style makefiles which honor MANZ, there is
4370: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 4371: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4372: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4373: below).</p></li>
1.128 wiz 4374: <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 4375: </ul></div>
4376: </div>
1.128 wiz 4377: <div class="sect1" title="11.2. distinfo">
1.75 rillig 4378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4379: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4380: </h2></div></div></div>
1.76 rillig 4381: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4382: digest, or checksum, of each distfile needed for the package. This
4383: ensures that the distfiles retrieved from the Internet have not been
4384: corrupted during transfer or altered by a malign force to introduce
4385: a security hole. Due to recent rumor about weaknesses of digest
4386: algorithms, all distfiles are protected using both SHA1 and RMD160
4387: message digests, as well as the file size.</p>
1.76 rillig 4388: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4389: checksums for all the patches found in the
1.110 hubertf 4390: <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 4391: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4392: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4393: command.</p>
1.75 rillig 4394: <p>Some packages have different sets of distfiles depending on
1.128 wiz 4395: 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 4396: <code class="filename">distinfo</code> file and care should be taken when
4397: upgrading such a package to ensure distfile information is not
4398: lost.</p>
1.75 rillig 4399: </div>
1.128 wiz 4400: <div class="sect1" title="11.3. patches/*">
1.75 rillig 4401: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4402: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4403: <p>Many packages still don't work out-of-the box on the various
4404: platforms that are supported by pkgsrc. Therefore, a number of custom
4405: patch files are needed to make the package work. These patch files are
4406: found in the <code class="filename">patches/</code> directory.</p>
4407: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4408: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4409: extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.93 rillig 4410: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4411: <code class="filename">patch-ab</code>, etc.</p>
1.128 wiz 4412: <div class="sect2" title="11.3.1. Structure of a single patch file">
1.93 rillig 4413: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4414: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4415: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4416: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4417: problems. (To force patches to apply with fuzz you can set
4418: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4419: should contain only changes for a single file, and no file should be
1.93 rillig 4420: patched by more than one patch file. This helps to keep future
4421: modifications simple.</p>
4422: <p>Each patch file is structured as follows: In the first line,
4423: there is the RCS Id of the patch itself. The second line should be
4424: empty for aesthetic reasons. After that, there should be a comment for
4425: each change that the patch does. There are a number of standard
4426: cases:</p>
1.128 wiz 4427: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4428: <li class="listitem"><p>Patches that replace the <code class="literal">==</code>
1.110 hubertf 4429: operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.111 rillig 4430: are so common that they don't need a comment at all.</p></li>
1.128 wiz 4431: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4432: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 4433: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4434: platform and other environment (for example, the compiler) that the
4435: patch is needed for.</p></li>
4436: </ul></div>
4437: <p>In all other cases, the patch should be commented so that any
4438: developer who knows the code of the application can make some use of
4439: the patch. Special care should be taken for the upstream developers,
4440: since we generally want that they accept our patches, so we have less
4441: work in the future.</p>
4442: </div>
1.128 wiz 4443: <div class="sect2" title="11.3.2. Creating patch files">
1.93 rillig 4444: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4445: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4446: <p>One important thing to mention is to pay attention that no RCS
4447: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4448: later checked into the NetBSD CVS tree. Use the
1.110 hubertf 4449: <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 4450: problems.</p>
1.87 wiz 4451: <p>For even more automation, we recommend using
1.110 hubertf 4452: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4453: whole set of patches. You just have to backup files before you
4454: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4455: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4456: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4457: you upgrade a package this way, you can easily compare the new
4458: set of patches with the previously existing one with
1.110 hubertf 4459: <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87 wiz 4460: or update from the <code class="filename">work/.newpatches</code>
4461: directory to <code class="filename">patches/</code>.</p>
4462: <p>When you have finished a package, remember to generate
1.110 hubertf 4463: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 4464: 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 4465: <p>When adding a patch that corrects a problem in the
4466: distfile (rather than e.g. enforcing pkgsrc's view of where
4467: man pages should go), send the patch as a bug report to the
4468: maintainer. This benefits non-pkgsrc users of the package,
4469: and usually makes it possible to remove the patch in future
4470: version.</p>
1.101 rillig 4471: <p>The file names of the patch files are usually of the form
4472: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93 rillig 4473: </div>
1.128 wiz 4474: <div class="sect2" title="11.3.3. Sources where the patch files come from">
1.93 rillig 4475: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4476: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4477: <p>If you want to share patches between multiple packages
4478: in pkgsrc, e.g. because they use the same distfiles, set
4479: <code class="varname">PATCHDIR</code> to the path where the patch files
4480: can be found, e.g.:</p>
4481: <pre class="programlisting">
1.100 rillig 4482: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4483: </pre>
1.75 rillig 4484: <p>Patch files that are distributed by the author or other
1.87 wiz 4485: maintainers can be listed in
4486: <code class="varname">PATCHFILES</code>.</p>
4487: <p>If it is desired to store any patches that should not be
4488: committed into pkgsrc, they can be kept outside the pkgsrc
4489: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4490: directory tree there is expected to have the same
1.128 wiz 4491: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4492: patches are expected to be stored inside these dirs (also
4493: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4494: example, if you want to keep a private patch for
4495: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4496: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4497: files in the named directory are expected to be patch files,
4498: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4499: applied</em></span>.</p>
1.93 rillig 4500: </div>
1.128 wiz 4501: <div class="sect2" title="11.3.4. Patching guidelines">
1.85 jmmv 4502: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4503: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4504: <p>When fixing a portability issue in the code do not use
4505: preprocessor magic to check for the current operating system nor
4506: platform. Doing so hurts portability to other platforms because
4507: the OS-specific details are not abstracted appropriately.</p>
4508: <p>The general rule to follow is: instead of checking for the
4509: operating system the application is being built on, check for the
4510: specific <span class="emphasis"><em>features</em></span> you need. For example,
4511: instead of assuming that kqueue is available under NetBSD and
4512: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4513: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4514: yes, this generally involves patching the
1.110 hubertf 4515: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4516: that prevents some OSes from adopting interfaces from other OSes
4517: (e.g. Linux implementing kqueue), something that the above checks
4518: cannot take into account.</p>
4519: <p>Of course, checking for features generally involves more
4520: work on the developer's side, but the resulting changes are
1.87 wiz 4521: cleaner and there are chances they will work on many other
1.85 jmmv 4522: platforms. Not to mention that there are higher chances of being
4523: later integrated into the mainstream sources. Remember:
4524: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4525: <p>Some typical examples:</p>
4526: <div class="table">
1.106 rillig 4527: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4528: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4529: <colgroup>
4530: <col>
4531: <col>
4532: <col>
4533: </colgroup>
4534: <thead><tr>
4535: <th>Where</th>
4536: <th>Incorrect</th>
4537: <th>Correct</th>
4538: </tr></thead>
4539: <tbody>
4540: <tr>
4541: <td>configure script</td>
4542: <td>
1.100 rillig 4543: <pre class="programlisting">
4544: case ${target_os} in
4545: netbsd*) have_kvm=yes ;;
4546: *) have_kvm=no ;;
4547: esac
4548: </pre>
1.85 jmmv 4549: </td>
4550: <td>
1.100 rillig 4551: <pre class="programlisting">
4552: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4553: </pre>
1.85 jmmv 4554: </td>
4555: </tr>
4556: <tr>
4557: <td>C source file</td>
4558: <td>
1.100 rillig 4559: <pre class="programlisting">
4560: #if defined(__NetBSD__)
4561: # include <sys/event.h>
4562: #endif
4563: </pre>
1.85 jmmv 4564: </td>
4565: <td>
1.100 rillig 4566: <pre class="programlisting">
4567: #if defined(HAVE_SYS_EVENT_H)
4568: # include <sys/event.h>
4569: #endif
4570: </pre>
1.85 jmmv 4571: </td>
4572: </tr>
4573: <tr>
4574: <td>C source file</td>
4575: <td>
1.100 rillig 4576: <pre class="programlisting">
4577: int
4578: monitor_file(...)
4579: {
4580: #if defined(__NetBSD__)
4581: int fd = kqueue();
4582: ...
4583: #else
4584: ...
4585: #endif
4586: }
4587: </pre>
1.85 jmmv 4588: </td>
4589: <td>
1.100 rillig 4590: <pre class="programlisting">
4591: int
4592: monitor_file(...)
4593: {
4594: #if defined(HAVE_KQUEUE)
4595: int fd = kqueue();
4596: ...
4597: #else
4598: ...
4599: #endif
4600: }
4601: </pre>
1.85 jmmv 4602: </td>
4603: </tr>
4604: </tbody>
1.91 rillig 4605: </table></div>
1.85 jmmv 4606: </div>
1.91 rillig 4607: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4608: 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
4609: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4610: 2</a>). It summarizes multiple details on how to make
4611: software easier to package; all the suggestions in it were
4612: collected from our experience in pkgsrc work, so they are possibly
4613: helpful when creating patches too.</p>
4614: </div>
1.128 wiz 4615: <div class="sect2" title="11.3.5. Feedback to the author">
1.85 jmmv 4616: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4617: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4618: <p>Always, always, <span class="strong"><strong>always</strong></span>
4619: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4620: improvements you do to a package to the mainstream developers.
4621: This is the only way to get their attention on portability issues
4622: and to ensure that future versions can be built out-of-the box on
4623: NetBSD. Furthermore, any user that gets newer distfiles will get
4624: the fixes straight from the packaged code.</p>
1.93 rillig 4625: <p>This generally involves cleaning up the patches
4626: (because sometimes the patches that are
1.85 jmmv 4627: added to pkgsrc are quick hacks), filling bug reports in the
4628: appropriate trackers for the projects and working with the
4629: mainstream authors to accept your changes. It is
4630: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4631: the packages in pkgsrc are kept simple and thus further changes
4632: can be done without much hassle.</p>
4633: <p>Support the idea of free software!</p>
4634: </div>
1.75 rillig 4635: </div>
1.128 wiz 4636: <div class="sect1" title="11.4. Other mandatory files">
1.75 rillig 4637: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4638: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4639: <div class="variablelist"><dl>
1.76 rillig 4640: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4641: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4642: any credits where they are due. Please bear in mind that others do not
4643: share your sense of humour (or spelling idiosyncrasies), and that others
4644: will read everything that you write here.</p></dd>
1.76 rillig 4645: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4646: <dd><p>This file governs the files that are installed on your
4647: system: all the binaries, manual pages, etc. There are other
4648: directives which may be entered in this file, to control the
4649: creation and deletion of directories, and the location of
1.110 hubertf 4650: 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 4651: information.</p></dd>
1.75 rillig 4652: </dl></div>
4653: </div>
1.128 wiz 4654: <div class="sect1" title="11.5. Optional files">
1.75 rillig 4655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4656: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.128 wiz 4657: <div class="sect2" title="11.5.1. Files affecting the binary package">
1.78 rillig 4658: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4659: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4660: <div class="variablelist"><dl>
1.76 rillig 4661: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110 hubertf 4662: <dd><p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87 wiz 4663: First time after package extraction and before files are
4664: moved in place, the second time after the files to install
4665: are moved in place. This can be used to do any custom
4666: procedures not possible with @exec commands in
1.110 hubertf 4667: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4668: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a>.</p></dd>
1.76 rillig 4669: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4670: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4671: this script's responsibility to clean up any additional messy details
4672: around the package's installation, since all pkg_delete knows is how to
4673: delete the files created in the original distribution.
1.110 hubertf 4674: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4675: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.76 rillig 4676: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4677: <dd>
4678: <p>This file is displayed after installation of the package.
1.87 wiz 4679: Useful for things like legal notices on almost-free
4680: software and hints for updating config files after
4681: installing modules for apache, PHP etc.
4682: Please note that you can modify variables in it easily by using
4683: <code class="varname">MESSAGE_SUBST</code> in the package's
4684: <code class="filename">Makefile</code>:</p>
1.75 rillig 4685: <pre class="programlisting">
1.100 rillig 4686: MESSAGE_SUBST+= SOMEVAR="somevalue"
4687: </pre>
1.128 wiz 4688: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4689: <code class="filename">MESSAGE</code>. By default, substitution is
4690: performed for <code class="varname">PKGNAME</code>,
4691: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4692: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4693: <code class="varname">X11BASE</code>,
4694: <code class="varname">PKG_SYSCONFDIR</code>,
4695: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4696: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4697: <p>You can display a different or additional files by
4698: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4699: default is <code class="filename">MESSAGE</code>, if the file
4700: exists.</p>
1.75 rillig 4701: </dd>
1.78 rillig 4702: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4703: <dd><p>FIXME: There is no documentation on the
4704: alternatives framework.</p></dd>
4705: </dl></div>
4706: </div>
1.128 wiz 4707: <div class="sect2" title="11.5.2. Files affecting the build process">
1.78 rillig 4708: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4709: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4710: <div class="variablelist"><dl>
4711: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4712: <dd><p>This file contains arbitrary things that could
4713: also go into a <code class="filename">Makefile</code>, but its purpose is
4714: to be used by more than one package. This file should only be
4715: used when the packages that will use the file are known in
4716: advance. For other purposes it is often better to write a
4717: <code class="filename">*.mk</code> file and give it a good name that
4718: describes what it does.</p></dd>
4719: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4720: <dd><p>This file contains the dependency information
1.110 hubertf 4721: 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 4722: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4723: <dd><p>This file contains workarounds for compiler bugs
4724: and similar things. It is included automatically by the pkgsrc
4725: infrastructure, so you don't need an extra
4726: <code class="literal">.include</code> line for
4727: it.</p></dd>
4728: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4729: <dd><p>This file contains the code for the
1.110 hubertf 4730: 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 4731: selected by the user. If a package has only one or two options,
4732: it is equally acceptable to put the code directly into the
4733: <code class="filename">Makefile</code>.</p></dd>
4734: </dl></div>
4735: </div>
1.128 wiz 4736: <div class="sect2" title="11.5.3. Files affecting nothing at all">
1.78 rillig 4737: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4738: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4739: <div class="variablelist"><dl>
4740: <dt><span class="term"><code class="filename">README*</code></span></dt>
4741: <dd><p>These files do not take place in the creation of
4742: a package and thus are purely informative to the package
4743: developer.</p></dd>
4744: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4745: <dd><p>This file contains things that need to be done
4746: to make the package even
4747: better.</p></dd>
1.75 rillig 4748: </dl></div>
4749: </div>
1.78 rillig 4750: </div>
1.128 wiz 4751: <div class="sect1" title="11.6. work*">
1.75 rillig 4752: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4753: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4754: </h2></div></div></div>
1.110 hubertf 4755: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4756: unpacked into the directory denoted by
4757: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4758: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4759: directory is also used to keep various timestamp files.
4760: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4761: The default is <code class="filename">${.CURDIR}/work</code>
4762: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4763: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4764: </div>
1.128 wiz 4765: <div class="sect1" title="11.7. files/*">
1.75 rillig 4766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4767: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4768: </h2></div></div></div>
1.75 rillig 4769: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4770: to configuration or building, you could place these files here and use
1.110 hubertf 4771: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4772: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4773: this. Alternatively, you could simply diff the file against
4774: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4775: the creation of this file.</p>
4776: <p>If you want to share files in this way with other
4777: packages, set the <code class="varname">FILESDIR</code> variable to point
4778: to the other package's <code class="filename">files</code> directory,
4779: e.g.:</p>
4780: <pre class="programlisting">
1.100 rillig 4781: FILESDIR=${.CURDIR}/../xemacs/files
4782: </pre>
1.75 rillig 4783: </div>
4784: </div>
1.128 wiz 4785: <div class="chapter" title="Chapter 12. Programming in Makefiles">
1.75 rillig 4786: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4787: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4788: <div class="toc">
4789: <p><b>Table of Contents</b></p>
4790: <dl>
1.106 rillig 4791: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4792: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4793: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4794: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4795: <dd><dl>
4796: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4797: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4798: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4799: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4800: <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 4801: </dl></dd>
4802: </dl>
4803: </div>
1.76 rillig 4804: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4805: each of which forms a well-defined part of the pkgsrc system. Using
1.110 hubertf 4806: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75 rillig 4807: like pkgsrc requires some discipline to keep the code correct and
4808: understandable.</p>
1.76 rillig 4809: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4810: programming are variables (which are actually macros) and shell
4811: commands. Among these shell commands may even be more complex ones
1.110 hubertf 4812: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75 rillig 4813: as intended it is necessary to quote all variables correctly when they
4814: are used.</p>
4815: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4816: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4817: with them.</p>
1.128 wiz 4818: <div class="sect1" title="12.1. Caveats">
1.75 rillig 4819: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4820: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.128 wiz 4821: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
1.97 rillig 4822: <p>When you are creating a file as a
4823: target of a rule, always write the data to a temporary file first
4824: and finally rename that file. Otherwise there might occur an error
4825: in the middle of generating the file, and when the user runs
1.110 hubertf 4826: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97 rillig 4827: regenerated properly. Example:</p>
4828: <pre class="programlisting">
1.100 rillig 4829: wrong:
4830: @echo "line 1" > ${.TARGET}
4831: @echo "line 2" >> ${.TARGET}
4832: @false
4833:
4834: correct:
4835: @echo "line 1" > ${.TARGET}.tmp
4836: @echo "line 2" >> ${.TARGET}.tmp
4837: @false
4838: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4839: </pre>
1.110 hubertf 4840: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4841: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4842: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4843: correct</strong></span> gives an error message twice, as expected.</p>
1.110 hubertf 4844: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97 rillig 4845: <code class="literal">${.TARGET}</code> in case of error, but this only
4846: happens when it is interrupted, for example by pressing
4847: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110 hubertf 4848: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97 rillig 4849: </li></ul></div>
4850: </div>
1.128 wiz 4851: <div class="sect1" title="12.2. Makefile variables">
1.97 rillig 4852: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4853: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4854: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4855: can be processed using the five operators ``='', ``+='', ``?='',
1.110 hubertf 4856: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75 rillig 4857: page.</p>
4858: <p>When a variable's value is parsed from a
1.76 rillig 4859: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4860: backslash character ``\'' are handled specially. If a backslash is
4861: followed by a newline, any whitespace immediately in front of the
4862: backslash, the backslash, the newline, and any whitespace
4863: immediately behind the newline are replaced with a single space. A
4864: backslash character and an immediately following hash character are
4865: replaced with a single hash character. Otherwise, the backslash is
4866: passed as is. In a variable assignment, any hash character that is
4867: not preceded by a backslash starts a comment that continues upto the
4868: end of the logical line.</p>
4869: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4870: the only way to create a variable consisting of a single backslash
4871: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4872: <p>So far for defining variables. The other thing you can do with
4873: variables is evaluating them. A variable is evaluated when it is
4874: part of the right side of the ``:='' or the ``!='' operator, or
4875: directly before executing a shell command which the variable is part
1.110 hubertf 4876: of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75 rillig 4877: is, variables are not evaluated until there's no other way. The
4878: ``modifiers'' mentioned in the man page also evaluate the
4879: variable.</p>
4880: <p>Some of the modifiers split the string into words and then
4881: operate on the words, others operate on the string as a whole. When
4882: a string is split into words, it is split as you would expect
1.110 hubertf 4883: it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.126 jakllsch 4884: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4885: loop does not follow the shell quoting rules but splits at sequences
4886: of whitespace.</p>
4887: <p>There are several types of variables that should be handled
4888: differently. Strings and two types of lists.</p>
1.128 wiz 4889: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4890: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4891: characters. Nevertheless, you should restrict yourself to only
4892: using printable characters. Examples are
4893: <code class="varname">PREFIX</code> and
4894: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4895: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4896: are never exported to any shell command. Their elements are
4897: separated by whitespace. Therefore, the elements themselves cannot
4898: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4899: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4900: Examples are <code class="varname">DEPENDS</code> and
4901: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4902: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4903: may be exported to a shell command. Their elements can contain any
4904: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4905: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4906: <code class="varname">DISTFILES</code> and
4907: <code class="varname">MASTER_SITES</code>.</p></li>
4908: </ul></div>
1.128 wiz 4909: <div class="sect2" title="12.2.1. Naming conventions">
1.75 rillig 4910: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4911: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.128 wiz 4912: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4913: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4914: are reserved for use by the pkgsrc infrastructure. They shall
4915: not be used by package
1.76 rillig 4916: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4917: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4918: lowercase variable names for the iteration
4919: variables.</p></li>
1.128 wiz 4920: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4921: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4922: <code class="varname">DISTFILES</code>.</p></li>
4923: </ul></div>
4924: </div>
4925: </div>
1.128 wiz 4926: <div class="sect1" title="12.3. Code snippets">
1.75 rillig 4927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4928: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4929: <p>This section presents you with some code snippets you should
4930: use in your own code. If you don't find anything appropriate here,
4931: you should test your code and add it here.</p>
1.128 wiz 4932: <div class="sect2" title="12.3.1. Adding things to a list">
1.75 rillig 4933: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4934: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4935: <pre class="programlisting">
1.100 rillig 4936: STRING= foo * bar `date`
4937: INT_LIST= # empty
4938: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4939: EXT_LIST= # empty
4940: ANOTHER_EXT_LIST= a=b c=d
4941:
4942: INT_LIST+= ${STRING} # 1
4943: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4944: EXT_LIST+= ${STRING:Q} # 3
4945: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4946: </pre>
1.75 rillig 4947: <p>When you add a string to an external list (example 3), it
4948: must be quoted. In all other cases, you must not add a quoting
4949: level. You must not merge internal and external lists, unless you
4950: are sure that all entries are correctly interpreted in both
4951: lists.</p>
4952: </div>
1.128 wiz 4953: <div class="sect2" title="12.3.2. Converting an internal list into an external list">
1.75 rillig 4954: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4955: <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 4956: <pre class="programlisting">
1.100 rillig 4957: EXT_LIST= # empty
4958: .for i in ${INT_LIST}
4959: EXT_LIST+= ${i:Q}""
4960: .endfor
1.1 grant 4961: </pre>
1.75 rillig 4962: <p>This code converts the internal list
4963: <code class="varname">INT_LIST</code> into the external list
4964: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4965: are unquoted they must be quoted here. The reason for appending
4966: <code class="varname">""</code> is explained below.</p>
4967: </div>
1.128 wiz 4968: <div class="sect2" title="12.3.3. Passing variables to a shell command">
1.75 rillig 4969: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4970: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4971: <p>Sometimes you may want to print an arbitrary string. There
4972: are many ways to get it wrong and only few that can handle every
4973: nastiness.</p>
1.75 rillig 4974: <pre class="programlisting">
1.100 rillig 4975: STRING= foo bar < > * `date` $$HOME ' "
4976: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4977:
1.100 rillig 4978: all:
4979: echo ${STRING} # 1
4980: echo "${STRING}" # 2
4981: echo "${STRING:Q}" # 3
4982: echo ${STRING:Q} # 4
4983: echo x${STRING:Q} | sed 1s,.,, # 5
4984: printf "%s\\n" ${STRING:Q}"" # 6
4985: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4986: </pre>
1.75 rillig 4987: <p>Example 1 leads to a syntax error in the shell, as the
4988: characters are just copied.</p>
4989: <p>Example 2 leads to a syntax error too, and if you leave out
4990: the last " character from <code class="varname">${STRING}</code>,
1.110 hubertf 4991: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75 rillig 4992: variable would be evaluated, too.</p>
4993: <p>Example 3 outputs each space character preceded by a
4994: backslash (or not), depending on the implementation of the
1.110 hubertf 4995: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75 rillig 4996: <p>Example 4 handles correctly every string that does not start
4997: with a dash. In that case, the result depends on the
1.110 hubertf 4998: implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75 rillig 4999: guarantee that your input does not start with a dash, this form is
5000: appropriate.</p>
5001: <p>Example 5 handles even the case of a leading dash
5002: correctly.</p>
1.79 rillig 5003: <p>Example 6 also works with every string and is the
5004: light-weight solution, since it does not involve a pipe, which has
5005: its own problems.</p>
1.75 rillig 5006: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5007: because the quoting has already been done when adding elements to
5008: the list.</p>
5009: <p>As internal lists shall not be passed to the shell, there is
5010: no example for it.</p>
5011: </div>
1.128 wiz 5012: <div class="sect2" title="12.3.4. Quoting guideline">
1.75 rillig 5013: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5014: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 5015: <p>There are many possible sources of wrongly quoted variables.
5016: This section lists some of the commonly known ones.</p>
1.128 wiz 5017: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5018: <li class="listitem">
1.75 rillig 5019: <p>Whenever you use the value of a list, think
5020: about what happens to leading or trailing whitespace. If the
5021: list is a well-formed shell expression, you can apply the
5022: <code class="varname">:M*</code> modifier to strip leading and trailing
5023: whitespace from each word. The <code class="varname">:M</code> operator
5024: first splits its argument according to the rules of the shell,
5025: and then creates a new list consisting of all words that match
5026: the shell glob expression <code class="varname">*</code>, that is: all.
5027: One class of situations where this is needed is when adding a
5028: variable like <code class="varname">CPPFLAGS</code> to
5029: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5030: invokes other configure scripts, it strips the leading and
5031: trailing whitespace from the variable and then passes it to the
5032: other configure scripts. But these configure scripts expect the
5033: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5034: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5035: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5036: here is how we do it:</p>
5037: <pre class="programlisting">
1.100 rillig 5038: CPPFLAGS= # empty
5039: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5040: CPPFLAGS+= ${MY_CPPFLAGS}
5041:
5042: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5043:
5044: all:
5045: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5046: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5047: </pre>
1.75 rillig 5048: </li>
1.128 wiz 5049: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 5050: <code class="varname">${PREFIX}</code> is a properly quoted shell
5051: expression, but there is the C compiler after it, which also
5052: expects a properly quoted string (this time in C syntax). The
5053: version above is therefore only correct if
5054: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5055: or double quotes. If you want to allow these, you have to add
5056: another layer of quoting to each variable that is used as a C
5057: string literal. You cannot use the <code class="varname">:Q</code>
5058: operator for it, as this operator only works for the
5059: shell.</p></li>
1.128 wiz 5060: <li class="listitem">
1.75 rillig 5061: <p>Whenever a variable can be empty, the
5062: <code class="varname">:Q</code> operator can have surprising results. Here
5063: are two completely different cases which can be solved with the
5064: same trick.</p>
5065: <pre class="programlisting">
1.100 rillig 5066: EMPTY= # empty
5067: empty_test:
5068: for i in a ${EMPTY:Q} c; do \
5069: echo "$$i"; \
5070: done
5071:
5072: for_test:
5073: .for i in a:\ a:\test.txt
5074: echo ${i:Q}
5075: echo "foo"
5076: .endfor
1.1 grant 5077: </pre>
1.75 rillig 5078: <p>The first example will only print two of the three lines
5079: we might have expected. This is because
5080: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5081: the shell cannot see. The workaround is to write
5082: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5083: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5084: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5085: <p>The second example will only print three lines instead of
5086: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5087: This is because the backslash of the value
5088: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110 hubertf 5089: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
5090: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75 rillig 5091: <code class="varname">${i:Q}""</code>.</p>
5092: </li>
5093: </ul></div>
5094: </div>
1.128 wiz 5095: <div class="sect2" title="12.3.5. Workaround for a bug in BSD Make">
1.75 rillig 5096: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5097: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5098: <p>The pkgsrc bmake program does not handle the following
5099: assignment correctly. In case <code class="varname">_othervar_</code>
5100: contains a ``-'' character, one of the closing braces is included
5101: in <code class="varname">${VAR}</code> after this code executes.</p>
5102: <pre class="programlisting">
1.100 rillig 5103: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5104: </pre>
1.75 rillig 5105: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5106: 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 5107: <code class="varname">bug1</code>.</p>
5108: </div>
5109: </div>
5110: </div>
1.128 wiz 5111: <div class="chapter" title="Chapter 13. PLIST issues">
1.75 rillig 5112: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5113: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 5114: <div class="toc">
5115: <p><b>Table of Contents</b></p>
5116: <dl>
1.106 rillig 5117: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 5118: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5119: <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 5120: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5121: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 5122: <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 5123: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5124: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5125: </dl>
5126: </div>
1.87 wiz 5127: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 5128: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 5129: the package (relative to the <code class="filename">${PREFIX}</code>
5130: directory it's been installed in) plus some additional statements
1.110 hubertf 5131: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87 wiz 5132: This chapter addresses some issues that need attention when
5133: dealing with the <code class="filename">PLIST</code> file (or files, see
5134: below!).</p>
1.128 wiz 5135: <div class="sect1" title="13.1. RCS ID">
1.75 rillig 5136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5137: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 5138: <p>Be sure to add a RCS ID line as the first thing in any
5139: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5140: <pre class="programlisting">
1.100 rillig 5141: @comment $NetBSD$
1.87 wiz 5142: </pre>
1.75 rillig 5143: </div>
1.128 wiz 5144: <div class="sect1" title="13.2. Semi-automatic PLIST generation">
1.75 rillig 5145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5146: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 5147: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 5148: to output a PLIST that matches any new files since the package
1.110 hubertf 5149: 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 5150: more information on this target.</p>
1.75 rillig 5151: </div>
1.128 wiz 5152: <div class="sect1" title="13.3. Tweaking output of make print-PLIST">
1.75 rillig 5153: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 5154: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 5155: </h2></div></div></div>
1.87 wiz 5156: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 5157: <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
5158: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 5159: <code class="varname">@comment</code>s instead of real
5160: <code class="varname">@dirrm</code> lines. You can also do this for
5161: specific directories and files, so that the results of that
5162: command are very close to reality. This helps <span class="emphasis"><em>a
5163: lot</em></span> during the update of packages.</p>
5164: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5165: of AWK patterns and actions that are used to filter the output of
5166: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5167: scripting you like to it, but be careful with quoting.</p>
5168: <p>For example, to get all files inside the
5169: <code class="filename">libdata/foo</code> directory removed from the
5170: resulting PLIST:</p>
5171: <pre class="programlisting">
1.100 rillig 5172: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5173: </pre>
5174: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5175: to a specific (shared) directory converted to
5176: <code class="varname">@comment</code>s:</p>
1.75 rillig 5177: <pre class="programlisting">
1.100 rillig 5178: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5179: </pre>
1.75 rillig 5180: </div>
1.128 wiz 5181: <div class="sect1" title="13.4. Variable substitution in PLIST">
1.75 rillig 5182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5183: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5184: <p>A number of variables are substituted automatically in
5185: PLISTs when a package is installed on a system. This includes the
5186: following variables:</p>
1.75 rillig 5187: <div class="variablelist"><dl>
5188: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5189: <dd>
5190: <p>Some packages like emacs and perl embed information
1.87 wiz 5191: about which architecture they were built on into the
5192: pathnames where they install their files. To handle this
5193: case, PLIST will be preprocessed before actually used, and
5194: the symbol
1.128 wiz 5195: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 5196: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 5197: same is done if the string
5198: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5199: PLIST somewhere - use this on packages that have GNU
5200: autoconf-created configure scripts.</p>
1.128 wiz 5201: <div class="note" title="Legacy note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 5202: <h3 class="title">Legacy note</h3>
5203: <p>There used to be a symbol
1.128 wiz 5204: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 5205: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 5206: -m</strong></span>, but that's no longer supported and has
5207: been removed.</p>
1.75 rillig 5208: </div>
5209: </dd>
5210: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5211: <dd>
5212: <p>Some packages want to embed the OS name and version
1.87 wiz 5213: into some paths. To do this, use these variables in the
5214: <code class="filename">PLIST</code>:
5215: </p>
1.128 wiz 5216: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5217: <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>
5218: <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>
5219: <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 5220: </ul></div>
5221: </dd>
5222: </dl></div>
1.87 wiz 5223: <p>For a complete list of values which are replaced by
5224: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5225: search for <code class="varname">PLIST_SUBST</code>).</p>
5226: <p>If you want to change other variables not listed above, you
5227: can add variables and their expansions to this variable in the
1.110 hubertf 5228: 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 5229: <pre class="programlisting">
1.100 rillig 5230: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5231: </pre>
1.128 wiz 5232: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 5233: in the <code class="filename">PLIST</code> with
1.128 wiz 5234: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 5235: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 5236: the common case of conditionally including some
5237: <code class="filename">PLIST</code> entries. It can be done by adding
5238: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 5239: setting the corresponding <code class="varname">PLIST.foo</code> variable
5240: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 5241: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 5242: in the <code class="filename">PLIST</code> with either
1.128 wiz 5243: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5244: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 5245: For example, in <code class="filename">Makefile</code>:</p>
5246: <pre class="programlisting">
5247: PLIST_VARS+= foo
5248: .if <em class="replaceable"><code>condition</code></em>
5249: PLIST.foo= yes
5250: .else
5251: </pre>
5252: <p>And then in <code class="filename">PLIST</code>:</p>
5253: <pre class="programlisting">
5254: @comment $NetBSD$
5255: bin/bar
5256: man/man1/bar.1
5257: ${PLIST.foo}bin/foo
5258: ${PLIST.foo}man/man1/foo.1
5259: ${PLIST.foo}share/bar/foo.data
5260: ${PLIST.foo}@dirrm share/bar
5261: </pre>
1.75 rillig 5262: </div>
1.128 wiz 5263: <div class="sect1" title="13.5. Man page compression">
1.75 rillig 5264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5265: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5266: <p>Man pages should be installed in compressed form if
1.87 wiz 5267: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5268: and uncompressed otherwise. To handle this in the
1.128 wiz 5269: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5270: appended/removed automatically for man pages according to
5271: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5272: or not, see above for details. This modification of the
5273: <code class="filename">PLIST</code> file is done on a copy of it, not
5274: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5275: </div>
1.128 wiz 5276: <div class="sect1" title="13.6. Changing PLIST source with PLIST_SRC">
1.75 rillig 5277: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5278: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5279: </h2></div></div></div>
1.76 rillig 5280: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5281: in generating the binary package, set the variable
5282: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110 hubertf 5283: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87 wiz 5284: important. The default for <code class="varname">PLIST_SRC</code> is
5285: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5286: </div>
1.128 wiz 5287: <div class="sect1" title="13.7. Platform-specific and differing PLISTs">
1.75 rillig 5288: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5289: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5290: <p>Some packages decide to install a different set of files based on
1.87 wiz 5291: the operating system being used. These differences can be
5292: automatically handled by using the following files:</p>
1.128 wiz 5293: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5294: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5295: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5296: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5297: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5298: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5299: </ul></div>
5300: </div>
1.128 wiz 5301: <div class="sect1" title="13.8. Sharing directories between packages">
1.75 rillig 5302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5303: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.128 wiz 5304: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5305: multiple (and unrelated) packages install files. These
1.125 wiz 5306: directories were problematic because you had to add special
5307: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5308: centralized package handle them.</p>
1.125 wiz 5309: <p>In pkgsrc, it is now easy: Each package should create
5310: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5311: will remove any directories left empty after uninstalling a
5312: package.</p>
5313: <p>If a package needs an empty directory to work, create
5314: the directory during installation as usual, and also add an
5315: entry to the PLIST:
5316: </p>
1.87 wiz 5317: <pre class="programlisting">
1.125 wiz 5318: @pkgdir path/to/empty/directory
1.87 wiz 5319: </pre>
1.125 wiz 5320: <p>
5321: </p>
1.75 rillig 5322: </div>
5323: </div>
1.128 wiz 5324: <div class="chapter" title="Chapter 14. Buildlink methodology">
1.75 rillig 5325: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5326: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5327: <div class="toc">
5328: <p><b>Table of Contents</b></p>
5329: <dl>
1.106 rillig 5330: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 5331: <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 5332: <dd><dl>
1.106 rillig 5333: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.128 wiz 5334: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5335: </dl></dd>
1.128 wiz 5336: <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 5337: <dd><dl>
1.128 wiz 5338: <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 5339: <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 5340: </dl></dd>
5341: </dl>
5342: </div>
5343: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5344: are seen by a package's configure and build processes. This is implemented
5345: in a two step process:</p>
1.128 wiz 5346: <div class="orderedlist"><ol class="orderedlist" type="1">
5347: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5348: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5349: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 5350: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5351: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5352: <code class="option">-L${LOCALBASE}/lib</code> into references to
5353: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5354: native compiler on some operating systems look like GCC, so that
5355: packages that expect GCC won't require modifications to build with
5356: those native compilers.</p></li>
1.75 rillig 5357: </ol></div>
5358: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5359: package may be built consistently despite what other software may be
5360: installed. Please note that the normal system header and library paths,
5361: e.g. <code class="filename">/usr/include</code>,
5362: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5363: designed to insulate the package build from non-system-supplied
5364: software.</p>
1.128 wiz 5365: <div class="sect1" title="14.1. Converting packages to use buildlink3">
1.75 rillig 5366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5367: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5368: <p>The process of converting packages to use the buildlink3
1.128 wiz 5369: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5370: The things to keep in mind are:</p>
1.128 wiz 5371: <div class="orderedlist"><ol class="orderedlist" type="1">
5372: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5373: instead of the actual toolchain. Some packages are tricky,
5374: and the only way to know for sure is the check
5375: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5376: wrappers are being invoked.</p></li>
1.128 wiz 5377: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5378: the package Makefile, e.g. Java VMs, standalone shells,
5379: etc., because the code to symlink files into
5380: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 5381: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5382: </p></li>
1.128 wiz 5383: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5384: <code class="filename">buildlink3.mk</code> files that you list in a
5385: package's Makefile are added as dependencies for that package.
5386: </p></li>
1.75 rillig 5387: </ol></div>
1.87 wiz 5388: <p>If a dependency on a particular package is required for its libraries and
5389: headers, then we replace:</p>
1.75 rillig 5390: <pre class="programlisting">
1.100 rillig 5391: DEPENDS+= foo>=1.1.0:../../category/foo
5392: </pre>
1.75 rillig 5393: <p>with</p>
5394: <pre class="programlisting">
1.100 rillig 5395: .include "../../category/foo/buildlink3.mk"
5396: </pre>
1.75 rillig 5397: <p>The buildlink3.mk files usually define the required dependencies.
5398: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5399: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5400: <pre class="programlisting">
1.100 rillig 5401: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5402: .include "../../category/foo/buildlink3.mk"
5403: </pre>
1.76 rillig 5404: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5405: files in <code class="filename">pkgsrc/mk</code>
5406: that handle special package issues:</p>
1.128 wiz 5407: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5408: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5409: the native or a pkgsrc Berkeley DB implementation based on
5410: the values of <code class="varname">BDB_ACCEPTED</code> and
5411: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 5412: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5413: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5414: 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 5415: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5416: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5417: adding a dependency on Heimdal or MIT-krb5 for packages that
5418: require a Kerberos 5 implementation.</p></li>
1.128 wiz 5419: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5420: system-provided Motif installation or adds a dependency on
1.91 rillig 5421: <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 5422: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
5423: <span class="quote">“<span class="quote">lesstif</span>”</span>, or <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5424: which Motif version will be used.</p></li>
1.128 wiz 5425: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5426: variables that may be used by packages that use the
5427: Open Sound System (OSS) API.</p></li>
1.128 wiz 5428: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5429: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5430: the file for more information.</p></li>
1.128 wiz 5431: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5432: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5433: 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 5434: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5435: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5436: library.</p></li>
1.75 rillig 5437: </ul></div>
1.76 rillig 5438: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5439: files provide a more complete
5440: description of how to use them properly.</p>
1.75 rillig 5441: </div>
1.128 wiz 5442: <div class="sect1" title="14.2. Writing buildlink3.mk files">
1.75 rillig 5443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5444: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5445: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5446: included by Makefiles to indicate the need to compile and link
5447: against header files and libraries provided by the package. A
5448: <code class="filename">buildlink3.mk</code> file should always provide
5449: enough information to add the correct type of dependency
5450: relationship and include any other
5451: <code class="filename">buildlink3.mk</code> files that it needs to find
5452: headers and libraries that it needs in turn.</p>
5453: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5454: 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 5455: package is highly recommended. For most packages, the following
5456: command will generate a good starting point for
5457: <code class="filename">buildlink3.mk</code> files:</p>
5458: <pre class="screen">
5459: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5460: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5461: </pre>
1.128 wiz 5462: <div class="sect2" title="14.2.1. Anatomy of a buildlink3.mk file">
1.75 rillig 5463: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5464: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5465: <p>The following real-life example
1.87 wiz 5466: <code class="filename">buildlink3.mk</code> is taken
5467: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5468: <pre class="programlisting">
1.120 snj 5469: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5470:
1.120 snj 5471: BUILDLINK_TREE+= tiff
1.1 grant 5472:
1.120 snj 5473: .if !defined(TIFF_BUILDLINK3_MK)
5474: TIFF_BUILDLINK3_MK:=
1.87 wiz 5475:
1.120 snj 5476: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5477: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5478: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5479:
1.100 rillig 5480: .include "../../devel/zlib/buildlink3.mk"
5481: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5482: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5483:
1.120 snj 5484: BUILDLINK_TREE+= -tiff
1.100 rillig 5485: </pre>
1.87 wiz 5486: <p>The header and footer manipulate
1.120 snj 5487: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5488: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5489: the dependency tree.</p>
5490: <p>The main section is protected from multiple inclusion
1.87 wiz 5491: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5492: added. Several important variables are set in the section:</p>
1.128 wiz 5493: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5494: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5495: is the actual dependency recorded in the installed
5496: package; this should always be set using
1.110 hubertf 5497: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5498: we're appending to any pre-existing list of values. This
5499: variable should be set to the first version of the
5500: package that had an API change.
5501: </p></li>
1.128 wiz 5502: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5503: is the location of the <em class="replaceable"><code>pkg</code></em>
5504: pkgsrc directory.</p></li>
1.128 wiz 5505: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5506: (not shown above) controls whether we use
5507: <code class="varname">BUILD_DEPENDS</code> or
5508: <code class="varname">DEPENDS</code> to add the dependency on
5509: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5510: selected by setting
5511: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5512: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5513: used.</p></li>
1.128 wiz 5514: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5515: and
5516: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5517: (not shown above) are lists of subdirectories of
1.76 rillig 5518: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5519: to add to the header and library search paths. These
1.128 wiz 5520: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5521: respectively.</p></li>
1.128 wiz 5522: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5523: (not shown above) is the list of preprocessor flags to add
5524: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 5525: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5526: should be avoided and instead be handled using
5527: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5528: above.</p></li>
1.75 rillig 5529: </ul></div>
1.87 wiz 5530: <p>The following variables are all optionally defined within
5531: this second section (protected against multiple inclusion) and
5532: control which package files are symlinked into
5533: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5534: transformed during the symlinking:</p>
1.128 wiz 5535: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5536: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5537: (not shown above) is a shell glob pattern relative to
1.76 rillig 5538: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5539: to be symlinked into
1.76 rillig 5540: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5541: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 5542: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5543: (not shown above) is a shell pipeline that
5544: outputs to stdout a list of files relative to
5545: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5546: The resulting files are to be symlinked
5547: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5548: this takes the <code class="filename">+CONTENTS</code> of a
5549: <em class="replaceable"><code>pkg</code></em> and filters it through
5550: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 5551: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5552: (not shown above) is a filter command that filters
1.76 rillig 5553: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5554: relative to
1.76 rillig 5555: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5556: on stdout. By default for overwrite packages,
5557: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5558: outputs the contents of the <code class="filename">include</code>
5559: and <code class="filename">lib</code> directories in the package
5560: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5561: it outputs any libtool archives in
1.87 wiz 5562: <code class="filename">lib</code> directories.</p></li>
1.128 wiz 5563: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5564: (not shown above) is a list of sed arguments used to
5565: transform the name of the source filename into a
1.110 hubertf 5566: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5567: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5568: </ul></div>
1.120 snj 5569: <p>This section can additionally include any
1.87 wiz 5570: <code class="filename">buildlink3.mk</code> needed for
5571: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5572: Including these <code class="filename">buildlink3.mk</code> files
5573: means that the headers and libraries for these
5574: dependencies are also symlinked into
5575: <code class="filename">${BUILDLINK_DIR}</code>
5576: whenever the <em class="replaceable"><code>pkg</code></em>
5577: <code class="filename">buildlink3.mk</code>
1.120 snj 5578: file is included. Dependencies are only added for directly
5579: include <code class="filename">buildlink3.mk</code> files.</p>
1.75 rillig 5580: </div>
1.128 wiz 5581: <div class="sect2" title="14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files">
1.75 rillig 5582: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5583: <a name="updating-buildlink-depends"></a>14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.87 wiz 5584: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5585: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5586: after a package update is when the API or interface to the
1.87 wiz 5587: header files change.</p>
5588: <p>In this case,
5589: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5590: should be adjusted to require at least the new package
5591: version. In some cases, the packages that depend on this new
5592: version may need their <code class="varname">PKGREVISION</code>s
5593: increased and, if they have <code class="filename">buildlink3.mk</code>
5594: files, their
5595: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5596: adjusted, too. This is needed so pkgsrc will require the
5597: correct package dependency and not settle for an older one
5598: when building the source.</p>
5599: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5600: should be increased when the binary interface or sonames
5601: (major number of the library version) of any installed
5602: shared libraries change. This is needed so that binary
5603: packages made using it will require the correct package
5604: dependency and not settle for an older one which will not
1.87 wiz 5605: contain the necessary shared libraries.</p>
1.110 hubertf 5606: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.75 rillig 5607: more information about dependencies on other packages,
5608: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5609: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5610: <p>Please take careful consideration before adjusting
5611: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5612: or
5613: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5614: as we don't want to cause unneeded package deletions and
5615: rebuilds. In many cases, new versions of packages work just
5616: fine with older dependencies.</p>
5617: <p>Also it is not needed to set
1.75 rillig 5618: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5619: when it is identical to
1.87 wiz 5620: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5621: </div>
5622: </div>
1.128 wiz 5623: <div class="sect1" title="14.3. Writing builtin.mk files">
1.75 rillig 5624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5625: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5626: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5627: coincide with headers and libraries present in the base system.
1.76 rillig 5628: Aside from a <code class="filename">buildlink3.mk</code> file, these
5629: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5630: file that includes the necessary checks to decide whether using
5631: the built-in software or the pkgsrc software is
1.87 wiz 5632: appropriate.</p>
5633: <p>The only requirements of a builtin.mk file for
5634: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 5635: <div class="orderedlist"><ol class="orderedlist" type="1">
5636: <li class="listitem"><p>It should set
1.87 wiz 5637: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5638: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5639: after it is included.</p></li>
1.128 wiz 5640: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5641: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5642: which is already set before the
5643: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 5644: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5645: is <span class="emphasis"><em>very</em></span> important and takes careful
5646: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5647: </ol></div>
1.128 wiz 5648: <div class="sect2" title="14.3.1. Anatomy of a builtin.mk file">
1.75 rillig 5649: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5650: <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 5651: <p>The following is the recommended template for builtin.mk
1.87 wiz 5652: files:</p>
1.75 rillig 5653: <pre class="programlisting">
1.100 rillig 5654: .if !defined(IS_BUILTIN.foo)
5655: #
5656: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5657: # genuinely exists in the system or not.
5658: #
5659: IS_BUILTIN.foo?= no
5660:
5661: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5662: # version can be determined.
5663: #
5664: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5665: BUILTIN_PKG.foo?= foo-1.0
5666: . endif
5667: .endif # IS_BUILTIN.foo
5668:
5669: .if !defined(USE_BUILTIN.foo)
5670: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5671: . if defined(BUILTIN_PKG.foo)
5672: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5673: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5674: USE_BUILTIN.foo!= \
5675: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5676: && ${ECHO} "yes" || ${ECHO} "no"
5677: . endif
5678: . endfor
5679: . endif
5680: .endif # USE_BUILTIN.foo
5681:
5682: CHECK_BUILTIN.foo?= no
5683: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5684: #
5685: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5686: # "yes" or "no".
5687: #
5688: .endif # CHECK_BUILTIN.foo
5689: </pre>
1.87 wiz 5690: <p>The first section sets
5691: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5692: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5693: in the base system. This should not be a base system software
5694: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 5695: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5696: included as part of the base system. This variable is only
5697: used internally within the <code class="filename">builtin.mk</code>
5698: file.</p>
5699: <p>The second section sets
5700: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5701: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5702: system if it exists (if
5703: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5704: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5705: within the <code class="filename">builtin.mk</code> file.</p>
5706: <p>The third section sets
5707: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5708: and is <span class="emphasis"><em>required</em></span> in all
5709: <code class="filename">builtin.mk</code> files. The code in this
5710: section must make the determination whether the built-in
5711: software is adequate to satisfy the dependencies listed in
5712: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5713: This is typically done by comparing
5714: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5715: against each of the dependencies in
5716: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5717: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5718: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5719: end of the <code class="filename">builtin.mk</code> file. Note that
5720: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5721: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5722: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5723: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5724: that the built-in version of the software is similar enough to
5725: be used as a replacement.</p>
5726: <p>The last section is guarded by
5727: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5728: and includes code that uses the value of
5729: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5730: set in the previous section. This typically includes, e.g.,
5731: adding additional dependency restrictions and listing additional
5732: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5733: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5734: </div>
1.128 wiz 5735: <div class="sect2" title="14.3.2. Global preferences for native or pkgsrc software">
1.75 rillig 5736: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5737: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5738: <p>When building packages, it's possible to choose whether to set
5739: a global preference for using either the built-in (native)
5740: version or the pkgsrc version of software to satisfy a
5741: dependency. This is controlled by setting
5742: <code class="varname">PREFER_PKGSRC</code> and
5743: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 5744: 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 5745: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5746: use the pkgsrc versions of software, while
5747: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5748: built-in versions. Preferences are determined by the most
5749: specific instance of the package in either
5750: <code class="varname">PREFER_PKGSRC</code> or
5751: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5752: in neither or in both variables, then
5753: <code class="varname">PREFER_PKGSRC</code> has precedence over
5754: <code class="varname">PREFER_NATIVE</code>. For example, to require
5755: using pkgsrc versions of software for all but the most basic
5756: bits on a NetBSD system, you can set:</p>
5757: <pre class="programlisting">
1.100 rillig 5758: PREFER_PKGSRC= yes
5759: PREFER_NATIVE= getopt skey tcp_wrappers
5760: </pre>
1.87 wiz 5761: <p>A package <span class="emphasis"><em>must</em></span> have a
5762: <code class="filename">builtin.mk</code>
5763: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5764: otherwise it is simply ignored in that list.</p>
1.75 rillig 5765: </div>
5766: </div>
5767: </div>
1.128 wiz 5768: <div class="chapter" title="Chapter 15. The pkginstall framework">
1.75 rillig 5769: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5770: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5771: <div class="toc">
5772: <p><b>Table of Contents</b></p>
5773: <dl>
1.106 rillig 5774: <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 5775: <dd><dl>
1.106 rillig 5776: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5777: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5778: </dl></dd>
1.106 rillig 5779: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5780: <dd><dl>
1.128 wiz 5781: <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 5782: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5783: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5784: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5785: </dl></dd>
5786: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5787: <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>
5788: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5789: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5790: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5791: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5792: <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 5793: </dl>
5794: </div>
5795: <p>This chapter describes the framework known as
5796: <code class="literal">pkginstall</code>, whose key features are:</p>
1.128 wiz 5797: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5798: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5799: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5800: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5801: provided that packages are correctly designed.</p></li>
1.128 wiz 5802: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5803: <li class="listitem"><p>Registration of system users and groups.</p></li>
5804: <li class="listitem"><p>Registration of system shells.</p></li>
5805: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5806: </ul></div>
5807: <p>The following sections inspect each of the above points in detail.</p>
5808: <p>You may be thinking that many of the things described here could be
5809: easily done with simple code in the package's post-installation target
5810: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5811: as the code in them is only executed when building from source. Machines
5812: using binary packages could not benefit from it at all (as the code itself
5813: could be unavailable). Therefore, the only way to achieve any of the items
5814: described above is by means of the installation scripts, which are
5815: automatically generated by pkginstall.</p>
1.128 wiz 5816: <div class="sect1" title="15.1. Files and directories outside the installation prefix">
1.75 rillig 5817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5818: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5819: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5820: of files and directories that belong to a package. The names used in it
1.76 rillig 5821: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5822: which means that it cannot register files outside this directory (absolute
5823: path names are not allowed). Despite this restriction, some packages need
5824: to install files outside this location; e.g., under
1.76 rillig 5825: <code class="filename">${VARBASE}</code> or
1.87 wiz 5826: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5827: is to create such files during installation time by using
5828: installation scripts.</p>
5829: <p>The generic installation scripts are shell scripts that can
5830: contain arbitrary code. The list of scripts to execute is taken from
5831: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5832: <code class="filename">INSTALL</code>. A similar variable exists for package
5833: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5834: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5835: commands, so they have the potential to create and manage files
5836: anywhere in the file system.</p>
5837: <p>Using these general installation files is not recommended, but
5838: may be needed in some special cases. One reason for avoiding them is
5839: that the user has to trust the packager that there is no unwanted or
5840: simply erroneous code included in the installation script. Also,
5841: previously there were many similar scripts for the same functionality,
5842: and fixing a common error involved finding and changing all of
5843: them.</p>
5844: <p>The pkginstall framework offers another, standardized way. It
5845: provides generic scripts to abstract the manipulation of such files
5846: and directories based on variables set in the package's
5847: <code class="filename">Makefile</code>. The rest of this section describes
5848: these variables.</p>
1.128 wiz 5849: <div class="sect2" title="15.1.1. Directory manipulation">
1.75 rillig 5850: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5851: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5852: <p>The following variables can be set to request the creation of
5853: directories anywhere in the file system:</p>
1.128 wiz 5854: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5855: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5856: contain a list of directories that should be created and should attempt
5857: to be destroyed by the installation scripts. The difference between
5858: the two is that the latter prompts the administrator to remove any
5859: directories that may be left after deinstallation (because they were
5860: not empty), while the former does not.</p></li>
1.128 wiz 5861: <li class="listitem">
1.75 rillig 5862: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5863: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5864: which directories should be created and should attempt to be destroyed
5865: by the installation scripts. Each tuple holds the following values,
5866: separated by spaces: the directory name, its owner, its group and its
5867: numerical mode. For example:</p>
5868: <pre class="programlisting">
1.100 rillig 5869: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5870: </pre>
1.75 rillig 5871: <p>The difference between the two is exactly the same as their
5872: non-<code class="varname">PERMS</code> counterparts.</p>
5873: </li>
5874: </ul></div>
5875: </div>
1.128 wiz 5876: <div class="sect2" title="15.1.2. File manipulation">
1.75 rillig 5877: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5878: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5879: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5880: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5881: To overcome this problem, the only solution is to extract the file in the
5882: known place (i.e., inside the installation prefix) and copy it to the
5883: appropriate location during installation (done by the installation scripts
5884: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5885: file</em></span> in the following paragraphs, which describe the variables
5886: that can be used to automatically and consistently handle files outside the
5887: installation prefix:</p>
1.128 wiz 5888: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5889: <li class="listitem">
1.75 rillig 5890: <p><code class="varname">CONF_FILES</code> and
5891: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5892: During installation time, the master file is copied to the target one
5893: if and only if the latter does not exist. Upon deinstallation, the
5894: target file is removed provided that it was not modified by the
5895: installation.</p>
5896: <p>The difference between the two is that the latter prompts the
5897: administrator to remove any files that may be left after
5898: deinstallation (because they were not empty), while the former does
5899: not.</p>
5900: </li>
1.128 wiz 5901: <li class="listitem">
1.75 rillig 5902: <p><code class="varname">CONF_FILES_PERMS</code> and
5903: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5904: files as well as their target locations. For each of them, it also
5905: specifies their owner, their group and their numeric permissions, in
5906: this order. For example:</p>
5907: <pre class="programlisting">
1.100 rillig 5908: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5909: </pre>
1.75 rillig 5910: <p>The difference between the two is exactly the same as their
5911: non-<code class="varname">PERMS</code> counterparts.</p>
5912: </li>
5913: </ul></div>
5914: </div>
5915: </div>
1.128 wiz 5916: <div class="sect1" title="15.2. Configuration files">
1.75 rillig 5917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5918: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5919: <p>Configuration files are special in the sense that they are installed
5920: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5921: need special treatment during installation (most of which is automated by
5922: pkginstall). The main concept you must bear in mind is that files marked
5923: as configuration files are automatically copied to the right place (somewhere
5924: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5925: and only if</em></span> they didn't exist before. Similarly, they will not
5926: be removed if they have local modifications. This ensures that
5927: administrators never lose any custom changes they may have made.</p>
1.128 wiz 5928: <div class="sect2" title="15.2.1. How PKG_SYSCONFDIR is set">
1.75 rillig 5929: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5930: <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 5931: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5932: specifies where configuration files shall be installed. Its contents are
5933: set based upon the following variables:</p>
1.128 wiz 5934: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5935: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5936: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5937: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5938: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5939: Packages must not use it directly.</p></li>
1.128 wiz 5940: <li class="listitem">
1.75 rillig 5941: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5942: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5943: for the package being built shall be installed. The definition of this
5944: variable only makes sense in the package's
1.76 rillig 5945: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5946: <p>As an example, consider the Apache package,
1.91 rillig 5947: <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 5948: configuration files under the
1.76 rillig 5949: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5950: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5951: Makefile.</p>
5952: </li>
1.128 wiz 5953: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5954: variable that holds this package's configuration directory (if
5955: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5956: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5957: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5958: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5959: directory where the configuration files for the package identified by
5960: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5961: </ul></div>
5962: <p>Based on the above variables, pkginstall determines the value of
5963: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5964: variable that can be used within a package to refer to its configuration
5965: directory. The algorithm used to set its value is basically the
5966: following:</p>
1.128 wiz 5967: <div class="orderedlist"><ol class="orderedlist" type="1">
5968: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5969: its value is used.</p></li>
1.128 wiz 5970: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5971: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5972: <code class="filename">Makefile</code>, the resulting value is
5973: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5974: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5975: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5976: </ol></div>
1.76 rillig 5977: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5978: 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
5979: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5980: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5981: </div>
1.128 wiz 5982: <div class="sect2" title="15.2.2. Telling the software where configuration files are">
1.75 rillig 5983: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5984: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5985: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5986: known place, you need to teach each package where it shall install its
5987: files. In some cases you will have to patch the package Makefiles to
5988: achieve it. If you are lucky, though, it may be as easy as passing an
5989: extra flag to the configuration script; this is the case of GNU Autoconf-
5990: generated files:</p>
5991: <pre class="programlisting">
1.100 rillig 5992: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5993: </pre>
1.75 rillig 5994: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5995: for</em></span> its configuration files, not where they will be originally
5996: installed (although the difference is never explicit,
5997: unfortunately).</p>
5998: </div>
1.128 wiz 5999: <div class="sect2" title="15.2.3. Patching installations">
1.75 rillig 6000: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6001: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6002: <p>As said before, pkginstall automatically handles configuration files.
6003: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6004: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6005: directly</strong></span>. Bad news is that many software installation scripts
6006: will, out of the box, mess with the contents of that directory. So what is
6007: the correct procedure to fix this issue?</p>
6008: <p>You must teach the package (usually by manually patching it) to
6009: install any configuration files under the examples hierarchy,
1.76 rillig 6010: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6011: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6012: has the original copies available.</p>
6013: <p>Once the required configuration files are in place (i.e., under the
6014: examples hierarchy), the pkginstall framework can use them as master copies
6015: during the package installation to update what is in
1.76 rillig 6016: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6017: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 6018: 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 6019: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6020: <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 6021: <pre class="programlisting">
1.100 rillig 6022: EGDIR= ${PREFIX}/share/doc/mutt/samples
6023: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6024: </pre>
1.75 rillig 6025: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6026: package and has no meaning outside it.</p>
6027: </div>
1.128 wiz 6028: <div class="sect2" title="15.2.4. Disabling handling of configuration files">
1.75 rillig 6029: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6030: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6031: <p>The automatic copying of config files can be toggled by setting the
6032: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6033: installation.</p>
6034: </div>
6035: </div>
1.128 wiz 6036: <div class="sect1" title="15.3. System startup scripts">
1.75 rillig 6037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6038: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 6039: <p>System startup scripts are special files because they must be
6040: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 6041: 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 6042: can be used. However, pkginstall provides a special mechanism to handle
6043: these files.</p>
6044: <p>In order to provide system startup scripts, the package has
6045: to:</p>
1.128 wiz 6046: <div class="orderedlist"><ol class="orderedlist" type="1">
6047: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6048: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6049: <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 6050: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 6051: <li class="listitem">
1.75 rillig 6052: <p>Tell pkginstall to handle it, appending the name of the script,
6053: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6054: Continuing the previous example:</p>
6055: <pre class="programlisting">
1.100 rillig 6056: RCD_SCRIPTS+= cupsd
1.1 grant 6057: </pre>
1.75 rillig 6058: </li>
6059: </ol></div>
6060: <p>Once this is done, pkginstall will do the following steps for each
6061: script in an automated fashion:</p>
1.128 wiz 6062: <div class="orderedlist"><ol class="orderedlist" type="1">
6063: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 6064: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6065: variable.</p></li>
1.128 wiz 6066: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 6067: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6068: that this master file must be explicitly registered in the
1.76 rillig 6069: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 6070: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 6071: from the examples hierarchy into the system-wide startup scripts
6072: directory.</p></li>
6073: </ol></div>
1.128 wiz 6074: <div class="sect2" title="15.3.1. Disabling handling of system startup scripts">
1.75 rillig 6075: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6076: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6077: <p>The automatic copying of config files can be toggled by setting the
6078: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6079: installation. Note that the scripts will be always copied inside the
1.76 rillig 6080: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6081: matter what the value of this variable is.</p>
6082: </div>
6083: </div>
1.128 wiz 6084: <div class="sect1" title="15.4. System users and groups">
1.75 rillig 6085: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6086: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 6087: <p>If a package needs to create special users and/or groups during
6088: installation, it can do so by using the pkginstall framework.</p>
6089: <p>Users can be created by adding entries to the
6090: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6091: syntax:</p>
6092: <pre class="programlisting">
1.100 rillig 6093: user:group
1.1 grant 6094: </pre>
1.87 wiz 6095: <p>Further specification of user details may be done by setting
6096: per-user variables.
6097: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6098: numeric UID for the user.
6099: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6100: user's description or comment.
6101: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6102: user's home directory, and defaults to
6103: <code class="filename">/nonexistent</code> if not specified.
6104: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6105: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6106: not specified.</p>
1.75 rillig 6107: <p>Similarly, groups can be created by adding entries to the
6108: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6109: <pre class="programlisting">
1.100 rillig 6110: group
1.1 grant 6111: </pre>
1.93 rillig 6112: <p>The numeric GID of the group may be set by defining
1.75 rillig 6113: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6114: <p>If a package needs to create the users and groups at an earlier
6115: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6116: either <code class="literal">configure</code> or <code class="literal">build</code> to
6117: indicate the phase before which the users and groups are created. In
6118: this case, the numeric UIDs and GIDs of the created users and groups
6119: are automatically hardcoded into the final installation scripts.</p>
6120: </div>
1.128 wiz 6121: <div class="sect1" title="15.5. System shells">
1.75 rillig 6122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6123: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 6124: <p>Packages that install system shells should register them in the shell
1.76 rillig 6125: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6126: administrator. This must be done from the installation scripts to keep
6127: binary packages working on any system. pkginstall provides an easy way to
6128: accomplish this task.</p>
6129: <p>When a package provides a shell interpreter, it has to set the
6130: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6131: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6132: 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 6133: <pre class="programlisting">
1.100 rillig 6134: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6135: </pre>
1.128 wiz 6136: <div class="sect2" title="15.5.1. Disabling shell registration">
1.75 rillig 6137: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6138: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6139: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6140: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6141: environment variable to <code class="literal">NO</code>.</p>
6142: </div>
6143: </div>
1.128 wiz 6144: <div class="sect1" title="15.6. Fonts">
1.75 rillig 6145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6146: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 6147: <p>Packages that install X11 fonts should update the database files
6148: that index the fonts within each fonts directory. This can easily be
6149: accomplished within the pkginstall framework.</p>
6150: <p>When a package installs X11 fonts, it must list the directories in
6151: which fonts are installed in the
6152: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 6153: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
6154: <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 6155: installation scripts to run the appropriate commands to update the fonts
6156: database files within each of those directories. For convenience, if the
6157: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6158: 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 6159: <pre class="programlisting">
1.100 rillig 6160: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6161: </pre>
1.128 wiz 6162: <div class="sect2" title="15.6.1. Disabling automatic update of the fonts databases">
1.75 rillig 6163: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6164: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6165: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6166: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6167: environment variable to <code class="literal">NO</code>.</p>
6168: </div>
6169: </div>
6170: </div>
1.128 wiz 6171: <div class="chapter" title="Chapter 16. Options handling">
1.75 rillig 6172: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6173: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 6174: <div class="toc">
6175: <p><b>Table of Contents</b></p>
6176: <dl>
1.106 rillig 6177: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 6178: <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 6179: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 6180: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6181: </dl>
6182: </div>
6183: <p>Many packages have the ability to be built to support different
1.76 rillig 6184: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6185: in pkgsrc that provides generic handling of those options that
6186: determine different ways in which the packages can be built. It's
6187: possible for the user to specify exactly which sets of options will be
6188: built into a package or to allow a set of global default options
6189: apply.</p>
1.107 rillig 6190: <p>There are two broad classes of behaviors that one might want to
6191: control via options. One is whether some particular feature is
6192: enabled in a program that will be built anyway, often by including or
6193: not including a dependency on some other package. The other is
6194: whether or not an additional program will be built as part of the
6195: package. Generally, it is better to make a split package for such
6196: additional programs instead of using options, because it enables
6197: binary packages to be built which can then be added separately. For
6198: example, the foo package might have minimal dependencies (those
6199: packages without which foo doesn't make sense), and then the foo-gfoo
6200: package might include the GTK frontend program gfoo. This is better
6201: than including a gtk option to foo that adds gfoo, because either that
6202: option is default, in which case binary users can't get foo without
6203: gfoo, or not default, in which case they can't get gfoo. With split
6204: packages, they can install foo without having GTK, and later decide to
6205: install gfoo (pulling in GTK at that time). This is an advantage to
6206: source users too, avoiding the need for rebuilds.</p>
6207: <p>Plugins with widely varying dependencies should usually be split
6208: instead of options.</p>
6209: <p>It is often more work to maintain split packages, especially if
6210: the upstream package does not support this. The decision of split
6211: vs. option should be made based on the likelihood that users will want
6212: or object to the various pieces, the size of the dependencies that are
6213: included, and the amount of work.</p>
6214: <p>A further consideration is licensing. Non-free parts, or parts
6215: that depend on non-free dependencies (especially plugins) should
6216: almost always be split if feasible.</p>
1.128 wiz 6217: <div class="sect1" title="16.1. Global default options">
1.75 rillig 6218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6219: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6220: <p>Global default options are listed in
6221: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6222: that should be built into every package if that option is supported.
1.110 hubertf 6223: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6224: </div>
1.128 wiz 6225: <div class="sect1" title="16.2. Converting packages to use bsd.options.mk">
1.75 rillig 6226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6227: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6228: </h2></div></div></div>
1.75 rillig 6229: <p>The following example shows how
1.76 rillig 6230: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6231: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6232: <code class="filename">Makefile</code>, or in a file,
6233: e.g. <code class="filename">options.mk</code>, that is included by the
6234: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6235: <pre class="programlisting">
1.100 rillig 6236: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6237: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6238: PKG_OPTIONS_OPTIONAL_GROUPS= database
6239: PKG_OPTIONS_GROUP.database= mysql pgsql
6240: PKG_SUGGESTED_OPTIONS= wibble-foo
6241: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6242: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6243:
6244: .include "../../mk/bsd.prefs.mk"
6245:
6246: # this package was previously named wibble2
6247: .if defined(PKG_OPTIONS.wibble2)
6248: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6249: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6250: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6251: .endif
6252:
6253: .include "../../mk/bsd.options.mk"
6254:
6255: # Package-specific option-handling
6256:
6257: ###
6258: ### FOO support
6259: ###
6260: .if !empty(PKG_OPTIONS:Mwibble-foo)
6261: CONFIGURE_ARGS+= --enable-foo
6262: .endif
6263:
6264: ###
6265: ### LDAP support
6266: ###
6267: .if !empty(PKG_OPTIONS:Mldap)
6268: . include "../../databases/openldap-client/buildlink3.mk"
6269: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6270: .endif
6271:
6272: ###
6273: ### database support
6274: ###
6275: .if !empty(PKG_OPTIONS:Mmysql)
6276: . include "../../mk/mysql.buildlink3.mk"
6277: .endif
6278: .if !empty(PKG_OPTIONS:Mpgsql)
6279: . include "../../mk/pgsql.buildlink3.mk"
6280: .endif
1.75 rillig 6281: </pre>
6282: <p>The first section contains the information about which build
6283: options are supported by the package, and any default options settings
6284: if needed.</p>
1.128 wiz 6285: <div class="orderedlist"><ol class="orderedlist" type="1">
6286: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110 hubertf 6287: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75 rillig 6288: options. It should be set to
1.78 rillig 6289: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6290: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6291: at the point where the options are processed.</p></li>
1.128 wiz 6292: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6293: build options supported by the package.</p></li>
1.128 wiz 6294: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6295: list of names of groups of mutually exclusive options. The options in
6296: each group are listed in
6297: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6298: The most specific setting of any option from the group takes
6299: precedence over all other options in the group. Options from the
6300: groups will be automatically added to
6301: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 6302: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6303: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6304: packages will fail if no option from the group is
6305: selected.</p></li>
1.128 wiz 6306: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6307: of names of sets of options. At least one option from each set must
6308: be selected. The options in each set are listed in
6309: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6310: Options from the sets will be automatically added to
6311: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6312: fail if no option from the set is selected.</p></li>
1.128 wiz 6313: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6314: build options which are enabled by default.</p></li>
1.128 wiz 6315: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6316: of
1.128 wiz 6317: <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 6318: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6319: their option counterparts. Pairs should be added with
1.128 wiz 6320: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6321: warning will be issued if the user uses a legacy
6322: variable.</p></li>
1.128 wiz 6323: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6324: of
1.128 wiz 6325: <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 6326: pairs that map options that have been renamed to their new
1.128 wiz 6327: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6328: the listing of global legacy options. A warning will be issued if
6329: the user uses a legacy option.</p></li>
1.128 wiz 6330: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6331: options implied by deprecated variables used. This can be used for
6332: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6333: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6334: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 6335: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6336: a list of warnings about deprecated variables or options used, and
6337: what to use instead.</p></li>
6338: </ol></div>
6339: <p>A package should never modify
6340: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6341: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6342: To suggest a default set of options, use
6343: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6344: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6345: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6346: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6347: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6348: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6349: happen with platform-specific options if none of them is supported on
6350: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6351: empty list and the package is otherwise treated as not using the
6352: options framework.</p>
1.76 rillig 6353: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6354: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6355: build options, properly filtered to remove unsupported and duplicate
6356: options.</p>
6357: <p>The remaining sections contain the logic that is specific to
6358: each option. The correct way to check for an option is to check
6359: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6360: <pre class="programlisting">
1.100 rillig 6361: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6362: </pre>
6363: </div>
1.128 wiz 6364: <div class="sect1" title="16.3. Option Names">
1.75 rillig 6365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6366: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6367: <p>Options that enable similar features in different packages (like
6368: optional support for a library) should use a common name in all
6369: packages that support it (like the name of the library). If another
6370: package already has an option with the same meaning, use the same
6371: name.</p>
6372: <p>Options that enable features specific to one package, where it's
6373: unlikely that another (unrelated) package has the same (or a similar)
6374: optional feature, should use a name prefixed with
6375: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6376: <p>If a group of related packages share an optional feature
6377: specific to that group, prefix it with the name of the
1.128 wiz 6378: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6379: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6380: <p>For new options, add a line to
1.76 rillig 6381: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6382: fields, separated by tab. The first field is the option name, the
6383: second its description. The description should be a whole sentence
6384: (starting with an uppercase letter and ending with a period) that
1.128 wiz 6385: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6386: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6387: </div>
1.128 wiz 6388: <div class="sect1" title="16.4. Determining the options of dependencies">
1.107 rillig 6389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6390: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6391: <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 6392: different dependencies based on the options with which the package was
6393: built. For querying these options, the file
6394: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6395: typical example looks like this:</p>
6396: <pre class="programlisting">
6397: pkgbase := libpurple
6398: .include "../../mk/pkg-build-options.mk"
6399:
6400: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6401: ...
6402: .endif
6403: </pre>
6404: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6405: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6406: options of the libpurple package, which can then be queried like
6407: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6408: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6409: details.</p>
6410: </div>
1.75 rillig 6411: </div>
1.128 wiz 6412: <div class="chapter" title="Chapter 17. The build process">
1.75 rillig 6413: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6414: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6415: <div class="toc">
6416: <p><b>Table of Contents</b></p>
6417: <dl>
1.106 rillig 6418: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6419: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6420: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6421: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 6422: <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 6423: <dd><dl>
6424: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6425: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6426: </dl></dd>
1.128 wiz 6427: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6428: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6429: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6430: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6431: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6432: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6433: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6434: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6435: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6436: <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 6437: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6438: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6439: </dl>
6440: </div>
1.128 wiz 6441: <div class="sect1" title="17.1. Introduction">
1.75 rillig 6442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6443: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6444: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6445: built. Building a package is separated into different
6446: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6447: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6448: described in the following sections. Each phase is split into
1.87 wiz 6449: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6450: containing phase, prefixed by one of <code class="varname">pre-</code>,
6451: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6452: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6453: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6454: <p>Never override the regular targets (like
6455: <code class="varname">fetch</code>), if you have to, override the
6456: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6457: <p>The basic steps for building a program are always the same. First
1.87 wiz 6458: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6459: the local system and then extracted. After any pkgsrc-specific patches
6460: to compile properly are applied, the software can be configured, then
6461: built (usually by compiling), and finally the generated binaries, etc.
6462: can be put into place on the system.</p>
1.97 rillig 6463: <p>To get more details about what is happening at each step,
6464: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6465: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6466: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6467: </div>
1.128 wiz 6468: <div class="sect1" title="17.2. Program location">
1.75 rillig 6469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6470: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6471: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6472: the next section, here's a brief discussion on where programs are
6473: installed, and which variables influence this.</p>
1.75 rillig 6474: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6475: where all files of the final program shall be installed. It is
6476: usually set to <code class="varname">LOCALBASE</code>
6477: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6478: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6479: <code class="varname">PREFIX</code> needs to be put
6480: into the various places in the program's source where paths to
1.110 hubertf 6481: 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 6482: <p>When choosing which of these variables to use,
1.87 wiz 6483: follow the following rules:</p>
1.128 wiz 6484: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
6485: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6486: where the current pkg will be installed. When referring to a
6487: pkg's own installation path, use
1.128 wiz 6488: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6489: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6490: are installed. If you need to construct a -I or -L argument
6491: to the compiler to find includes and libraries installed by
1.128 wiz 6492: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6493: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6494: installed all packages in <code class="filename">/usr/local</code>. As
6495: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6496: administrator, this variable is a misnomer.</p></li>
1.128 wiz 6497: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6498: distribution (from xsrc, etc.) is installed. When looking for
6499: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 6500: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6501: <li class="listitem">
1.88 wiz 6502: <p>X11-based packages are special in that they may be
6503: installed in either <code class="varname">X11BASE</code> or
6504: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6505: <p>Usually, X11 packages should be installed under
1.88 wiz 6506: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6507: will need to include
6508: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6509: request the presence of X11 and to get the right compilation
6510: flags.</p>
1.75 rillig 6511: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6512: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6513: files. These packages are special and they must be placed under
6514: <code class="varname">X11BASE</code>. To accomplish this, set either
6515: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6516: your package.</p>
1.75 rillig 6517: <p>Some notes: If you need
1.87 wiz 6518: to find includes or libraries installed by a pkg that has
6519: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6520: its pkg <code class="filename">Makefile</code>, you need to look in
6521: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6522: <code class="filename">${LOCALBASE}</code>. To force installation of
6523: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6524: <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 6525: is enabled by default.</p>
1.75 rillig 6526: </li>
1.128 wiz 6527: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6528: the installed location of an X11
6529: package. <code class="varname">X11PREFIX</code> will be set to
6530: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6531: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6532: installed.</p></li>
1.128 wiz 6533: <li class="listitem">
1.88 wiz 6534: <p>If xpkgwedge is installed, it is possible to have some
6535: packages installed in <code class="varname">X11BASE</code> and some in
6536: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6537: installed package, the <code class="varname">EVAL_PREFIX</code>
6538: definition can be used. It takes pairs in the format
1.128 wiz 6539: <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-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 6540: variable <code class="varname">DIRNAME</code> will be set to the prefix
6541: of the installed package <package>, or
1.128 wiz 6542: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6543: installed.</p>
1.75 rillig 6544: <p>This is best illustrated by example.</p>
6545: <p>The following lines are taken from
1.87 wiz 6546: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6547: <pre class="programlisting">
1.100 rillig 6548: EVAL_PREFIX+= GTKDIR=gtk+
6549: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6550: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6551: CONFIGURE_ARGS+= --enable-multibyte
6552: </pre>
1.88 wiz 6553: <p>Specific defaults can be defined for the packages
6554: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6555: definition of the form:</p>
1.75 rillig 6556: <pre class="programlisting">
1.100 rillig 6557: GTKDIR_DEFAULT= ${LOCALBASE}
6558: </pre>
1.75 rillig 6559: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6560: to the first definition in
6561: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6562: </li>
1.128 wiz 6563: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110 hubertf 6564: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87 wiz 6565: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6566: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6567: </ul></div>
6568: </div>
1.128 wiz 6569: <div class="sect1" title="17.3. Directories used during the build process">
1.75 rillig 6570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6571: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6572: <p>When building a package, various directories are used to store
1.87 wiz 6573: source files, temporary files, pkgsrc-internal files, and so on. These
6574: directories are explained here.</p>
1.75 rillig 6575: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6576: are two common base directories for these relative directories:
6577: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6578: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6579: inside the package itself.</p>
1.75 rillig 6580: <div class="variablelist"><dl>
6581: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6582: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6583: root directory. Generally, you don't need
6584: it.</p></dd>
1.97 rillig 6585: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6586: <dd><p>This is an absolute pathname that points to the
6587: current package.</p></dd>
1.75 rillig 6588: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6589: <dd><p>This is a pathname relative to
1.87 wiz 6590: <code class="varname">PKGSRCDIR</code> that points to the current
6591: package.</p></dd>
1.75 rillig 6592: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6593: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6594: where all work takes place. The distfiles are extracted to this
1.87 wiz 6595: directory. It also contains temporary directories and log files used by
6596: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6597: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6598: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6599: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6600: where the distfiles are extracted. It is usually a direct subdirectory
6601: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6602: that isn't hidden. This variable may be changed by a package
6603: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6604: </dl></div>
1.114 jmcneill 6605: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6606: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6607: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6608: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6609: If users would like to have their pkgsrc trees behave in a
6610: read-only manner, then the value of
6611: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6612: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6613: </div>
1.128 wiz 6614: <div class="sect1" title="17.4. Running a phase">
1.75 rillig 6615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6616: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6617: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6618: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6619: phase. This will automatically run all phases that are required for this
6620: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6621: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6622: the package will be built, but not installed.</p>
1.75 rillig 6623: </div>
1.128 wiz 6624: <div class="sect1" title="17.5. The fetch phase">
1.75 rillig 6625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6626: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6627: <p>The first step in building a package is to fetch the
1.88 wiz 6628: distribution files (distfiles) from the sites that are providing
6629: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6630: phase.</p>
1.128 wiz 6631: <div class="sect2" title="17.5.1. What to fetch and where to get it from">
1.81 rillig 6632: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6633: <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 6634: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6635: defines all URLs from where the distfile, whose name is
6636: derived from the <code class="varname">DISTNAME</code> variable, is
6637: fetched. The more complicated cases are described
6638: below.</p>
6639: <p>The variable <code class="varname">DISTFILES</code> specifies
6640: the list of distfiles that have to be fetched. Its value
6641: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6642: so that most packages don't need to define it at all.
6643: <code class="varname">EXTRACT_SUFX</code> is
6644: <code class="literal">.tar.gz</code> by default, but can be changed
6645: freely. Note that if your package requires additional
6646: distfiles to the default one, you cannot just append the
6647: additional filenames using the <code class="literal">+=</code>
6648: operator, but you have write for example:</p>
1.81 rillig 6649: <pre class="programlisting">
1.100 rillig 6650: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6651: </pre>
1.88 wiz 6652: <p>Each distfile is fetched from a list of sites, usually
6653: <code class="varname">MASTER_SITES</code>. If the package has multiple
6654: <code class="varname">DISTFILES</code> or multiple
6655: <code class="varname">PATCHFILES</code> from different sites, you can
6656: set
6657: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6658: to the list of URLs where the file
6659: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6660: (including the suffix) can be found.</p>
6661: <pre class="programlisting">
1.100 rillig 6662: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6663: DISTFILES+= foo-file.tar.gz
6664: SITES.foo-file.tar.gz= \
6665: http://www.somewhere.com/somehow/ \
6666: http://www.somewhereelse.com/mirror/somehow/
6667: </pre>
1.81 rillig 6668: <p>When actually fetching the distfiles, each item from
1.88 wiz 6669: <code class="varname">MASTER_SITES</code> or
6670: <code class="varname">SITES.*</code> gets the name of each distfile
6671: appended to it, without an intermediate slash. Therefore,
6672: all site values have to end with a slash or other separator
6673: character. This allows for example to set
6674: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6675: that gets the name of the distfile as a parameter. In this
6676: case, the definition would look like:</p>
1.81 rillig 6677: <pre class="programlisting">
1.100 rillig 6678: MASTER_SITES= http://www.example.com/download.cgi?file=
6679: </pre>
1.125 wiz 6680: <p> The exception to this rule are URLs starting with a dash.
6681: In that case the URL is taken as is, fetched and the result stored
6682: under the name of the distfile.</p>
1.81 rillig 6683: <p>There are some predefined values for
1.88 wiz 6684: <code class="varname">MASTER_SITES</code>, which can be used in
6685: packages. The names of the variables should speak for
6686: themselves.</p>
6687: <pre class="programlisting">
1.100 rillig 6688: ${MASTER_SITE_APACHE}
6689: ${MASTER_SITE_BACKUP}
6690: ${MASTER_SITE_CYGWIN}
6691: ${MASTER_SITE_DEBIAN}
6692: ${MASTER_SITE_FREEBSD}
6693: ${MASTER_SITE_FREEBSD_LOCAL}
6694: ${MASTER_SITE_GENTOO}
6695: ${MASTER_SITE_GNOME}
6696: ${MASTER_SITE_GNU}
6697: ${MASTER_SITE_GNUSTEP}
6698: ${MASTER_SITE_IFARCHIVE}
6699: ${MASTER_SITE_KDE}
6700: ${MASTER_SITE_MOZILLA}
6701: ${MASTER_SITE_MYSQL}
6702: ${MASTER_SITE_OPENOFFICE}
6703: ${MASTER_SITE_PERL_CPAN}
6704: ${MASTER_SITE_PGSQL}
6705: ${MASTER_SITE_R_CRAN}
6706: ${MASTER_SITE_SOURCEFORGE}
6707: ${MASTER_SITE_SOURCEFORGE_JP}
6708: ${MASTER_SITE_SUNSITE}
6709: ${MASTER_SITE_SUSE}
6710: ${MASTER_SITE_TEX_CTAN}
6711: ${MASTER_SITE_XCONTRIB}
6712: ${MASTER_SITE_XEMACS}
6713: </pre>
1.88 wiz 6714: <p>Some explanations for the less self-explaining ones:
6715: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110 hubertf 6716: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
6717: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/</a>.</p>
1.88 wiz 6718: <p>If you choose one of these predefined sites, you may
6719: want to specify a subdirectory of that site. Since these
6720: macros may expand to more than one actual site, you
6721: <span class="emphasis"><em>must</em></span> use the following construct to
6722: specify a subdirectory:</p>
1.81 rillig 6723: <pre class="programlisting">
1.100 rillig 6724: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6725: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6726: </pre>
1.81 rillig 6727: <p>Note the trailing slash after the subdirectory
1.88 wiz 6728: name.</p>
1.81 rillig 6729: </div>
1.128 wiz 6730: <div class="sect2" title="17.5.2. How are the files fetched?">
1.81 rillig 6731: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6732: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6733: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6734: all the distfiles exist in a local directory
1.93 rillig 6735: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6736: user). If the files do not exist, they are fetched using
6737: commands of the form</p>
1.75 rillig 6738: <pre class="programlisting">
1.100 rillig 6739: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6740: </pre>
1.88 wiz 6741: <p>where <code class="literal">${site}</code> varies through
6742: several possibilities in turn: first,
6743: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6744: sites specified in either <code class="varname">SITES.file</code> if
6745: defined, else <code class="varname">MASTER_SITES</code> or
6746: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6747: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6748: all except the first and the last can be optionally sorted
6749: by the user, via setting either
6750: <code class="varname">MASTER_SORT_RANDOM</code>, and
6751: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6752: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6753: <p> The specific command and arguments used depend on the
6754: <code class="varname">FETCH_USING</code> parameter. The example above is
6755: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6756: <p>The distfiles mirror run by the NetBSD Foundation uses the
6757: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6758: distfiles, if they are freely distributable. Packages setting
6759: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6760: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6761: mirrored.</p>
1.81 rillig 6762: </div>
1.75 rillig 6763: </div>
1.128 wiz 6764: <div class="sect1" title="17.6. The checksum phase">
1.75 rillig 6765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6766: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6767: <p>After the distfile(s) are fetched, their checksum is
6768: generated and compared with the checksums stored in the
6769: distinfo file. If the checksums don't match, the build is
6770: aborted. This is to ensure the same distfile is used for
6771: building, and that the distfile wasn't changed, e.g. by some
6772: malign force, deliberately changed distfiles on the master
6773: distribution site or network lossage.</p>
1.75 rillig 6774: </div>
1.128 wiz 6775: <div class="sect1" title="17.7. The extract phase">
1.75 rillig 6776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6777: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6778: <p>When the distfiles are present on the local system, they
1.88 wiz 6779: need to be extracted, as they usually come in the form of some
6780: compressed archive format.</p>
1.75 rillig 6781: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6782: extracted. If you only need some of them, you can set the
6783: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6784: files.</p>
6785: <p>Extracting the files is usually done by a little
1.93 rillig 6786: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6787: already knows how to extract various archive formats, so most
6788: likely you will not need to change anything here. But if you
6789: need, the following variables may help you:</p>
1.75 rillig 6790: <div class="variablelist"><dl>
6791: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6792: <dd><p>Use these variables to override the default
1.88 wiz 6793: options for an extract command, which are defined in
1.93 rillig 6794: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6795: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6796: <dd><p>This variable can be set to
1.114 jmcneill 6797: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6798: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6799: absolute pathname pointing to the command with which tar
1.114 jmcneill 6800: archives should be extracted. It is preferred to choose bsdtar over gtar
6801: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6802: </dl></div>
1.88 wiz 6803: <p>If the <code class="filename">extract</code> program doesn't
6804: serve your needs, you can also override the
6805: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6806: command used for extracting the files. This command is
6807: executed in the <code class="filename">${WRKSRC}</code>
6808: directory. During execution of this command, the shell
6809: variable <code class="varname">extract_file</code> holds the absolute
6810: pathname of the file that is going to be extracted.</p>
1.75 rillig 6811: <p>And if that still does not suffice, you can override the
1.88 wiz 6812: <code class="varname">do-extract</code> target in the package
6813: Makefile.</p>
1.75 rillig 6814: </div>
1.128 wiz 6815: <div class="sect1" title="17.8. The patch phase">
1.75 rillig 6816: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6817: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6818: <p>After extraction, all the patches named by the
1.88 wiz 6819: <code class="varname">PATCHFILES</code>, those present in the patches
6820: subdirectory of the package as well as in
6821: $LOCALPATCHES/$PKGPATH (e.g.
6822: <code class="filename">/usr/local/patches/graphics/png</code>) are
6823: applied. Patchfiles ending in <code class="filename">.Z</code> or
6824: <code class="filename">.gz</code> are uncompressed before they are
6825: applied, files ending in <code class="filename">.orig</code> or
6826: <code class="filename">.rej</code> are ignored. Any special options to
1.110 hubertf 6827: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
6828: <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>
6829: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88 wiz 6830: it fail if the patches apply with some lines of fuzz. Please
6831: fix (regen) the patches so that they apply cleanly. The
6832: rationale behind this is that patches that don't apply cleanly
6833: may end up being applied in the wrong place, and cause severe
6834: harm there.</p>
1.75 rillig 6835: </div>
1.128 wiz 6836: <div class="sect1" title="17.9. The tools phase">
1.75 rillig 6837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6838: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6839: <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 6840: </p>
1.75 rillig 6841: </div>
1.128 wiz 6842: <div class="sect1" title="17.10. The wrapper phase">
1.75 rillig 6843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6844: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6845: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6846: linkers. The following variables can be used to tweak the
6847: wrappers.</p>
1.75 rillig 6848: <div class="variablelist"><dl>
6849: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6850: <dd><p>The command used to print progress
1.88 wiz 6851: messages. Does nothing by default. Set to
6852: <code class="literal">${ECHO}</code> to see the progress
6853: messages.</p></dd>
1.75 rillig 6854: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6855: <dd><p>This variable can be set to
1.88 wiz 6856: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6857: depending on whether you want additional information in the
6858: wrapper log file.</p></dd>
1.75 rillig 6859: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6860: <dd><p>This variable can be set to
1.88 wiz 6861: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6862: on whether the wrapper should use its cache, which will
6863: improve the speed. The default value is
6864: <code class="literal">yes</code>, but is forced to
6865: <code class="literal">no</code> if the platform does not support
6866: it.</p></dd>
1.75 rillig 6867: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6868: <dd><p>A list of reordering commands. A reordering
6869: command has the form
6870: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6871: It ensures that that
6872: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6873: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6874: </p></dd>
1.75 rillig 6875: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6876: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6877: investigate further]</p></dd>
1.75 rillig 6878: </dl></div>
6879: </div>
1.128 wiz 6880: <div class="sect1" title="17.11. The configure phase">
1.75 rillig 6881: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6882: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6883: <p>Most pieces of software need information on the header
6884: files, system calls, and library routines which are available
6885: on the platform they run on. The process of determining this
6886: information is known as configuration, and is usually
6887: automated. In most cases, a script is supplied with the
6888: distfiles, and its invocation results in generation of header
6889: files, Makefiles, etc.</p>
6890: <p>If the package contains a configure script, this can be
6891: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6892: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6893: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6894: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6895: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6896: <pre class="programlisting">
1.100 rillig 6897: .for d in ${CONFIGURE_DIRS}
6898: cd ${WRKSRC} \
6899: && cd ${d} \
6900: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6901: .endfor
6902: </pre>
1.88 wiz 6903: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6904: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6905: <code class="varname">WRKSRC</code>. In each of these directories, the
6906: configure script is run with the environment
6907: <code class="varname">CONFIGURE_ENV</code> and arguments
6908: <code class="varname">CONFIGURE_ARGS</code>. The variables
6909: <code class="varname">CONFIGURE_ENV</code>,
6910: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6911: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6912: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6913: package.</p>
6914: <p>If the program uses an <code class="filename">Imakefile</code>
6915: for configuration, the appropriate steps can be invoked by
6916: setting <code class="varname">USE_IMAKE</code> to
1.128 wiz 6917: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 6918: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6919: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6920: xmkmf's environment by adding them to the
6921: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6922: <p>If the program uses <code class="filename">cmake</code>
6923: for configuration, the appropriate steps can be invoked by
1.128 wiz 6924: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6925: You can add variables to cmake's environment by adding them to the
6926: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6927: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6928: The top directory argument is given by the
6929: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6930: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6931: <p>If there is no configure step at all, set
1.128 wiz 6932: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6933: </div>
1.128 wiz 6934: <div class="sect1" title="17.12. The build phase">
1.75 rillig 6935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6936: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6937: <p>For building a package, a rough equivalent of the
6938: following code is executed.</p>
1.75 rillig 6939: <pre class="programlisting">
1.100 rillig 6940: .for d in ${BUILD_DIRS}
6941: cd ${WRKSRC} \
6942: && cd ${d} \
6943: && env ${MAKE_ENV} \
6944: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6945: -f ${MAKE_FILE} \
6946: ${BUILD_TARGET}
6947: .endfor
6948: </pre>
1.88 wiz 6949: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6950: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6951: <code class="varname">WRKSRC</code>. In each of these directories,
6952: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6953: <code class="varname">MAKE_ENV</code> and arguments
6954: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6955: <code class="varname">MAKE_ENV</code>,
6956: <code class="varname">BUILD_MAKE_FLAGS</code>,
6957: <code class="varname">MAKE_FILE</code> and
6958: <code class="varname">BUILD_TARGET</code> may all be changed by the
6959: package.</p>
1.75 rillig 6960: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6961: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6962: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6963: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6964: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6965: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6966: <p>If there is no build step at all, set
1.128 wiz 6967: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6968: </div>
1.128 wiz 6969: <div class="sect1" title="17.13. The test phase">
1.75 rillig 6970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6971: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6972: <p>[TODO]</p>
6973: </div>
1.128 wiz 6974: <div class="sect1" title="17.14. The install phase">
1.75 rillig 6975: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6976: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6977: <p>Once the build stage has completed, the final step is to
1.88 wiz 6978: install the software in public directories, so users can
6979: access the programs and files.</p>
1.75 rillig 6980: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6981: equivalent of the following code is executed. Additionally,
6982: before and after this code, much magic is performed to do
6983: consistency checks, registering the package, and so on.</p>
6984: <pre class="programlisting">
1.100 rillig 6985: .for d in ${INSTALL_DIRS}
6986: cd ${WRKSRC} \
6987: && cd ${d} \
6988: && env ${MAKE_ENV} \
6989: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6990: -f ${MAKE_FILE} \
6991: ${INSTALL_TARGET}
6992: .endfor
6993: </pre>
1.75 rillig 6994: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6995: <span class="emphasis"><em>build</em></span> phase.
6996: <code class="varname">INSTALL_DIRS</code> defaults to
6997: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6998: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6999: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 7000: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7001: defined.</p>
1.75 rillig 7002: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 7003: variables are useful. They are all variations of the
1.110 hubertf 7004: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88 wiz 7005: permissions preset. <code class="varname">INSTALL</code> is the plain
7006: install command. The specialized variants, together with their
7007: intended use, are:</p>
1.75 rillig 7008: <div class="variablelist"><dl>
7009: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 7010: <dd><p>directories that contain
7011: binaries</p></dd>
1.75 rillig 7012: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 7013: <dd><p>directories that contain
7014: scripts</p></dd>
1.75 rillig 7015: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 7016: <dd><p>directories that contain shared and static
7017: libraries</p></dd>
1.75 rillig 7018: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 7019: <dd><p>directories that contain data
7020: files</p></dd>
1.75 rillig 7021: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 7022: <dd><p>directories that contain man
7023: pages</p></dd>
1.75 rillig 7024: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 7025: <dd><p>binaries that can be stripped from debugging
7026: symbols</p></dd>
1.75 rillig 7027: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 7028: <dd><p>binaries that cannot be
7029: stripped</p></dd>
1.75 rillig 7030: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 7031: <dd><p>game
7032: binaries</p></dd>
1.75 rillig 7033: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 7034: <dd><p>shared and static
7035: libraries</p></dd>
1.75 rillig 7036: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7037: <dd><p>data files</p></dd>
7038: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 7039: <dd><p>data files for
7040: games</p></dd>
1.75 rillig 7041: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7042: <dd><p>man pages</p></dd>
7043: </dl></div>
7044: <p>Some other variables are:</p>
7045: <div class="variablelist"><dl>
7046: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7047: <dd><p>A list of directories relative to
1.88 wiz 7048: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 7049: beginning of the <span class="emphasis"><em>install</em></span> phase.
7050: The package is supposed to create all needed directories itself
7051: before installing files to it and list all other directories here.
7052: </p></dd>
1.75 rillig 7053: </dl></div>
1.97 rillig 7054: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 7055: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 7056: mostly relevant for packages in the <code class="filename">regress</code>
7057: category.</p>
1.75 rillig 7058: </div>
1.128 wiz 7059: <div class="sect1" title="17.15. The package phase">
1.75 rillig 7060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7061: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7062: <p>Once the install stage has completed, a binary package of
7063: the installed files can be built. These binary packages can be
7064: used for quick installation without previous compilation, e.g. by
1.110 hubertf 7065: the <span class="command"><strong>make bin-install</strong></span> or by using
7066: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 7067: <p>By default, the binary packages are created in
7068: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7069: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7070: one for each category in the <code class="varname">CATEGORIES</code>
7071: variable. <code class="varname">PACKAGES</code> defaults to
7072: <code class="filename">pkgsrc/packages</code>.</p>
7073: </div>
1.128 wiz 7074: <div class="sect1" title="17.16. Cleaning up">
1.88 wiz 7075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7076: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 7077: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 7078: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 7079: to clean the work directories of all dependencies too, use
1.110 hubertf 7080: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 7081: </div>
1.128 wiz 7082: <div class="sect1" title="17.17. Other helpful targets">
1.75 rillig 7083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7084: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75 rillig 7085: <div class="variablelist"><dl>
7086: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7087: <dd><p>For any of the main targets described in the
7088: previous section, two auxiliary targets exist with
1.128 wiz 7089: <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 7090: prefix for the main target's name. These targets are
1.88 wiz 7091: invoked before and after the main target is called,
7092: allowing extra configuration or installation steps be
7093: performed from a package's Makefile, for example, which
7094: a program's configure script or install target
7095: omitted.</p></dd>
1.75 rillig 7096: <dt><span class="term">do-*</span></dt>
1.88 wiz 7097: <dd><p>Should one of the main targets do the wrong thing,
7098: and should there be no variable to fix this, you can
7099: redefine it with the do-* target. (Note that redefining
7100: the target itself instead of the do-* target is a bad
7101: idea, as the pre-* and post-* targets won't be called
7102: anymore, etc.) You will not usually need to do
7103: this.</p></dd>
1.75 rillig 7104: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7105: <dd>
1.110 hubertf 7106: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 7107: you noticed some file was not installed properly, you
7108: can repeat the installation with this target, which will
1.128 wiz 7109: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 7110: <p>This is the default value of
7111: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 7112: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 7113: package</strong></span>, where the defaults are
1.128 wiz 7114: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 7115: respectively.</p>
7116: </dd>
1.75 rillig 7117: <dt><span class="term">deinstall</span></dt>
7118: <dd>
1.110 hubertf 7119: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88 wiz 7120: current directory, effectively de-installing the
7121: package. The following variables can be used to tune the
7122: behaviour:</p>
1.75 rillig 7123: <div class="variablelist"><dl>
7124: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110 hubertf 7125: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75 rillig 7126: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7127: <dd><p>Remove all packages that require (depend on)
7128: the given package. This can be used to remove any
7129: packages that may have been pulled in by a given
1.110 hubertf 7130: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 7131: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7132: <code class="filename">pkgsrc/x11/kde</code>, this is
7133: likely to remove whole KDE. Works by adding
1.128 wiz 7134: <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-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88 wiz 7135: command line.</p></dd>
1.75 rillig 7136: </dl></div>
7137: </dd>
1.88 wiz 7138: <dt><span class="term">bin-install</span></dt>
7139: <dd><p>Install a binary package from local disk and via FTP
7140: from a list of sites (see the
7141: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 7142: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 7143: available anywhere. The arguments given to
1.110 hubertf 7144: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 7145: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7146: operation, etc.</p></dd>
1.75 rillig 7147: <dt><span class="term">update</span></dt>
7148: <dd>
1.88 wiz 7149: <p>This target causes the current package to be
7150: updated to the latest version. The package and all
7151: depending packages first get de-installed, then current
7152: versions of the corresponding packages get compiled and
7153: installed. This is similar to manually noting which
7154: packages are currently installed, then performing a
1.110 hubertf 7155: series of <span class="command"><strong>make deinstall</strong></span> and
7156: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7157: <code class="varname">UPDATE_TARGET</code> is set to) for these
7158: packages.</p>
1.128 wiz 7159: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 7160: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7161: update</strong></span> was interrupted for some reason.
7162: However, in this case, make sure you don't call
1.110 hubertf 7163: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7164: list of dependent packages in <code class="varname">WRKDIR</code>.
7165: Otherwise, you lose the ability to automatically update
7166: the current package along with the dependent packages
7167: you have installed.</p>
1.110 hubertf 7168: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7169: update</strong></span> will only work as long as the package
7170: tree remains unchanged. If the source code for one of
7171: the packages to be updated has been changed, resuming
1.110 hubertf 7172: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7173: fail!</p>
7174: <p>The following variables can be used either on the
1.110 hubertf 7175: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7176: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7177: update</strong></span>:</p>
1.75 rillig 7178: <div class="variablelist"><dl>
7179: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7180: <dd><p>Install target to recursively use for the
7181: updated package and the dependent packages.
7182: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 7183: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7184: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 7185: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7186: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7187: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7188: endless loop!</p></dd>
1.75 rillig 7189: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7190: <dd><p>Don't clean up after updating. Useful if
7191: you want to leave the work sources of the updated
7192: packages around for inspection or other purposes.
7193: Be sure you eventually clean up the source tree
1.128 wiz 7194: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7195: or you may run into troubles with old source code
7196: still lying around on your next
1.110 hubertf 7197: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7198: update</strong></span>.</p></dd>
1.75 rillig 7199: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7200: <dd><p>Deinstall each package before installing
7201: (making <code class="varname">DEPENDS_TARGET</code>). This
7202: may be necessary if the
1.128 wiz 7203: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7204: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7205: update</strong></span>.</p></dd>
1.75 rillig 7206: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7207: <dd><p>Allows you to disable recursion and hardcode
7208: the target for packages. The default is
1.128 wiz 7209: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7210: facilitating a recursive update of prerequisite
7211: packages. Only set
7212: <code class="varname">DEPENDS_TARGET</code> if you want to
7213: disable recursive updates. Use
7214: <code class="varname">UPDATE_TARGET</code> instead to just
7215: set a specific target for each package to be
1.110 hubertf 7216: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7217: (see above).</p></dd>
1.75 rillig 7218: </dl></div>
7219: </dd>
7220: <dt><span class="term">clean-update</span></dt>
7221: <dd>
1.88 wiz 7222: <p>Clean the source tree for all packages that would
1.110 hubertf 7223: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7224: from the current directory. This target should not be
7225: used if the current package (or any of its depending
7226: packages) have already been de-installed (e.g., after
1.110 hubertf 7227: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7228: some packages you intended to update. As a rule of
7229: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7230: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7231: and only if you have a dirty package tree (e.g., if you
7232: used <code class="varname">NOCLEAN</code>).</p>
7233: <p>If you are unsure about whether your tree is
1.110 hubertf 7234: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7235: clean</strong></span> at the top of the tree, or use the
7236: following sequence of commands from the directory of the
7237: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7238: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7239: time, otherwise you lose all the packages you wanted to
7240: update!):</p>
1.87 wiz 7241: <pre class="screen">
7242: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7243: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7244: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7245: </pre>
1.88 wiz 7246: <p>The following variables can be used either on the
1.110 hubertf 7247: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7248: <span class="command"><strong>make clean-update</strong></span>:</p>
1.75 rillig 7249: <div class="variablelist"><dl>
7250: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7251: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7252: reconstruct the list of directories to update for
1.110 hubertf 7253: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7254: update</strong></span> successfully installed all
7255: packages you wanted to update. Normally, this is
1.110 hubertf 7256: done automatically on <span class="command"><strong>make
1.88 wiz 7257: update</strong></span>, but may have been suppressed by
7258: the <code class="varname">NOCLEAN</code> variable (see
7259: above).</p></dd>
1.75 rillig 7260: </dl></div>
7261: </dd>
1.88 wiz 7262: <dt><span class="term">replace</span></dt>
7263: <dd>
7264: <p>Update the installation of the current package. This
7265: differs from update in that it does not replace dependent
1.93 rillig 7266: 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 7267: target to work.</p>
7268: <p><span class="emphasis"><em>Be careful when using this
7269: target!</em></span> There are no guarantees that dependent
7270: packages will still work, in particular they will most
1.110 hubertf 7271: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7272: library package whose shared library major version changed
7273: between your installed version and the new one. For this
7274: reason, this target is not officially supported and only
7275: recommended for advanced users.</p>
7276: </dd>
1.75 rillig 7277: <dt><span class="term">info</span></dt>
1.110 hubertf 7278: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88 wiz 7279: package. You can use this to check which version of a
7280: package is installed.</p></dd>
7281: <dt><span class="term">index</span></dt>
7282: <dd>
7283: <p>This is a top-level command, i.e. it should be used in
7284: the <code class="filename">pkgsrc</code> directory. It creates a
7285: database of all packages in the local pkgsrc tree, including
7286: dependencies, comment, maintainer, and some other useful
7287: information. Individual entries are created by running
1.110 hubertf 7288: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7289: directories. This index file is saved as
7290: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7291: verbose format by running <span class="command"><strong>make
1.88 wiz 7292: print-index</strong></span>. You can search in it with
1.110 hubertf 7293: <span class="command"><strong>make search
1.88 wiz 7294: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7295: extract a list of all packages that depend on a particular
1.110 hubertf 7296: one by running <span class="command"><strong>make show-deps
1.88 wiz 7297: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7298: <p>Running this command takes a very long time, some
7299: hours even on fast machines!</p>
7300: </dd>
1.75 rillig 7301: <dt><span class="term">readme</span></dt>
1.88 wiz 7302: <dd>
7303: <p>This target generates a
7304: <code class="filename">README.html</code> file, which can be
1.91 rillig 7305: 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 7306: contain references to any packages which are in the
7307: <code class="varname">PACKAGES</code> directory on the local
7308: host. The generated files can be made to refer to URLs
7309: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7310: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7311: wanted to generate <code class="filename">README.html</code>
7312: files which pointed to binary packages on the local
7313: machine, in the directory
7314: <code class="filename">/usr/packages</code>, set
7315: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7316: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7317: <code class="varname">${PACKAGES}</code> directory and its
7318: subdirectories will be searched for all the binary
7319: packages.</p>
7320: <p>The target can be run at the toplevel or in category
7321: directories, in which case it descends recursively.</p>
7322: </dd>
1.75 rillig 7323: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7324: <dd><p>This is a top-level command, run it in
7325: <code class="filename">pkgsrc</code>. Use this target to create a
7326: file <code class="filename">README-all.html</code> which contains a
7327: list of all packages currently available in the NetBSD
7328: Packages Collection, together with the category they belong
7329: to and a short description. This file is compiled from the
7330: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7331: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7332: readme</strong></span>.</p></dd>
1.75 rillig 7333: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7334: <dd><p>This is very much the same as the
1.128 wiz 7335: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7336: used when generating a pkgsrc tree to be written to a
7337: CD-ROM. This target also produces
7338: <code class="filename">README.html</code> files, and can be made
7339: to refer to URLs based on
7340: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7341: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7342: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7343: <dd><p>This target shows which distfiles and patchfiles
7344: are needed to build the package
7345: (<code class="varname">ALLFILES</code>, which contains all
7346: <code class="varname">DISTFILES</code> and
1.87 wiz 7347: <code class="varname">PATCHFILES</code>, but not
7348: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7349: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7350: <dd><p>This target shows nothing if the package is not
7351: installed. If a version of this package is installed,
7352: but is not the version provided in this version of
7353: pkgsrc, then a warning message is displayed. This target
7354: can be used to show which of your installed packages are
7355: downlevel, and so the old versions can be deleted, and
7356: the current ones added.</p></dd>
1.75 rillig 7357: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7358: <dd><p>This target shows the directory in the pkgsrc
7359: hierarchy from which the package can be built and
7360: installed. This may not be the same directory as the one
7361: from which the package was installed. This target is
7362: intended to be used by people who may wish to upgrade
7363: many packages on a single host, and can be invoked from
7364: the top-level pkgsrc Makefile by using the
1.128 wiz 7365: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7366: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7367: <dd><p>This target shows which installed packages match
7368: the current package's <code class="varname">DEPENDS</code>. Useful
7369: if out of date dependencies are causing build
7370: problems.</p></dd>
1.75 rillig 7371: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7372: <dd><p>After a package is installed, check all its
7373: binaries and (on ELF platforms) shared libraries to see
7374: if they find the shared libs they need. Run by default
1.110 hubertf 7375: 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 7376: <dt><span class="term">print-PLIST</span></dt>
7377: <dd>
1.128 wiz 7378: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7379: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7380: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7381: -newer work/.extract_done</strong></span>. An attempt is made
7382: to care for shared libs etc., but it is
1.87 wiz 7383: <span class="emphasis"><em>strongly</em></span> recommended to review the
7384: result before putting it into
7385: <code class="filename">PLIST</code>. On upgrades, it's useful to
7386: diff the output of this command against an already
7387: existing <code class="filename">PLIST</code> file.</p>
1.110 hubertf 7388: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88 wiz 7389: other methods that don't update file access times, be
7390: sure to add these files manually to your
1.128 wiz 7391: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7392: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7393: them!</p>
1.128 wiz 7394: <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 7395: information on this target.</p>
1.75 rillig 7396: </dd>
7397: <dt><span class="term">bulk-package</span></dt>
7398: <dd>
1.88 wiz 7399: <p>Used to do bulk builds. If an appropriate binary
7400: package already exists, no action is taken. If not, this
7401: target will compile, install and package it (and its
7402: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110 hubertf 7403: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.88 wiz 7404: After creating the binary package, the sources, the
7405: just-installed package and its required packages are
7406: removed, preserving free disk space.</p>
7407: <p><span class="emphasis"><em>Beware that this target may deinstall
7408: all packages installed on a system!</em></span></p>
1.75 rillig 7409: </dd>
7410: <dt><span class="term">bulk-install</span></dt>
7411: <dd>
1.88 wiz 7412: <p>Used during bulk-installs to install required
7413: packages. If an up-to-date binary package is available,
1.110 hubertf 7414: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
7415: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7416: but the installed binary won't be removed.</p>
1.88 wiz 7417: <p>A binary package is considered
1.128 wiz 7418: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.110 hubertf 7419: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.128 wiz 7420: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
7421: <li class="listitem"><p>None of the package's files
1.88 wiz 7422: (<code class="filename">Makefile</code>, ...) were modified
7423: since it was built.</p></li>
1.128 wiz 7424: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7425: packages were modified since it was built.</p></li>
1.75 rillig 7426: </ul></div>
1.88 wiz 7427: <p><span class="emphasis"><em>Beware that this target may deinstall
7428: all packages installed on a system!</em></span></p>
1.75 rillig 7429: </dd>
7430: </dl></div>
7431: </div>
7432: </div>
1.128 wiz 7433: <div class="chapter" title="Chapter 18. Tools needed for building or running">
1.75 rillig 7434: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7435: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7436: <div class="toc">
7437: <p><b>Table of Contents</b></p>
7438: <dl>
1.106 rillig 7439: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7440: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7441: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7442: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7443: </dl>
7444: </div>
1.87 wiz 7445: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7446: by pkgsrc and also for individual packages to define what commands
7447: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7448: or for later run-time of an installed packaged (such as
7449: <code class="varname">DEPENDS</code>).
7450: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7451: package will not be used.</p>
7452: <p>When building a package, the replacement tools are
1.75 rillig 7453: made available in a directory (as symlinks or wrapper scripts)
7454: that is early in the executable search path. Just like the buildlink
1.87 wiz 7455: system, this helps with consistent builds.</p>
7456: <p>A tool may be needed to help build a specific package. For example,
7457: perl, GNU make (gmake) or yacc may be needed.</p>
7458: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7459: tool may be inefficient for building a package with pkgsrc.
7460: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7461: yacc) or a better sed.</p>
7462: <p>The tools used by a package can be listed by running
1.110 hubertf 7463: <span class="command"><strong>make show-tools</strong></span>.</p>
1.128 wiz 7464: <div class="sect1" title="18.1. Tools for pkgsrc builds">
1.75 rillig 7465: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7466: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7467: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7468: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7469: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7470: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7471: These can be seen by running:
1.110 hubertf 7472: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7473: <p>If a package needs a specific program to build
1.75 rillig 7474: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7475: to define the tools needed.</p>
1.75 rillig 7476: </div>
1.128 wiz 7477: <div class="sect1" title="18.2. Tools needed by packages">
1.75 rillig 7478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7479: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7480: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7481: and not the native version for a build dependency.
7482: And the :run means that it is used for a
7483: run-time dependencies also (and becomes a DEPENDS).
7484: The default is a build dependency which can be set with
7485: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7486: and pkg-config:build.)</p>
1.75 rillig 7487: <pre class="programlisting">
7488: USE_TOOLS+= mktemp:pkgsrc
7489: USE_TOOLS+= gmake perl:run pkg-config
7490: </pre>
1.87 wiz 7491: <p>When using the tools framework, a
1.75 rillig 7492: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7493: which contains the full path to the appropriate tool. For example,
1.128 wiz 7494: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7495: on Linux systems.</p>
7496: <p>If you always need a pkgsrc version of the
1.75 rillig 7497: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7498: </p>
7499: </div>
1.128 wiz 7500: <div class="sect1" title="18.3. Tools provided by platforms">
1.75 rillig 7501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7502: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7503: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7504: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7505: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7506: the name of the common tools. For example:</p>
7507: <pre class="programlisting">
7508: .if exists(/usr/bin/bzcat)
7509: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7510: .elif exists(/usr/bin/bzip2)
7511: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7512: .endif
1.69 rillig 7513:
1.75 rillig 7514: TOOLS_PLATFORM.true?= true # shell builtin
7515: </pre>
7516: </div>
1.128 wiz 7517: <div class="sect1" title="18.4. Questions regarding the tools">
1.97 rillig 7518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7519: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.128 wiz 7520: <div class="qandaset" title="Frequently Asked Questions">
1.129 ! wiz 7521: <a name="id1168230185675"></a><dl>
1.106 rillig 7522: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7523: </dt>
1.106 rillig 7524: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7525: tools?</a>
7526: </dt>
1.106 rillig 7527: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7528: package is using while being built? I want to know whether it
7529: uses sed or not.</a>
7530: </dt>
7531: </dl>
1.128 wiz 7532: <table border="0" width="100%" summary="Q and A Set">
1.97 rillig 7533: <col align="left" width="1%">
1.128 wiz 7534: <col>
1.97 rillig 7535: <tbody>
1.128 wiz 7536: <tr class="question" title="18.4.1.">
1.97 rillig 7537: <td align="left" valign="top">
1.129 ! wiz 7538: <a name="tools.new"></a><a name="id1168230185748"></a><p><b>18.4.1.</b></p>
1.97 rillig 7539: </td>
7540: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7541: </tr>
7542: <tr class="answer">
7543: <td align="left" valign="top"></td>
7544: <td align="left" valign="top"><p>TODO</p></td>
7545: </tr>
1.128 wiz 7546: <tr class="question" title="18.4.2.">
1.97 rillig 7547: <td align="left" valign="top">
1.129 ! wiz 7548: <a name="tools.listall"></a><a name="id1168230185756"></a><p><b>18.4.2.</b></p>
1.97 rillig 7549: </td>
7550: <td align="left" valign="top"><p>How do I get a list of all available
7551: tools?</p></td>
7552: </tr>
7553: <tr class="answer">
7554: <td align="left" valign="top"></td>
7555: <td align="left" valign="top"><p>TODO</p></td>
7556: </tr>
1.128 wiz 7557: <tr class="question" title="18.4.3.">
1.97 rillig 7558: <td align="left" valign="top">
1.129 ! wiz 7559: <a name="tools.used"></a><a name="id1168230185765"></a><p><b>18.4.3.</b></p>
1.97 rillig 7560: </td>
7561: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7562: package is using while being built? I want to know whether it
7563: uses sed or not.</p></td>
7564: </tr>
7565: <tr class="answer">
7566: <td align="left" valign="top"></td>
7567: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7568: to do it.)</p></td>
7569: </tr>
7570: </tbody>
7571: </table>
7572: </div>
7573: </div>
1.75 rillig 7574: </div>
1.128 wiz 7575: <div class="chapter" title="Chapter 19. Making your package work">
1.75 rillig 7576: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7577: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7578: <div class="toc">
7579: <p><b>Table of Contents</b></p>
7580: <dl>
1.106 rillig 7581: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7582: <dd><dl>
1.106 rillig 7583: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 7584: <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 7585: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7586: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7587: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7588: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7589: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7590: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7591: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7592: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7593: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7594: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7595: </dl></dd>
1.128 wiz 7596: <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 7597: <dd><dl>
7598: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7599: <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>
7600: </dl></dd>
1.128 wiz 7601: <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 7602: <dd><dl>
7603: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7604: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7605: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7606: </dl></dd>
7607: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7608: <dd><dl>
7609: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7610: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7611: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7612: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7613: </dl></dd>
1.128 wiz 7614: <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 7615: <dd><dl>
7616: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7617: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 7618: <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 7619: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7620: </dl></dd>
1.128 wiz 7621: <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 7622: <dd><dl>
7623: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7624: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7625: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7626: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7627: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7628: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7629: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7630: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7631: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7632: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7633: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7634: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7635: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7636: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7637: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7638: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7639: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7640: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7641: emulation</a></span></dt>
1.106 rillig 7642: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7643: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7644: </dl></dd>
1.106 rillig 7645: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7646: </dl>
7647: </div>
1.128 wiz 7648: <div class="sect1" title="19.1. General operation">
1.75 rillig 7649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7650: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.128 wiz 7651: <div class="sect2" title="19.1.1. Portability of packages">
1.75 rillig 7652: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7653: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7654: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7655: different platforms. As a result, it is important to ensure,
7656: where possible, that packages in pkgsrc are portable. This
7657: chapter mentions some particular details you should pay
7658: attention to while working on pkgsrc.</p>
1.78 rillig 7659: </div>
1.128 wiz 7660: <div class="sect2" title="19.1.2. How to pull in user-settable variables from mk.conf">
1.78 rillig 7661: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7662: <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 7663: </h3></div></div></div>
1.78 rillig 7664: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7665: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7666: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7667: want to use those variables in the preprocessor directives of
1.110 hubertf 7668: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 7669: <code class="literal">.for</code>), you need to include the file
7670: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7671: loads the user preferences.</p>
1.78 rillig 7672: <p>But note that some variables may not be completely defined
1.87 wiz 7673: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7674: included, as they may contain references to variables that are
7675: not yet defined. In shell commands this is no problem, since
7676: variables are actually macros, which are only expanded when they
7677: are used. But in the preprocessor directives mentioned above and
7678: in dependency lines (of the form <code class="literal">target:
7679: dependencies</code>) the variables are expanded at load
7680: time.</p>
1.128 wiz 7681: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7682: <h3 class="title">Note</h3>
7683: <p>Currently there is no exhaustive list of all
1.87 wiz 7684: variables that tells you whether they can be used at load time
7685: or only at run time, but it is in preparation.</p>
1.78 rillig 7686: </div>
7687: </div>
1.128 wiz 7688: <div class="sect2" title="19.1.3. User interaction">
1.78 rillig 7689: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7690: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7691: <p>Occasionally, packages require interaction from the user,
7692: and this can be in a number of ways:</p>
1.128 wiz 7693: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
7694: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7695: interaction such as entering username/password or accepting a
7696: license on a web page.</p></li>
1.128 wiz 7697: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7698: passwords.</p></li>
1.128 wiz 7699: <li class="listitem"><p>help to configure the package before it is built</p></li>
7700: <li class="listitem"><p>help during the build process</p></li>
7701: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7702: </ul></div>
1.88 wiz 7703: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7704: provided to notify the pkgsrc mechanism of an interactive stage
7705: which will be needed, and this should be set in the package's
7706: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7707: <pre class="programlisting">
1.100 rillig 7708: INTERACTIVE_STAGE= build
1.87 wiz 7709: </pre>
1.78 rillig 7710: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7711: <pre class="programlisting">
1.100 rillig 7712: INTERACTIVE_STAGE= configure install
1.87 wiz 7713: </pre>
1.88 wiz 7714: <p>The user can then decide to skip this package by setting the
7715: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7716: </div>
1.128 wiz 7717: <div class="sect2" title="19.1.4. Handling licenses">
1.75 rillig 7718: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7719: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7720: <p>Authors of software can choose the licence under which
7721: software can be copied. This is due to copyright law, and reasons
7722: for license choices are outside the scope of pkgsrc. The pkgsrc
7723: system recognizes that there are a number of licenses which some
7724: users may find objectionable or difficult or impossible to comply
7725: with. The Free Software Foundation has declared some licenses
7726: "Free", and the Open Source Initiative has a definition of "Open
7727: Source". The pkgsrc system, as a policy choice, does not label
7728: packages which have licenses that are Free or Open Source.
7729: However, packages without a license meeting either of those tests
7730: are labeled with a license tag denoting the license. Note that a
7731: package with no license to copy trivially does not meet either the
7732: Free or Open Source test.</p>
7733: <p>For packages which are not Free or Open Source, pkgsrc will
7734: not build the package unless the user has indicated to pkgsrc that
7735: packages with that particular license may be built. Note that
7736: this documentation avoids the term "accepted the license". The
7737: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7738: accidentally building a package with a non-free license;
1.98 wiz 7739: judgement and responsibility remain with the user. (Installation
7740: of binary packages are not currently subject to this mechanism;
7741: this is a bug.)</p>
7742: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7743: or the GPL, and not the other. The free licenses are added to the
7744: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7745: user can override the default by setting the
7746: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7747: of "+=". The licenses accepted by default are:
7748: </p>
7749: <pre class="programlisting">
7750: public-domain
7751: gnu-gpl-v2 gnu-lgpl-v2
7752: gnu-gpl-v3 gnu-lgpl-v3
7753: original-bsd modified-bsd
7754: x11
7755: apache-2.0
7756: cddl-1.0
7757: open-font-license
7758: </pre>
7759: <p>
7760: </p>
1.78 rillig 7761: <p>The license tag mechanism is intended to address
1.87 wiz 7762: copyright-related issues surrounding building, installing and
7763: using a package, and not to address redistribution issues (see
7764: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7765: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7766: Packages with redistribution restrictions should set these
7767: tags.</p>
1.98 wiz 7768: <p>Denoting that a package may be copied according to a
7769: particular license is done by placing the license in
1.87 wiz 7770: <code class="filename">pkgsrc/licenses</code> and setting the
7771: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7772: 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 7773: <pre class="programlisting">
1.100 rillig 7774: LICENSE= xv-license
1.87 wiz 7775: </pre>
7776: <p>When trying to build, the user will get a notice that the
1.98 wiz 7777: package is covered by a license which has not been placed in the
7778: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7779: <pre class="programlisting">
1.100 rillig 7780: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7781: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7782: ===> To view the license, enter "/usr/bin/make show-license".
7783: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7784: ===> ACCEPTABLE_LICENSES+=xv-license
7785: *** Error code 1
1.87 wiz 7786: </pre>
1.110 hubertf 7787: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7788: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7789: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7790: convey to pkgsrc that it should not in the future fail because of
7791: that license:</p>
1.78 rillig 7792: <pre class="programlisting">
1.100 rillig 7793: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7794: </pre>
1.98 wiz 7795: <p>When adding a package with a new license, the license text
7796: should be added to <code class="filename">pkgsrc/licenses</code> for
7797: displaying. A list of known licenses can be seen in this
1.91 rillig 7798: directory.</p>
1.98 wiz 7799: <p>When the license changes (in a way other than formatting),
7800: please make sure that the new license has a different name (e.g.,
7801: append the version number if it exists, or the date). Just
7802: because a user told pkgsrc to build programs under a previous
7803: version of a license does not mean that pkgsrc should build
1.99 rillig 7804: programs under the new licenses. The higher-level point is that
1.98 wiz 7805: pkgsrc does not evaluate licenses for reasonableness; the only
7806: test is a mechanistic test of whether a particular text has been
7807: approved by either of two bodies.</p>
1.78 rillig 7808: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7809: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7810: is deprecated because it does not crisply refer to a particular
7811: license text. Another problem with such usage is that it does not
7812: enable a user to tell pkgsrc to proceed for a single package
7813: without also telling pkgsrc to proceed for all packages with that
7814: tag.</p>
1.75 rillig 7815: </div>
1.128 wiz 7816: <div class="sect2" title="19.1.5. Restricted packages">
1.75 rillig 7817: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7818: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7819: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7820: Because a license tag is required unless the package is Free or
7821: Open Source, all packages with restrictions should have license
7822: tags. By declaring the restrictions, package tools can
7823: automatically refrain from e.g. placing binary packages on FTP
7824: sites.</p>
7825: <p>There are four restrictions that may be encoded, which are
7826: the cross product of sources (distfiles) and binaries not being
7827: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7828: language in any license, and because non-Free licenses tend to be
7829: different from each other, pkgsrc adopts a definition of FTP and
7830: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7831: should not be made available over the Internet at no charge.
7832: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7833: made available on some kind of media, together with other source
7834: and binary packages, and which is sold for a distribution charge.
7835: </p>
7836: <p>In order to encode these restrictions, the package system
1.87 wiz 7837: defines five make variables that can be set to note these
7838: restrictions:</p>
1.128 wiz 7839: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
7840: <li class="listitem">
1.75 rillig 7841: <p><code class="varname">RESTRICTED</code></p>
7842: <p>This variable should be set whenever a restriction
1.87 wiz 7843: exists (regardless of its kind). Set this variable to a
1.98 wiz 7844: string containing the reason for the restriction. It should
7845: be understood that those wanting to understand the restriction
7846: will have to read the license, and perhaps seek advice of
7847: counsel.</p>
1.75 rillig 7848: </li>
1.128 wiz 7849: <li class="listitem">
1.75 rillig 7850: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7851: <p>Binaries may not be placed on CD-ROM containing other
7852: binary packages, for which a distribution charge may be made.
7853: In this case, set this variable to
7854: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7855: </li>
1.128 wiz 7856: <li class="listitem">
1.75 rillig 7857: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7858: <p>Binaries may not made available on the Internet without
7859: charge. In this case, set this variable to
7860: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7861: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7862: </li>
1.128 wiz 7863: <li class="listitem">
1.75 rillig 7864: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7865: <p>Distfiles may not be placed on CD-ROM, together with
7866: other distfiles, for which a fee may be charged. In this
7867: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7868: </p>
1.75 rillig 7869: </li>
1.128 wiz 7870: <li class="listitem">
1.75 rillig 7871: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7872: <p>Distfiles may not made available via FTP at no charge.
7873: In this case, set this variable to
7874: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7875: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7876: </li>
7877: </ul></div>
7878: </div>
1.128 wiz 7879: <div class="sect2" title="19.1.6. Handling dependencies">
1.75 rillig 7880: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7881: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7882: <p>Your package may depend on some other package being present
1.88 wiz 7883: - and there are various ways of expressing this dependency.
7884: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7885: <code class="varname">DEPENDS</code> definitions, the
7886: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7887: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7888: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7889: 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 7890: <p>The basic difference between the two variables is as
1.87 wiz 7891: follows: The <code class="varname">DEPENDS</code> definition registers
7892: that pre-requisite in the binary package so it will be pulled in
7893: when the binary package is later installed, whilst the
7894: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7895: dependency that is only needed for building the package.</p>
1.75 rillig 7896: <p>This means that if you only need a package present whilst
1.87 wiz 7897: you are building, it should be noted as a
7898: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7899: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7900: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7901: <pre class="programlisting">
1.100 rillig 7902: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7903: </pre>
1.128 wiz 7904: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7905: may include any of the wildcard version numbers recognized by
1.110 hubertf 7906: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7907: <div class="orderedlist"><ol class="orderedlist" type="1">
7908: <li class="listitem">
1.75 rillig 7909: <p>If your package needs another package's binaries or
1.87 wiz 7910: libraries to build or run, and if that package has a
7911: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7912: <pre class="programlisting">
1.100 rillig 7913: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7914: </pre>
1.75 rillig 7915: </li>
1.128 wiz 7916: <li class="listitem">
1.75 rillig 7917: <p>If your package needs to use another package to build
1.87 wiz 7918: itself and there is no <code class="filename">buildlink3.mk</code>
7919: file available, use the <code class="varname">BUILD_DEPENDS</code>
7920: definition:</p>
1.75 rillig 7921: <pre class="programlisting">
1.100 rillig 7922: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87 wiz 7923: </pre>
1.75 rillig 7924: </li>
1.128 wiz 7925: <li class="listitem">
1.75 rillig 7926: <p>If your package needs a library with which to link and
1.76 rillig 7927: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7928: available, this is specified using the
7929: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7930: <pre class="programlisting">
1.100 rillig 7931: DEPENDS+= xpm-3.4j:../../graphics/xpm
1.87 wiz 7932: </pre>
1.109 rillig 7933: <p>You can also use wildcards in package dependencies:</p>
1.75 rillig 7934: <pre class="programlisting">
1.100 rillig 7935: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
1.87 wiz 7936: </pre>
1.75 rillig 7937: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7938: creating binary packages. The dependency is checked when
7939: installing the binary package and any package which matches
7940: the pattern will be used. Wildcard dependencies should be
7941: used with care.</p>
1.128 wiz 7942: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7943: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7944: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7945: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7946: <p>Wildcards can also be used to specify that a package
1.87 wiz 7947: will only build against a certain minimum version of a
7948: pre-requisite:</p>
1.75 rillig 7949: <pre class="programlisting">
1.100 rillig 7950: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
1.87 wiz 7951: </pre>
1.75 rillig 7952: <p>This means that the package will build against version
1.87 wiz 7953: 3.5.4 of the tiff library or newer. Such a dependency may
7954: be warranted if, for example, the API of the library has
7955: changed with version 3.5.4 and a package would not compile
7956: against an earlier version of tiff.</p>
1.75 rillig 7957: <p>Please note that such dependencies should only be
1.87 wiz 7958: updated if a package requires a newer pre-requisite, but
1.93 rillig 7959: not to denote recommendations such as
1.87 wiz 7960: ABI changes that do not prevent a package from building
7961: correctly. Such recommendations can be expressed using
7962: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7963: <pre class="programlisting">
1.100 rillig 7964: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
1.87 wiz 7965: </pre>
1.75 rillig 7966: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7967: line, this denotes that while a package will build against
7968: tiff>=3.5.4, at least version 3.6.1 is recommended.
7969: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7970: dependencies unless explicitly ignored (in which case a
7971: warning will be printed).</p>
1.75 rillig 7972: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7973: use the required <code class="varname">DEPENDS</code>, set
7974: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7975: it easier and faster to update packages built using pkgsrc,
7976: since older compatible dependencies can continue to be
7977: used. This is useful for people who watch their rebuilds
7978: very carefully; it is not very good as a general-purpose
7979: hammer. If you use it, you need to be mindful of possible
7980: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7981: <p>Packages that are built with recommendations ignored
1.87 wiz 7982: may not be uploaded to ftp.NetBSD.org by developers and
7983: should not be used across different systems that may have
7984: different versions of binary packages installed.</p>
1.75 rillig 7985: <p>For security fixes, please update the package
1.110 hubertf 7986: 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 7987: information.</p>
1.75 rillig 7988: </li>
1.128 wiz 7989: <li class="listitem">
1.75 rillig 7990: <p>If your package needs some executable to be able to run
1.87 wiz 7991: correctly and if there's no
7992: <code class="filename">buildlink3.mk</code> file, this is specified
7993: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 7994: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.87 wiz 7995: be able to execute the latex binary from the teTeX package
7996: when it runs, and that is specified:</p>
1.75 rillig 7997: <pre class="programlisting">
1.100 rillig 7998: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7999: </pre>
1.75 rillig 8000: <p>The comment about wildcard dependencies from previous
1.87 wiz 8001: paragraph applies here, too.</p>
1.75 rillig 8002: </li>
8003: </ol></div>
8004: <p>If your package needs files from another package to build,
1.87 wiz 8005: add the relevant distribution files to
8006: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 8007: 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 8008: (It relies on the jpeg sources being present in source form
8009: during the build.)</p>
1.75 rillig 8010: </div>
1.128 wiz 8011: <div class="sect2" title="19.1.7. Handling conflicts with other packages">
1.75 rillig 8012: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8013: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 8014: <p>Your package may conflict with other packages a user might
1.87 wiz 8015: already have installed on his system, e.g. if your package
1.88 wiz 8016: installs the same set of files as another package in the pkgsrc
8017: tree.</p>
1.75 rillig 8018: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 8019: space-separated list of packages (including version string) your
8020: package conflicts with.</p>
1.91 rillig 8021: <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>
8022: 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 8023: install the same shared library, thus you set in
8024: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8025: <pre class="programlisting">
1.100 rillig 8026: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 8027: </pre>
8028: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 8029: <pre class="programlisting">
1.100 rillig 8030: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 8031: </pre>
1.75 rillig 8032: <p>Packages will automatically conflict with other packages
1.87 wiz 8033: with the name prefix and a different version
1.128 wiz 8034: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
8035: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.75 rillig 8036: </div>
1.128 wiz 8037: <div class="sect2" title="19.1.8. Packages that cannot or should not be built">
1.75 rillig 8038: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8039: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 8040: <p>There are several reasons why a package might be
1.88 wiz 8041: instructed to not build under certain circumstances. If the
1.87 wiz 8042: package builds and runs on most platforms, the exceptions
8043: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8044: the package builds and runs on a small handful of platforms,
8045: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8046: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8047: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8048: (OS-version-platform) that can use glob-style
8049: wildcards.</p>
1.88 wiz 8050: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8051: 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 8052: backwards compatible with other versions of the OS, and should be
8053: uploaded to a version specific directory on the FTP server. Mark
8054: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 8055: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 8056: the package system internals, but may be used in the
8057: future.</p>
1.75 rillig 8058: <p>If the package should be skipped (for example, because it
1.87 wiz 8059: provides functionality already provided by the system), set
1.88 wiz 8060: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8061: the package should fail because some preconditions are not met,
8062: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8063: message.</p>
1.75 rillig 8064: </div>
1.128 wiz 8065: <div class="sect2" title="19.1.9. Packages which should not be deleted, once installed">
1.75 rillig 8066: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8067: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8068: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8069: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8070: be set in the package Makefile. This will be carried into any
8071: binary package that is made from this pkgsrc entry. A
1.128 wiz 8072: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.110 hubertf 8073: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128 wiz 8074: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 8075: </div>
1.128 wiz 8076: <div class="sect2" title="19.1.10. Handling packages with security problems">
1.75 rillig 8077: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8078: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8079: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8080: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110 hubertf 8081: and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87 wiz 8082: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 8083: <p>After fixing the vulnerability by a patch, its
1.87 wiz 8084: <code class="varname">PKGREVISION</code> should be increased (this
8085: is of course not necessary if the problem is fixed by using
8086: a newer release of the software).</p>
1.75 rillig 8087: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8088: branch, be sure to submit a pullup request!</p>
1.75 rillig 8089: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8090: semi-automatically by a weekly cron job.</p>
1.75 rillig 8091: </div>
1.128 wiz 8092: <div class="sect2" title="19.1.11. How to handle incrementing versions when fixing an existing package">
1.75 rillig 8093: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8094: <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 8095: <p>When making fixes to an existing package it can be useful
1.87 wiz 8096: to change the version number in <code class="varname">PKGNAME</code>. To
8097: avoid conflicting with future versions by the original author, a
1.128 wiz 8098: <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 8099: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 8100: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
8101: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 8102: <pre class="programlisting">
1.100 rillig 8103: DISTNAME= foo-17.42
8104: PKGREVISION= 9
1.87 wiz 8105: </pre>
1.75 rillig 8106: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 8107: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
8108: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 8109: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8110: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8111: <p>When a new release of the package is released, the
1.87 wiz 8112: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8113: minor release of the above package, things should be like:</p>
1.75 rillig 8114: <pre class="programlisting">
1.100 rillig 8115: DISTNAME= foo-17.43
1.87 wiz 8116: </pre>
8117: <p><code class="varname">PKGREVISION</code> should be incremented for any
8118: non-trivial change in the resulting binary package. Without a
8119: <code class="varname">PKGREVISION</code> bump, someone with the previous
8120: version installed has no way of knowing that their package is out
8121: of date. Thus, changes without increasing
8122: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8123: trivial that no reasonable person would want to upgrade", and this
8124: is the rough test for when increasing
8125: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8126: changes that do not merit increasing
8127: <code class="varname">PKGREVISION</code> are:</p>
1.128 wiz 8128: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8129: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 8130: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8131: or comments in Makefile.</p></li>
1.128 wiz 8132: <li class="listitem"><p>
1.100 rillig 8133: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 8134: <li class="listitem"><p>
1.100 rillig 8135: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 8136: <li class="listitem"><p>
1.100 rillig 8137: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8138: </ul></div>
1.87 wiz 8139: <p>Examples of changes that do merit an increase to
8140: <code class="varname">PKGREVISION</code> include:</p>
1.128 wiz 8141: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8142: <li class="listitem"><p>
1.100 rillig 8143: Security fixes</p></li>
1.128 wiz 8144: <li class="listitem"><p>
1.100 rillig 8145: Changes or additions to a patch file</p></li>
1.128 wiz 8146: <li class="listitem"><p>
1.100 rillig 8147: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 8148: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8149: </ul></div>
1.78 rillig 8150: <p>PKGREVISION must also be incremented when dependencies have ABI
8151: changes.</p>
1.75 rillig 8152: </div>
1.128 wiz 8153: <div class="sect2" title="19.1.12. Substituting variable text in the package files (the SUBST framework)">
1.79 rillig 8154: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8155: <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 8156: <p>When you want to replace the same text in multiple files
1.87 wiz 8157: or when the replacement text varies, patches alone cannot help.
8158: This is where the SUBST framework comes in. It provides an
8159: easy-to-use interface for replacing text in files.
8160: Example:</p>
8161: <pre class="programlisting">
1.100 rillig 8162: SUBST_CLASSES+= fix-paths
8163: SUBST_STAGE.fix-paths= pre-configure
8164: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8165: SUBST_FILES.fix-paths= src/*.c
8166: SUBST_FILES.fix-paths+= scripts/*.sh
8167: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8168: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8169: </pre>
1.79 rillig 8170: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8171: that are used to identify the different SUBST blocks that are
8172: defined. The SUBST framework is heavily used by pkgsrc, so it is
8173: important to always use the <code class="literal">+=</code> operator with
8174: this variable. Otherwise some substitutions may be
8175: skipped.</p>
1.79 rillig 8176: <p>The remaining variables of each SUBST block are
1.87 wiz 8177: parameterized with the identifier from the first line
8178: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8179: parameters to a function call.</p>
1.79 rillig 8180: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8181: which the replacement will take place. All combinations of
8182: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8183: <code class="literal">post-</code> together with a phase name are
8184: possible, though only few are actually used. Most commonly used
8185: are <code class="literal">post-patch</code> and
8186: <code class="literal">pre-configure</code>. Of these two,
8187: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8188: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8189: have the state after applying the patches but before making any
8190: other changes. This is especially useful when you are debugging
8191: a package in order to create new patches for it. Similarly,
8192: <code class="literal">post-build</code> is preferred over
8193: <code class="literal">pre-install</code>, because the install phase should
8194: generally be kept as simple as possible. When you use
8195: <code class="literal">post-build</code>, you have the same files in the
8196: working directory that will be installed later, so you can check
8197: if the substitution has succeeded.</p>
1.79 rillig 8198: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8199: that is printed just before the substitution is done.</p>
1.79 rillig 8200: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8201: globbing patterns that specifies the files in which the
8202: substitution will take place. The patterns are interpreted
8203: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8204: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110 hubertf 8205: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87 wiz 8206: command should be prefixed with <code class="literal">-e</code>, so that
8207: all SUBST blocks look uniform.</p>
1.79 rillig 8208: <p>There are some more variables, but they are so seldomly
1.87 wiz 8209: used that they are only documented in the
8210: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8211: </div>
1.75 rillig 8212: </div>
1.128 wiz 8213: <div class="sect1" title="19.2. Fixing problems in the fetch phase">
1.75 rillig 8214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8215: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.128 wiz 8216: <div class="sect2" title="19.2.1. Packages whose distfiles aren't available for plain downloading">
1.75 rillig 8217: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8218: <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 8219: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8220: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8221: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8222: with the name of each file to download as an argument, expecting
8223: it to output the URL of the directory from which to download
1.91 rillig 8224: 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 8225: example of this usage.</p>
1.75 rillig 8226: <p>If the download can't be automated, because the user must
1.87 wiz 8227: submit personal information to apply for a password, or must pay
8228: for the source, or whatever, you can set
8229: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8230: displayed to the user before aborting the build. Example:</p>
8231: <pre class="programlisting">
1.100 rillig 8232: FETCH_MESSAGE= "Please download the files"
8233: FETCH_MESSAGE+= " "${DISTFILES:Q}
8234: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8235: </pre>
1.75 rillig 8236: </div>
1.128 wiz 8237: <div class="sect2" title="19.2.2. How to handle modified distfiles with the 'old' name">
1.75 rillig 8238: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8239: <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 8240: <p>Sometimes authors of a software package make some
1.87 wiz 8241: modifications after the software was released, and they put up a
8242: new distfile without changing the package's version number. If a
8243: package is already in pkgsrc at that time, the checksum will
8244: no longer match. The contents of the new distfile should be
8245: compared against the old one before changing anything, to make
8246: sure the distfile was really updated on purpose, and that
8247: no trojan horse or so crept in.
1.97 rillig 8248: Please mention that the distfiles were compared and what was found
8249: in your commit message.
1.87 wiz 8250: Then, the correct way to work around this is to
8251: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8252: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8253: <code class="varname">DISTFILES</code> and
1.93 rillig 8254: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8255: subdirectory of the local distfiles directory.
1.110 hubertf 8256: (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 8257: In case this
1.87 wiz 8258: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8259: including the <code class="filename">nbX</code> suffix) or a date stamp
8260: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8261: Do not forget regenerating the <code class="filename">distinfo</code> file
8262: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8263: path in the filenames.
1.97 rillig 8264: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8265: Furthermore, a mail to the package's authors seems appropriate
8266: telling them that changing distfiles after releases without
8267: changing the file names is not good practice.</p>
1.75 rillig 8268: </div>
8269: </div>
1.128 wiz 8270: <div class="sect1" title="19.3. Fixing problems in the configure phase">
1.75 rillig 8271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8272: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.128 wiz 8273: <div class="sect2" title="19.3.1. Shared libraries - libtool">
1.75 rillig 8274: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8275: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8276: <p>pkgsrc supports many different machines, with different
1.87 wiz 8277: object formats like a.out and ELF, and varying abilities to do
8278: shared library and dynamic loading at all. To accompany this,
8279: varying commands and options have to be passed to the
8280: compiler, linker, etc. to get the Right Thing, which can be
8281: pretty annoying especially if you don't have all the machines
8282: at your hand to test things. The
1.91 rillig 8283: <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 8284: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8285: both static and dynamic libraries from a set of source files,
8286: thus being platform-independent.</p>
8287: <p>Here's how to use libtool in a package in seven simple
8288: steps:</p>
1.128 wiz 8289: <div class="orderedlist"><ol class="orderedlist" type="1">
8290: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8291: Makefile.</p></li>
1.128 wiz 8292: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8293: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8294: add it to the definition of <code class="varname">CC</code>, if only
8295: libraries are being built in a given Makefile. This one command
8296: will build both PIC and non-PIC library objects, so you need not
8297: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8298: <li class="listitem">
1.75 rillig 8299: <p>For the linking of the library, remove any
1.128 wiz 8300: <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
8301: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8302: <pre class="programlisting">
1.100 rillig 8303: ${LIBTOOL} --mode=link \
8304: ${CC} -o ${.TARGET:.a=.la} \
8305: ${OBJS:.o=.lo} \
8306: -rpath ${PREFIX}/lib \
8307: -version-info major:minor
1.87 wiz 8308: </pre>
1.75 rillig 8309: <p>Note that the library is changed to have a
1.87 wiz 8310: <code class="filename">.la</code> extension, and the objects are
8311: changed to have a <code class="filename">.lo</code>
8312: extension. Change <code class="varname">OBJS</code> as
8313: necessary. This automatically creates all of the
8314: <code class="filename">.a</code>,
8315: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8316: necessary) in the build directory. Be sure to include
1.128 wiz 8317: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8318: minor are zero, as libtool will otherwise strip off the
8319: shared library version.</p>
1.75 rillig 8320: <p>From the libtool manual:</p>
8321: <pre class="programlisting">
1.100 rillig 8322: So, libtool library versions are described by three integers:
1.69 rillig 8323:
1.100 rillig 8324: CURRENT
8325: The most recent interface number that this library implements.
1.69 rillig 8326:
1.100 rillig 8327: REVISION
8328: The implementation number of the CURRENT interface.
1.69 rillig 8329:
1.100 rillig 8330: AGE
8331: The difference between the newest and oldest interfaces that
8332: this library implements. In other words, the library implements
8333: all the interface numbers in the range from number `CURRENT -
8334: AGE' to `CURRENT'.
1.1 grant 8335:
1.100 rillig 8336: If two libraries have identical CURRENT and AGE numbers, then the
8337: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8338: </pre>
1.128 wiz 8339: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8340: different results for a.out and ELF (excluding symlinks)
8341: in only one case. An ELF library of the form
1.128 wiz 8342: <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 8343: will have a symlink of
1.128 wiz 8344: <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 8345: on an a.out platform. This is handled
8346: automatically.</p>
1.128 wiz 8347: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8348: directory of the library being built.</p>
1.76 rillig 8349: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8350: <code class="filename">.la</code> file, the other files will be
8351: added automatically.</p>
1.75 rillig 8352: </li>
1.128 wiz 8353: <li class="listitem">
1.76 rillig 8354: <p>When linking shared object (<code class="filename">.so</code>)
1.110 hubertf 8355: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128 wiz 8356: shared libraries, use <span class="quote">“<span class="quote">-module
8357: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8358: tacked on.</p>
1.76 rillig 8359: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8360: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8361: </li>
1.128 wiz 8362: <li class="listitem">
1.75 rillig 8363: <p>When linking programs that depend on these libraries
1.87 wiz 8364: <span class="emphasis"><em>before</em></span> they are installed, preface
1.128 wiz 8365: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
8366: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8367: libraries (static or shared), but please be aware that
8368: libtool will not allow you to specify a relative path in
1.128 wiz 8369: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8370: expects you to change that argument to be the
8371: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8372: <pre class="programlisting">
1.100 rillig 8373: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8374: </pre>
1.75 rillig 8375: <p>should be changed to:</p>
8376: <pre class="programlisting">
1.100 rillig 8377: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8378: </pre>
1.75 rillig 8379: <p>and it will do the right thing with the libraries.</p>
8380: </li>
1.128 wiz 8381: <li class="listitem">
1.110 hubertf 8382: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
1.128 wiz 8383: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
8384: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8385: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8386: <pre class="programlisting">
1.126 jakllsch 8387: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8388: </pre>
1.76 rillig 8389: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8390: shared library, any needed symlinks, and run
1.110 hubertf 8391: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8392: </li>
1.128 wiz 8393: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8394: the <code class="filename">.la</code>
8395: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8396: </ol></div>
8397: </div>
1.128 wiz 8398: <div class="sect2" title="19.3.2. Using libtool on GNU packages that already support libtool">
1.75 rillig 8399: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8400: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8401: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8402: package Makefile. This will override the package's own libtool
8403: in most cases. For older libtool using packages, libtool is
8404: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8405: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8406: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8407: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8408: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8409: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8410: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8411: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8412: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8413: libraries built and installed, then use
8414: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8415: <p>If your package makes use of the platform-independent library
1.87 wiz 8416: for loading dynamic shared objects, that comes with libtool
8417: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8418: <p>Some packages use libtool incorrectly so that the package
8419: may not work or build in some circumstances. Some of the more
8420: common errors are:</p>
1.128 wiz 8421: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8422: <li class="listitem">
1.75 rillig 8423: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8424: executable or library. This in itself isn't a problem if one of two things
8425: has been done:</p>
1.128 wiz 8426: <div class="orderedlist"><ol class="orderedlist" type="1">
8427: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8428: <code class="filename">libfoo.la</code>, not
8429: <code class="filename">foo.la</code></p></li>
1.128 wiz 8430: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8431: </ol></div>
8432: </li>
1.128 wiz 8433: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8434: The function lt_dlinit() should be called and the macro
8435: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8436: executables.</p></li>
1.75 rillig 8437: </ul></div>
8438: </div>
1.128 wiz 8439: <div class="sect2" title="19.3.3. GNU Autoconf/Automake">
1.75 rillig 8440: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8441: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8442: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8443: to regenerate the configure script and Makefile.in makefile
8444: templates, then they should be executed in a pre-configure
8445: target.</p>
1.75 rillig 8446: <p>For packages that need only autoconf:</p>
8447: <pre class="programlisting">
1.100 rillig 8448: AUTOCONF_REQD= 2.50 # if default version is not good enough
8449: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8450: ...
1.1 grant 8451:
1.100 rillig 8452: pre-configure:
8453: cd ${WRKSRC} && autoconf
1.1 grant 8454:
1.100 rillig 8455: ...
1.87 wiz 8456: </pre>
1.75 rillig 8457: <p>and for packages that need automake and autoconf:</p>
8458: <pre class="programlisting">
1.100 rillig 8459: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8460: USE_TOOLS+= automake # use "automake14" for automake-1.4
8461: ...
8462:
8463: pre-configure:
8464: set -e; cd ${WRKSRC}; \
8465: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8466:
1.100 rillig 8467: ...
1.87 wiz 8468: </pre>
1.75 rillig 8469: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8470: require GNU Make.</p>
1.75 rillig 8471: <p>There are times when the configure process makes
1.87 wiz 8472: additional changes to the generated files, which then causes
8473: the build process to try to re-execute the automake sequence.
8474: This is prevented by touching various files in the configure
8475: stage. If this causes problems with your package you can set
8476: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8477: Makefile.</p>
1.75 rillig 8478: </div>
8479: </div>
1.128 wiz 8480: <div class="sect1" title="19.4. Programming languages">
1.75 rillig 8481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8482: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.128 wiz 8483: <div class="sect2" title="19.4.1. C, C++, and Fortran">
1.87 wiz 8484: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8485: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8486: <p>Compilers for the C, C++, and Fortran languages comes with
8487: the NetBSD base system. By default, pkgsrc assumes that a package
8488: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8489: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8490: <p>To declare which language's compiler a package needs, set
8491: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8492: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8493: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8494: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8495: written in C++, usually need a C compiler for the configure
8496: phase.</p>
8497: </div>
1.128 wiz 8498: <div class="sect2" title="19.4.2. Java">
1.87 wiz 8499: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8500: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8501: <p>If a program is written in Java, use the Java framework in
8502: pkgsrc. The package must include
8503: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8504: provides the following variables:</p>
1.128 wiz 8505: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8506: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8507: dependency on the JDK is added. If
1.128 wiz 8508: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8509: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8510: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8511: JDK.</p></li>
1.128 wiz 8512: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8513: a package needs a Java2 implementation. The supported values
1.128 wiz 8514: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8515: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8516: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8517: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8518: above. This variable is not set by default.</p></li>
8519: </ul></div>
8520: </div>
1.128 wiz 8521: <div class="sect2" title="19.4.3. Packages containing perl scripts">
1.87 wiz 8522: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8523: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8524: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8525: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8526: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8527: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8528: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8529: that you want adjusted. Every occurrence of
8530: <code class="filename">*/bin/perl</code> will be replaced with the full
8531: path to the perl executable.</p>
8532: <p>If a particular version of perl is needed, set the
8533: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8534: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8535: <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 8536: about handling perl modules.</p>
8537: </div>
1.128 wiz 8538: <div class="sect2" title="19.4.4. Other programming languages">
1.87 wiz 8539: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8540: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8541: <p>Currently, there is no special handling for other languages
8542: in pkgsrc. If a compiler package provides a
8543: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8544: just add a (build) dependency on the appropriate compiler
8545: package.</p>
8546: </div>
8547: </div>
1.128 wiz 8548: <div class="sect1" title="19.5. Fixing problems in the build phase">
1.87 wiz 8549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8550: <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 8551: <p>The most common failures when building a package are that
8552: some platforms do not provide certain header files, functions or
8553: libraries, or they provide the functions in a library that the
8554: original package author didn't know. To work around this, you
8555: can rewrite the source code in most cases so that it does not
8556: use the missing functions or provides a replacement function.</p>
1.128 wiz 8557: <div class="sect2" title="19.5.1. Compiling C and C++ code conditionally">
1.77 rillig 8558: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8559: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8560: <p>If a package already comes with a GNU configure script, the
8561: preferred way to fix the build failure is to change the
8562: configure script, not the code. In the other cases, you can
8563: utilize the C preprocessor, which defines certain macros
8564: depending on the operating system and hardware architecture it
8565: compiles for. These macros can be queried using for example
8566: <code class="varname">#if defined(__i386)</code>. Almost every operating
8567: system, hardware architecture and compiler has its own macro.
8568: For example, if the macros <code class="varname">__GNUC__</code>,
8569: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8570: are all defined, you know that you are using NetBSD on an i386
8571: compatible CPU, and your compiler is GCC.</p>
8572: <p>The list of the following macros for hardware and
8573: operating system depends on the compiler that is used. For
8574: example, if you want to conditionally compile code on Solaris,
8575: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8576: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.128 wiz 8577: <div class="sect3" title="19.5.1.1. C preprocessor macros to identify the operating system">
1.75 rillig 8578: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8579: <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 8580: <p>To distinguish between 4.4 BSD-derived systems and the
8581: rest of the world, you should use the following code.</p>
8582: <pre class="programlisting">
1.100 rillig 8583: #include <sys/param.h>
8584: #if (defined(BSD) && BSD >= 199306)
8585: /* BSD-specific code goes here */
8586: #else
8587: /* non-BSD-specific code goes here */
8588: #endif
1.75 rillig 8589: </pre>
1.77 rillig 8590: <p>If this distinction is not fine enough, you can also test
8591: for the following macros.</p>
1.75 rillig 8592: <pre class="programlisting">
1.100 rillig 8593: FreeBSD __FreeBSD__
8594: DragonFly __DragonFly__
8595: Interix __INTERIX
8596: IRIX __sgi (TODO: get a definite source for this)
8597: Linux linux, __linux, __linux__
8598: NetBSD __NetBSD__
8599: OpenBSD __OpenBSD__
8600: Solaris sun, __sun
1.75 rillig 8601: </pre>
8602: </div>
1.128 wiz 8603: <div class="sect3" title="19.5.1.2. C preprocessor macros to identify the hardware architecture">
1.75 rillig 8604: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8605: <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 8606: <pre class="programlisting">
1.100 rillig 8607: i386 i386, __i386, __i386__
8608: MIPS __mips
8609: SPARC sparc, __sparc
1.75 rillig 8610: </pre>
8611: </div>
1.128 wiz 8612: <div class="sect3" title="19.5.1.3. C preprocessor macros to identify the compiler">
1.75 rillig 8613: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8614: <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 8615: <pre class="programlisting">
1.100 rillig 8616: GCC __GNUC__ (major version), __GNUC_MINOR__
8617: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8618: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8619: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8620: </pre>
8621: </div>
8622: </div>
1.128 wiz 8623: <div class="sect2" title="19.5.2. How to handle compiler bugs">
1.78 rillig 8624: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8625: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8626: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8627: combinations of compiler version and architecture and almost
8628: always relation to optimisation being enabled. Common symptoms
8629: are gcc internal errors or never finishing compiling a
1.78 rillig 8630: file.</p>
8631: <p>Typically, a workaround involves testing the
8632: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8633: optimisation for that combination of file,
8634: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8635: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8636: number of examples.</p>
8637: </div>
1.128 wiz 8638: <div class="sect2" title="19.5.3. Undefined reference to “...”">
1.78 rillig 8639: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 8640: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8641: </h3></div></div></div>
1.92 rillig 8642: <p>This error message often means that a package did not
1.78 rillig 8643: link to a shared library it needs. The following functions are
8644: known to cause this error message over and over.</p>
8645: <div class="informaltable">
8646: <a name="undefined-reference-functions"></a><table border="1">
8647: <colgroup>
8648: <col>
8649: <col>
8650: <col>
8651: </colgroup>
8652: <thead><tr>
8653: <th>Function</th>
8654: <th>Library</th>
8655: <th>Affected platforms</th>
8656: </tr></thead>
8657: <tbody>
8658: <tr>
8659: <td>accept, bind, connect</td>
8660: <td>-lsocket</td>
8661: <td>Solaris</td>
8662: </tr>
8663: <tr>
8664: <td>crypt</td>
8665: <td>-lcrypt</td>
8666: <td>DragonFly, NetBSD</td>
8667: </tr>
8668: <tr>
8669: <td>dlopen, dlsym</td>
8670: <td>-ldl</td>
8671: <td>Linux</td>
8672: </tr>
8673: <tr>
8674: <td>gethost*</td>
8675: <td>-lnsl</td>
8676: <td>Solaris</td>
8677: </tr>
8678: <tr>
8679: <td>inet_aton</td>
8680: <td>-lresolv</td>
8681: <td>Solaris</td>
8682: </tr>
8683: <tr>
8684: <td>nanosleep, sem_*, timer_*</td>
8685: <td>-lrt</td>
8686: <td>Solaris</td>
8687: </tr>
8688: <tr>
8689: <td>openpty</td>
8690: <td>-lutil</td>
8691: <td>Linux</td>
8692: </tr>
8693: </tbody>
8694: </table>
8695: </div>
8696: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8697: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8698: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8699: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8700: bmake</strong></span>.</p>
1.128 wiz 8701: <div class="sect3" title="19.5.3.1. Special issue: The SunPro compiler">
1.92 rillig 8702: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8703: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8704: <p>When you are using the SunPro compiler, there is another
8705: possibility. That compiler cannot handle the following code:</p>
8706: <pre class="programlisting">
1.100 rillig 8707: extern int extern_func(int);
1.93 rillig 8708:
1.100 rillig 8709: static inline int
8710: inline_func(int x)
8711: {
1.92 rillig 8712: return extern_func(x);
1.100 rillig 8713: }
1.93 rillig 8714:
1.100 rillig 8715: int main(void)
8716: {
1.92 rillig 8717: return 0;
1.100 rillig 8718: }
1.92 rillig 8719: </pre>
8720: <p>It generates the code for <code class="function">inline_func</code> even if
8721: that function is never used. This code then refers to
8722: <code class="function">extern_func</code>, which can usually not be resolved. To
8723: solve this problem you can try to tell the package to disable inlining
8724: of functions.</p>
8725: </div>
1.87 wiz 8726: </div>
1.128 wiz 8727: <div class="sect2" title="19.5.4. Running out of memory">
1.87 wiz 8728: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8729: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8730: <p>Sometimes packages fail to build because the compiler runs
8731: into an operating system specific soft limit. With the
8732: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8733: to unlimit the resources. Currently, the allowed values are
1.128 wiz 8734: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8735: Setting this variable is similar to running the shell builtin
1.110 hubertf 8736: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8737: segment size or maximum stack size of a process, respectively, to
8738: their hard limits.</p>
1.78 rillig 8739: </div>
1.75 rillig 8740: </div>
1.128 wiz 8741: <div class="sect1" title="19.6. Fixing problems in the install phase">
1.75 rillig 8742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8743: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.128 wiz 8744: <div class="sect2" title="19.6.1. Creating needed directories">
1.75 rillig 8745: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8746: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8747: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8748: with some operating systems cannot create more than one
8749: directory at a time. As such, you should call
8750: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8751: <pre class="programlisting">
1.100 rillig 8752: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8753: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8754: </pre>
1.128 wiz 8755: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8756: dir2</code></span>”</span> to the
1.87 wiz 8757: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8758: automatically do the right thing.</p>
1.75 rillig 8759: </div>
1.128 wiz 8760: <div class="sect2" title="19.6.2. Where to install documentation">
1.75 rillig 8761: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8762: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8763: <p>In general, documentation should be installed into
1.87 wiz 8764: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8765: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8766: includes the version number of the package).</p>
1.84 wiz 8767: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8768: directory where HTML documentation is installed with the
1.128 wiz 8769: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8770: is needed because otherwise the documentation ends up in
8771: <code class="filename">${PREFIX}/share/doc/html</code> or other
8772: places.</p>
8773: <p>An exception to the above is that library API documentation
1.91 rillig 8774: 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 8775: browsers (devhelp) should be left at their default location, which
8776: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8777: documentation can be recognized from files ending in
8778: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8779: (It is also acceptable to install such files in
8780: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8781: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8782: <code class="filename">.devhelp*</code> file must be directly in that
8783: directory then, no additional subdirectory level is allowed in
8784: this case. This is usually achieved by using
1.128 wiz 8785: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8786: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8787: though.)</p>
1.75 rillig 8788: </div>
1.128 wiz 8789: <div class="sect2" title="19.6.3. Installing highscore files">
1.75 rillig 8790: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8791: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8792: <p>Certain packages, most of them in the games category, install
1.87 wiz 8793: a score file that allows all users on the system to record their
8794: highscores. In order for this to work, the binaries need to be
8795: installed setgid and the score files owned by the appropriate
8796: group and/or owner (traditionally the "games" user/group). The
8797: following variables, documented in more detail in
8798: <code class="filename">mk/defaults/mk.conf</code>, control this
8799: behaviour: <code class="varname">SETGIDGAME</code>,
8800: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8801: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8802: <p>Note that per default, setgid installation of games is
1.87 wiz 8803: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8804: the other variables accordingly.</p>
1.114 jmcneill 8805: <p>A package should therefore never hard code file ownership or
1.87 wiz 8806: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8807: <code class="varname">INSTALL_GAME_DATA</code> to set these
8808: correctly.</p>
1.75 rillig 8809: </div>
1.128 wiz 8810: <div class="sect2" title="19.6.4. Adding DESTDIR support to packages">
1.75 rillig 8811: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8812: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8813: <p><code class="varname">DESTDIR</code> support means that a package
8814: installs into a staging directory, not the final location of the
8815: files. Then a binary package is created which can be used for
8816: installation as usual. There are two ways: Either the package must
1.128 wiz 8817: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8818: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
8819: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8820: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
8821: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>. If
1.114 jmcneill 8822: bsd.prefs.mk is included in the Makefile,
8823: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8824: the inclusion.</p></li>
1.128 wiz 8825: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8826: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8827: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8828: automatically. Many manual rules and pre/post-install often are
8829: incorrect; fix them.</p></li>
1.128 wiz 8830: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8831: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8832: <li class="listitem"><p>In general, packages should support
1.103 wiz 8833: <code class="varname">UNPRIVILEGED</code> to be able to use
8834: DESTDIR.</p></li>
8835: </ul></div>
8836: </div>
1.128 wiz 8837: <div class="sect2" title="19.6.5. Packages with hardcoded paths to other interpreters">
1.103 wiz 8838: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8839: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8840: <p>Your package may also contain scripts with hardcoded paths to
8841: other interpreters besides (or as well as) perl. To correct the
8842: full pathname to the script interpreter, you need to set the
8843: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8844: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8845: <pre class="programlisting">
1.100 rillig 8846: REPLACE_INTERPRETER+= tcl
8847: REPLACE.tcl.old= .*/bin/tclsh
8848: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8849: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8850: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8851: </pre>
1.128 wiz 8852: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8853: <h3 class="title">Note</h3>
8854: <p>Before March 2006, these variables were called
1.87 wiz 8855: <code class="varname">_REPLACE.*</code> and
8856: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8857: </div>
8858: </div>
1.128 wiz 8859: <div class="sect2" title="19.6.6. Packages installing perl modules">
1.75 rillig 8860: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8861: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8862: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8863: the Makefile fragment
8864: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8865: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8866: configuration for such modules as well as various hooks to tune
8867: this configuration. See comments in this file for
8868: details.</p>
1.75 rillig 8869: <p>Perl5 modules will install into different places depending
1.87 wiz 8870: on the version of perl used during the build process. To
8871: address this, pkgsrc will append lines to the
8872: <code class="filename">PLIST</code> corresponding to the files listed in
8873: the installed <code class="filename">.packlist</code> file generated by
8874: most perl5 modules. This is invoked by defining
8875: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8876: paths to packlist files, e.g.:</p>
1.75 rillig 8877: <pre class="programlisting">
1.100 rillig 8878: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87 wiz 8879: </pre>
1.75 rillig 8880: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8881: <code class="varname">PERL5_SITEARCH</code>, and
8882: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8883: in which perl5 modules may be installed, and may be used by
8884: perl5 packages that don't have a packlist. These three
8885: variables are also substituted for in the
8886: <code class="filename">PLIST</code>.</p>
1.75 rillig 8887: </div>
1.128 wiz 8888: <div class="sect2" title="19.6.7. Packages installing info files">
1.75 rillig 8889: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8890: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8891: <p>Some packages install info files or use the
1.128 wiz 8892: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8893: commands. <code class="varname">INFO_FILES</code> should be defined in
8894: the package Makefile so that <code class="filename">INSTALL</code> and
8895: <code class="filename">DEINSTALL</code> scripts will be generated to
8896: handle registration of the info files in the Info directory
1.128 wiz 8897: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8898: files registration is either provided by the system, or by a
8899: special purpose package automatically added as dependency if
8900: needed.</p>
1.75 rillig 8901: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8902: <code class="filename">${PREFIX}</code> where info files are primarily
8903: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8904: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8905: <p>The info files for the package should be listed in the
1.87 wiz 8906: package <code class="filename">PLIST</code>; however any split info files
8907: need not be listed.</p>
1.128 wiz 8908: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8909: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8910: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8911: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8912: should be noted with the <code class="varname">TEXINFO_REQD</code>
8913: variable in the package <code class="filename">Makefile</code>. By
8914: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8915: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8916: does not match the required minimum, a build dependency on the
1.91 rillig 8917: <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 8918: be added automatically.</p>
1.75 rillig 8919: <p>The build and installation process of the software provided
1.87 wiz 8920: by the package should not use the
1.110 hubertf 8921: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8922: info files is the task of the package
8923: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8924: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8925: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8926: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8927: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8928: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8929: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8930: no effect except the logging of a message. The script overriding
1.110 hubertf 8931: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8932: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8933: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8934: </div>
1.128 wiz 8935: <div class="sect2" title="19.6.8. Packages installing man pages">
1.75 rillig 8936: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8937: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8938: <p>All packages that install manual pages should install them
1.87 wiz 8939: into the same directory, so that there is one common place to look
8940: for them. In pkgsrc, this place is
8941: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8942: should be used in packages. The default for
8943: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8944: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8945: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
8946: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8947: <h3 class="title">Note</h3>
1.87 wiz 8948: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8949: is far from complete.</p>
1.75 rillig 8950: </div>
1.81 rillig 8951: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8952: <code class="filename">man/</code> as the top level directory for the man
8953: page file entries, and the pkgsrc framework will convert as
8954: needed. In all other places, the correct
8955: <code class="varname">PKGMANDIR</code> must be used.</p>
8956: <p>Packages that are
8957: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 8958: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8959: <code class="filename">./configure</code>
8960: --mandir switch to set where the man pages should be installed.
8961: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8962: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8963: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8964: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 8965: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8966: Or if the <code class="filename">./configure</code> script uses
8967: a non-standard use of --mandir, you can set
8968: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8969: <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 8970: information on installation of compressed manual pages.</p>
1.75 rillig 8971: </div>
1.128 wiz 8972: <div class="sect2" title="19.6.9. Packages installing GConf data files">
1.75 rillig 8973: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8974: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8975: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8976: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8977: you need to take some extra steps to make sure they get registered
8978: in the database:</p>
1.128 wiz 8979: <div class="orderedlist"><ol class="orderedlist" type="1">
8980: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8981: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8982: takes care of rebuilding the GConf database at installation and
1.87 wiz 8983: deinstallation time, and tells the package where to install
1.107 rillig 8984: GConf data files using some standard configure arguments. It
1.87 wiz 8985: also disallows any access to the database directly from the
8986: package.</p></li>
1.128 wiz 8987: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8988: <code class="filename">.schemas</code> files under
8989: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8990: installed under <code class="filename">${PREFIX}/etc</code>, you will
8991: need to manually patch the package.</p></li>
1.128 wiz 8992: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8993: directory, as they will be handled automatically. See
1.110 hubertf 8994: <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 8995: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8996: your <code class="filename">Makefile</code> with a list of all
8997: <code class="filename">.schemas</code> files installed by the package, if
8998: any. Names must not contain any directories in them.</p></li>
1.128 wiz 8999: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 9000: your <code class="filename">Makefile</code> with a
9001: list of all <code class="filename">.entries</code> files installed by the
9002: package, if any. Names must not contain any directories in
9003: them.</p></li>
1.75 rillig 9004: </ol></div>
9005: </div>
1.128 wiz 9006: <div class="sect2" title="19.6.10. Packages installing scrollkeeper/rarian data files">
1.75 rillig 9007: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 9008: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 9009: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 9010: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 9011: get registered in the database:</p>
1.128 wiz 9012: <div class="orderedlist"><ol class="orderedlist" type="1">
9013: <li class="listitem"><p>Include
1.119 mishka 9014: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9015: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 9016: takes care of rebuilding the scrollkeeper database at
9017: installation and deinstallation time, and disallows any access
9018: to it directly from the package.</p></li>
1.128 wiz 9019: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9020: <code class="filename">libdata/scrollkeeper</code> directory, as they
9021: will be handled automatically.</p></li>
1.128 wiz 9022: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 9023: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9024: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 9025: </ol></div>
9026: </div>
1.128 wiz 9027: <div class="sect2" title="19.6.11. Packages installing X11 fonts">
1.75 rillig 9028: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9029: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9030: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9031: the fonts database in the directory where they get installed at
9032: installation and deinstallation time. This can be automatically
9033: done by using the pkginstall framework.</p>
1.75 rillig 9034: <p>You can list the directories where fonts are installed in the
1.87 wiz 9035: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9036: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9037: <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 9038: Also make sure that the database file
9039: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9040: <p>Note that you should not create new directories for fonts;
1.87 wiz 9041: instead use the standard ones to avoid that the user needs to
9042: manually configure his X server to find them.</p>
1.75 rillig 9043: </div>
1.128 wiz 9044: <div class="sect2" title="19.6.12. Packages installing GTK2 modules">
1.75 rillig 9045: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9046: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9047: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9048: take some extra steps to get them registered in the GTK2 database
9049: properly:</p>
1.128 wiz 9050: <div class="orderedlist"><ol class="orderedlist" type="1">
9051: <li class="listitem"><p>Include
1.87 wiz 9052: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9053: <code class="filename">buildlink3.mk</code> file. This takes care of
9054: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 9055: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 9056: your package installs GTK2 immodules.</p></li>
1.128 wiz 9057: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 9058: GTK2 loaders.</p></li>
1.128 wiz 9059: <li class="listitem">
1.87 wiz 9060: <p>Patch the package to not touch any of the GTK2
9061: databases directly. These are:</p>
1.128 wiz 9062: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9063: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9064: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9065: </ul></div>
9066: </li>
1.128 wiz 9067: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 9068: any entries under the <code class="filename">libdata/gtk-2.0</code>
9069: directory, as they will be handled automatically.</p></li>
1.75 rillig 9070: </ol></div>
9071: </div>
1.128 wiz 9072: <div class="sect2" title="19.6.13. Packages installing SGML or XML data">
1.75 rillig 9073: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9074: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9075: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9076: registered in system-wide catalogs (like DTDs, sub-catalogs,
9077: etc.), you need to take some extra steps:</p>
1.128 wiz 9078: <div class="orderedlist"><ol class="orderedlist" type="1">
9079: <li class="listitem"><p>Include
1.87 wiz 9080: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9081: your <code class="filename">Makefile</code>, which takes care of
9082: registering those files in system-wide catalogs at
9083: installation and deinstallation time.</p></li>
1.128 wiz 9084: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9085: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9086: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9087: any XML catalogs installed by the package.</p></li>
1.128 wiz 9088: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9089: to be added to the SGML catalog. These come in groups of
9090: three strings; see xmlcatmgr(1) for more information
9091: (specifically, arguments recognized by the 'add' action).
9092: Note that you will normally not use this variable.</p></li>
1.128 wiz 9093: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9094: to be added to the XML catalog. These come in groups of three
9095: strings; see xmlcatmgr(1) for more information (specifically,
9096: arguments recognized by the 'add' action). Note that you will
9097: normally not use this variable.</p></li>
1.75 rillig 9098: </ol></div>
9099: </div>
1.128 wiz 9100: <div class="sect2" title="19.6.14. Packages installing extensions to the MIME database">
1.75 rillig 9101: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9102: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9103: <p>If a package provides extensions to the MIME database by
1.87 wiz 9104: installing <code class="filename">.xml</code> files inside
9105: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9106: need to take some extra steps to ensure that the database is kept
9107: consistent with respect to these new files:</p>
1.128 wiz 9108: <div class="orderedlist"><ol class="orderedlist" type="1">
9109: <li class="listitem"><p>Include
1.87 wiz 9110: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9111: (avoid using the <code class="filename">buildlink3.mk</code> file from
9112: this same directory, which is reserved for inclusion from
9113: other <code class="filename">buildlink3.mk</code> files). It takes
9114: care of rebuilding the MIME database at installation and
9115: deinstallation time, and disallows any access to it directly
9116: from the package.</p></li>
1.128 wiz 9117: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9118: <code class="filename">share/mime</code> directory,
9119: <span class="emphasis"><em>except</em></span> for files saved under
9120: <code class="filename">share/mime/packages</code>. The former are
9121: handled automatically by
9122: the update-mime-database program, but the latter are
9123: package-dependent and must be removed by the package that
9124: installed them in the first place.</p></li>
1.128 wiz 9125: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9126: from the PLIST. They will be handled by the shared-mime-info
9127: package.</p></li>
1.75 rillig 9128: </ol></div>
9129: </div>
1.128 wiz 9130: <div class="sect2" title="19.6.15. Packages using intltool">
1.75 rillig 9131: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9132: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9133: <p>If a package uses intltool during its build, add
9134: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9135: which forces it to use the intltool package provided by pkgsrc,
9136: instead of the one bundled with the distribution file.</p>
1.75 rillig 9137: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9138: latest available version; this way, the package benefits of any
9139: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9140: </div>
1.128 wiz 9141: <div class="sect2" title="19.6.16. Packages installing startup scripts">
1.75 rillig 9142: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9143: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9144: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9145: the startup directory by default, but you can enable it, by adding
9146: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9147: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9148: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9149: it will automatically remove the scripts when the package is
9150: deinstalled.</p>
1.75 rillig 9151: </div>
1.128 wiz 9152: <div class="sect2" title="19.6.17. Packages installing TeX modules">
1.75 rillig 9153: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9154: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9155: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9156: the <code class="filename">ls-R</code> database of the tree needs to be
9157: updated.</p>
1.128 wiz 9158: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9159: <h3 class="title">Note</h3>
1.125 wiz 9160: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9161: packages should install files
1.125 wiz 9162: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9163: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9164: </div>
1.128 wiz 9165: <div class="orderedlist"><ol class="orderedlist" type="1">
9166: <li class="listitem"><p>Include
1.125 wiz 9167: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9168: takes care of rebuilding the <code class="filename">ls-R</code>
9169: database at installation and deinstallation time.</p></li>
1.128 wiz 9170: <li class="listitem">
1.75 rillig 9171: <p>If your package installs files into a texmf
1.87 wiz 9172: tree other than the one
1.125 wiz 9173: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9174: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9175: trees that need database update.</p>
1.75 rillig 9176: <p>If your package also installs font map files that need
1.110 hubertf 9177: to be registered using <span class="command"><strong>updmap</strong></span>,
1.125 wiz 9178: include <code class="filename">../../print/texlive-tetex/map.mk</code> and
9179: set <code class="varname">TEX_MAP_FILES</code> and/or
9180: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9181: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9182: be run automatically at installation/deinstallation to
9183: enable/disable font map files for TeX output
9184: drivers.</p>
1.75 rillig 9185: </li>
1.128 wiz 9186: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9187: databases are included in <code class="filename">PLIST</code>, as
9188: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 9189: </ol></div>
9190: </div>
1.128 wiz 9191: <div class="sect2" title="19.6.18. Packages supporting running binaries in emulation">
1.85 jmmv 9192: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9193: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9194: emulation</h3></div></div></div>
9195: <p>There are some packages that provide libraries and
9196: executables for running binaries from a one operating system
9197: on a different one (if the latter supports it). One example
9198: is running Linux binaries on NetBSD.</p>
1.91 rillig 9199: <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 9200: helps in extracting and packaging Linux rpm packages.</p>
9201: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9202: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9203: if all libraries for each installed executable can be found by
9204: the dynamic linker. Since the standard dynamic linker is run,
9205: this fails for emulation packages, because the libraries used
9206: by the emulation are not in the standard directories.</p>
9207: </div>
1.128 wiz 9208: <div class="sect2" title="19.6.19. Packages installing hicolor theme icons">
1.87 wiz 9209: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9210: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9211: <p>If a package installs images under the
1.87 wiz 9212: <code class="filename">share/icons/hicolor</code> and/or updates the
9213: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9214: database, you need to take some extra steps to make sure that the
9215: shared theme directory is handled appropriately and that the cache
9216: database is rebuilt:</p>
1.128 wiz 9217: <div class="orderedlist"><ol class="orderedlist" type="1">
9218: <li class="listitem"><p>Include
1.87 wiz 9219: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 9220: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9221: entry that refers to the theme cache.</p></li>
1.128 wiz 9222: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9223: directories from the <code class="filename">share/icons/hicolor</code>
9224: hierarchy because they will be handled automatically.</p></li>
9225: </ol></div>
9226: <p>The best way to verify that the PLIST is correct with
9227: respect to the last two points is to regenerate it using
1.110 hubertf 9228: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9229: </div>
1.128 wiz 9230: <div class="sect2" title="19.6.20. Packages installing desktop files">
1.85 jmmv 9231: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9232: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9233: <p>If a package installs <code class="filename">.desktop</code> files
9234: under <code class="filename">share/applications</code> and these include
9235: MIME information, you need to take extra steps to ensure that they
9236: are registered into the MIME database:</p>
1.128 wiz 9237: <div class="orderedlist"><ol class="orderedlist" type="1">
9238: <li class="listitem"><p>Include
1.85 jmmv 9239: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 9240: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9241: <code class="filename">share/applications/mimeinfo.cache</code> file.
9242: It will be handled automatically.</p></li>
9243: </ol></div>
9244: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9245: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9246: print-PLIST</strong></span>.</p>
1.75 rillig 9247: </div>
9248: </div>
1.128 wiz 9249: <div class="sect1" title="19.7. Marking packages as having problems">
1.87 wiz 9250: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9251: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9252: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9253: immediately. In this case, one can plainly mark a package as broken. For
9254: this, one just sets the variable <code class="varname">BROKEN</code> to the
9255: reason why the package is broken (similar to the
9256: <code class="varname">RESTRICTED</code> variable). A user trying to build
9257: the package will immediately be shown this message, and the build
9258: will not be even tried.</p>
9259: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9260: intervals.</p>
9261: </div>
1.75 rillig 9262: </div>
1.128 wiz 9263: <div class="chapter" title="Chapter 20. Debugging">
1.75 rillig 9264: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9265: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9266: <p>To check out all the gotchas when building a package, here are
9267: the steps that I do in order to get a package working. Please note
9268: this is basically the same as what was explained in the previous
9269: sections, only with some debugging aids.</p>
1.128 wiz 9270: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9271: <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>
9272: <li class="listitem">
1.91 rillig 9273: <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 9274: create a directory for a new package, change into it, then run
1.110 hubertf 9275: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9276: <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>
9277: <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>
9278: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9279: </li>
1.128 wiz 9280: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9281: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9282: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9283: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9284: configure step to the package's
9285: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 9286: <li class="listitem">
1.75 rillig 9287: <p>Make the package compile, doing multiple rounds of</p>
9288: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9289: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9290: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9291: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9292: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9293: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9294: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9295: <p>Doing this step as non-root user will ensure that no files
9296: are modified that shouldn't be, especially during the build
1.110 hubertf 9297: phase. <span class="command"><strong>mkpatches</strong></span>,
9298: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91 rillig 9299: 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 9300: package.</p>
1.75 rillig 9301: </li>
1.128 wiz 9302: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9303: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9304: <li class="listitem">
1.76 rillig 9305: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9306: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9307: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9308: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9309: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9310: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9311: <p>You usually need to be <code class="username">root</code> to do
9312: this. Look if there are any files left:</p>
1.75 rillig 9313: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9314: <p>If this reveals any files that are missing in
1.88 wiz 9315: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9316: </li>
1.128 wiz 9317: <li class="listitem">
1.88 wiz 9318: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9319: package again and make a binary package:</p>
1.75 rillig 9320: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9321: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9322: </li>
1.128 wiz 9323: <li class="listitem">
1.75 rillig 9324: <p>Delete the installed package:</p>
1.88 wiz 9325: <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 9326: </li>
1.128 wiz 9327: <li class="listitem">
1.110 hubertf 9328: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9329: command, which shouldn't find anything now:</p>
1.75 rillig 9330: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9331: </li>
1.128 wiz 9332: <li class="listitem">
1.75 rillig 9333: <p>Reinstall the binary package:</p>
1.93 rillig 9334: <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 9335: </li>
1.128 wiz 9336: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9337: <li class="listitem">
1.110 hubertf 9338: <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 9339: reports:</p>
1.75 rillig 9340: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9341: </li>
1.128 wiz 9342: <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 9343: </ul></div>
9344: </div>
1.128 wiz 9345: <div class="chapter" title="Chapter 21. Submitting and Committing">
1.75 rillig 9346: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9347: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9348: <div class="toc">
9349: <p><b>Table of Contents</b></p>
9350: <dl>
1.106 rillig 9351: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9352: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9353: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9354: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9355: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9356: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9357: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9358: </dl>
9359: </div>
1.128 wiz 9360: <div class="sect1" title="21.1. Submitting binary packages">
1.75 rillig 9361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9362: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9363: <p>Our policy is that we accept binaries only from pkgsrc
9364: developers to guarantee that the packages don't contain any
9365: trojan horses etc. This is not to annoy anyone but rather to
9366: protect our users! You're still free to put up your home-made
9367: binary packages and tell the world where to get them. NetBSD
9368: developers doing bulk builds and wanting to upload them please
1.110 hubertf 9369: 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 9370: </div>
1.128 wiz 9371: <div class="sect1" title="21.2. Submitting source packages (for non-NetBSD-developers)">
1.75 rillig 9372: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9373: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9374: <p>First, check that your package is complete, compiles and
1.110 hubertf 9375: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
9376: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82 rillig 9377: archive that contains all files that make up the package.
1.87 wiz 9378: Finally, send this package to the pkgsrc bug tracking system,
1.110 hubertf 9379: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87 wiz 9380: that, go to the web page
1.110 hubertf 9381: <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 9382: which contains some instructions and a link to a form where you
9383: can submit packages. The
9384: <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
9385: also available as a substitute for either of the above two tools.
9386: </p>
1.87 wiz 9387: <p>In the form of the problem report, the category should be
1.128 wiz 9388: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9389: and version number, and the description field should contain a
9390: short description of your package (contents of the COMMENT
9391: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9392: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9393: <p>If you want to submit several packages, please send a
9394: separate PR for each one, it's easier for us to track things
9395: that way.</p>
9396: <p>Alternatively, you can also import new packages into
1.128 wiz 9397: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9398: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9399: for details.</p>
9400: </div>
1.128 wiz 9401: <div class="sect1" title="21.3. General notes when adding, updating, or removing packages">
1.75 rillig 9402: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9403: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9404: <p>Please note all package additions, updates, moves, and
1.93 rillig 9405: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9406: important to keep this file up to date and conforming to the
9407: existing format, because it will be used by scripts to
1.110 hubertf 9408: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9409: sites. Additionally, check the
1.76 rillig 9410: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9411: for the package you updated or removed, in case it was mentioned
9412: there.</p>
9413: <p>When the <code class="varname">PKGREVISION</code> of a package is
9414: bumped, the change should appear in
1.93 rillig 9415: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9416: related or otherwise relevant. Mass bumps that result from a
9417: dependency being updated should not be mentioned. In all other
9418: cases it's the developer's decision.</p>
9419: <p>There is a make target that helps in creating proper
1.110 hubertf 9420: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9421: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9422: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9423: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9424: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9425: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9426: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9427: For new packages, or package moves or removals, set the
9428: <code class="varname">CTYPE</code> variable on the command line to "Added",
9429: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9430: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9431: not the same as your NetBSD login name. The target also automatically
9432: removes possibly existing entries for the package in the
9433: <code class="filename">TODO</code> file. Don't forget to commit
9434: the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
1.126 jakllsch 9435: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9436: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9437: makes the cvs commands use the main repository.
9438: </p>
1.75 rillig 9439: </div>
1.128 wiz 9440: <div class="sect1" title="21.4. Committing: Importing a package into CVS">
1.75 rillig 9441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9442: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9443: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9444: access to the pkgsrc repository. Please remember that cvs
9445: imports files relative to the current working directory, and that
9446: the pathname that you
1.110 hubertf 9447: give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75 rillig 9448: to place the files in the repository. Newly created packages should be
1.128 wiz 9449: imported with a vendor tag of <span class="quote">“<span class="quote">TNF</span>”</span> and a release tag of
9450: <span class="quote">“<span class="quote">pkgsrc-base</span>”</span>, e.g:</p>
1.75 rillig 9451: <pre class="programlisting">
1.100 rillig 9452: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9453: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75 rillig 9454: </pre>
1.87 wiz 9455: <p>Remember to move the directory from which you imported out of
1.128 wiz 9456: the way, or cvs will complain the next time you <span class="quote">“<span class="quote">cvs
9457: update</span>”</span> your source tree. Also don't forget to add the new
1.87 wiz 9458: package to the category's <code class="filename">Makefile</code>.</p>
9459: <p>The commit message of the initial import should include part of the
1.76 rillig 9460: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9461: what the package is/does.</p>
1.128 wiz 9462: <p>For new packages, <span class="quote">“<span class="quote">cvs import</span>”</span> is preferred to <span class="quote">“<span class="quote">cvs
9463: add</span>”</span> because the former gets everything with a single command,
1.87 wiz 9464: and provides a consistent tag.</p>
1.75 rillig 9465: </div>
1.128 wiz 9466: <div class="sect1" title="21.5. Updating a package to a newer version">
1.75 rillig 9467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9468: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9469: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9470: changes between old and new versions into the commit log when updating
1.87 wiz 9471: a package. There are various reasons for this:</p>
1.128 wiz 9472: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9473: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9474: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9475: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9476: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9477: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9478: repository is very useful for people who read the pkgsrc-changes mailing
9479: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9480: the package.</p></li>
1.75 rillig 9481: </ul></div>
1.87 wiz 9482: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9483: has been released, it should not automatically be upgraded in the CVS
9484: repository. We prefer to be conservative in the packages that are
9485: included in pkgsrc - development or beta packages are not really the
9486: best thing for most places in which pkgsrc is used. Please use your
9487: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9488: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9489: </div>
1.128 wiz 9490: <div class="sect1" title="21.6. Renaming a package in pkgsrc">
1.75 rillig 9491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9492: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9493: <p>Renaming packages is not recommended.</p>
9494: <p>When renaming packages, be sure to fix any references to old name
9495: in other Makefiles, options, buildlink files, etc.</p>
9496: <p>Also When renaming a package, please define
9497: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9498: pattern(s) of the previous package name.
9499: This may be repeated for multiple renames.
9500: The new package would be an exact replacement.
9501: </p>
1.128 wiz 9502: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9503: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9504: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9505: not be an exact replacement but is a suggestion for the replaced
9506: functionality.</p>
9507: </div>
1.128 wiz 9508: <div class="sect1" title="21.7. Moving a package in pkgsrc">
1.122 reed 9509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9510: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9511: <p>It is preferred that packages are not renamed or moved, but if needed
9512: please follow these steps.
9513: </p>
1.128 wiz 9514: <div class="orderedlist"><ol class="orderedlist" type="1">
9515: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9516: <li class="listitem">
1.75 rillig 9517: <p>Remove all CVS dirs.</p>
1.87 wiz 9518: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9519: <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 9520: <p>and use that for further work.</p>
1.75 rillig 9521: </li>
1.128 wiz 9522: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9523: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9524: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9525: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9526: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9527: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9528: for doing an update using pkgsrc building; for example, it can
9529: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
9530: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9531: new <code class="varname">PKGPATH</code> for that moved package. Note that
9532: it may have multiple matches, so the tool should also check on the
9533: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9534: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9535: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9536: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9537: place.</p></li>
1.128 wiz 9538: <li class="listitem">
1.75 rillig 9539: <p>Check if any package depends on it:
9540: </p>
9541: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9542: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9543: </li>
1.128 wiz 9544: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9545: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9546: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9547: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9548: <li class="listitem">
1.75 rillig 9549: <p>Commit the changed and removed files:</p>
9550: <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 9551: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9552: </li>
9553: </ol></div>
9554: </div>
9555: </div>
1.128 wiz 9556: <div class="chapter" title="Chapter 22. Frequently Asked Questions">
1.75 rillig 9557: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9558: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9559: <p>This section contains the answers to questions that may
9560: arise when you are writing a package. If you don't find your
9561: question answered here, first have a look in the other chapters,
9562: and if you still don't have the answer, ask on the
9563: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.128 wiz 9564: <div class="qandaset" title="Frequently Asked Questions">
1.129 ! wiz 9565: <a name="id1168230172542"></a><dl>
1.106 rillig 9566: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9567: MAKEFLAGS, .MAKEFLAGS and
9568: MAKE_FLAGS?</a>
9569: </dt>
1.106 rillig 9570: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9571: MAKE, GMAKE and
9572: MAKE_PROGRAM?</a>
9573: </dt>
1.106 rillig 9574: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9575: CC, PKG_CC and
9576: PKGSRC_COMPILER?</a>
9577: </dt>
1.106 rillig 9578: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9579: BUILDLINK_LDFLAGS,
9580: BUILDLINK_LDADD and
9581: BUILDLINK_LIBS?</a>
9582: </dt>
1.106 rillig 9583: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9584: VARNAME=BUILDLINK_PREFIX.foo
9585: say it's empty?</a>
9586: </dt>
1.106 rillig 9587: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9588: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9589: don't understand the := inside
9590: it.</a>
9591: </dt>
1.106 rillig 9592: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9593: developers?</a>
9594: </dt>
1.106 rillig 9595: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9596: documentation?</a>
9597: </dt>
1.106 rillig 9598: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9599: do?</a>
9600: </dt>
1.75 rillig 9601: </dl>
1.128 wiz 9602: <table border="0" width="100%" summary="Q and A Set">
1.75 rillig 9603: <col align="left" width="1%">
1.128 wiz 9604: <col>
1.75 rillig 9605: <tbody>
1.128 wiz 9606: <tr class="question" title="22.1.">
1.75 rillig 9607: <td align="left" valign="top">
1.129 ! wiz 9608: <a name="devfaq.makeflags"></a><a name="id1168230172546"></a><p><b>22.1.</b></p>
1.75 rillig 9609: </td>
9610: <td align="left" valign="top"><p>What is the difference between
9611: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9612: <code class="varname">MAKE_FLAGS</code>?</p></td>
9613: </tr>
9614: <tr class="answer">
1.91 rillig 9615: <td align="left" valign="top"></td>
1.75 rillig 9616: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110 hubertf 9617: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75 rillig 9618: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9619: the <code class="varname">MAKE_PROGRAM</code> when building the
9620: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9621: </tr>
1.128 wiz 9622: <tr class="question" title="22.2.">
1.75 rillig 9623: <td align="left" valign="top">
1.129 ! wiz 9624: <a name="devfaq.make"></a><a name="id1168230172648"></a><p><b>22.2.</b></p>
1.75 rillig 9625: </td>
9626: <td align="left" valign="top"><p>What is the difference between
9627: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9628: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9629: </tr>
9630: <tr class="answer">
1.91 rillig 9631: <td align="left" valign="top"></td>
1.75 rillig 9632: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110 hubertf 9633: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75 rillig 9634: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9635: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9636: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9637: Make program that is used for building the
9638: package.</p></td>
9639: </tr>
1.128 wiz 9640: <tr class="question" title="22.3.">
1.75 rillig 9641: <td align="left" valign="top">
1.129 ! wiz 9642: <a name="devfaq.cc"></a><a name="id1168230172684"></a><p><b>22.3.</b></p>
1.75 rillig 9643: </td>
9644: <td align="left" valign="top"><p>What is the difference between
9645: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9646: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9647: </tr>
9648: <tr class="answer">
1.91 rillig 9649: <td align="left" valign="top"></td>
1.75 rillig 9650: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9651: compiler, which can be configured by the pkgsrc user.
9652: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9653: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9654: path to a compiler, but the type of compiler that should be
1.76 rillig 9655: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9656: information about the latter variable.</p></td>
9657: </tr>
1.128 wiz 9658: <tr class="question" title="22.4.">
1.75 rillig 9659: <td align="left" valign="top">
1.129 ! wiz 9660: <a name="devfaq.bl3flags"></a><a name="id1168230172720"></a><p><b>22.4.</b></p>
1.75 rillig 9661: </td>
9662: <td align="left" valign="top"><p>What is the difference between
9663: <code class="varname">BUILDLINK_LDFLAGS</code>,
9664: <code class="varname">BUILDLINK_LDADD</code> and
9665: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9666: </tr>
9667: <tr class="answer">
1.91 rillig 9668: <td align="left" valign="top"></td>
1.75 rillig 9669: <td align="left" valign="top"><p>[FIXME]</p></td>
9670: </tr>
1.128 wiz 9671: <tr class="question" title="22.5.">
1.75 rillig 9672: <td align="left" valign="top">
1.129 ! wiz 9673: <a name="devfaq.bl3prefix"></a><a name="id1168230172738"></a><p><b>22.5.</b></p>
1.75 rillig 9674: </td>
1.110 hubertf 9675: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9676: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9677: say it's empty?</p></td>
9678: </tr>
9679: <tr class="answer">
1.91 rillig 9680: <td align="left" valign="top"></td>
1.75 rillig 9681: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9682: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9683: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9684: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9685: command.</p></td>
9686: </tr>
1.128 wiz 9687: <tr class="question" title="22.6.">
1.78 rillig 9688: <td align="left" valign="top">
1.129 ! wiz 9689: <a name="devfaq.master_sites"></a><a name="id1168230172763"></a><p><b>22.6.</b></p>
1.78 rillig 9690: </td>
9691: <td align="left" valign="top"><p>What does
9692: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9693: don't understand the <code class="literal">:=</code> inside
9694: it.</p></td>
9695: </tr>
9696: <tr class="answer">
1.91 rillig 9697: <td align="left" valign="top"></td>
1.78 rillig 9698: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9699: assignment operator, like you might expect at first sight.
9700: Instead, it is a degenerate form of
9701: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110 hubertf 9702: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78 rillig 9703: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9704: case of <code class="varname">MASTER_SITE_*</code>,
9705: <em class="replaceable"><code>old_string</code></em> is the empty string and
9706: <em class="replaceable"><code>new_string</code></em> is
9707: <code class="literal">package/</code>. That's where the
9708: <code class="literal">:</code> and the <code class="literal">=</code> fall
9709: together.</p></td>
9710: </tr>
1.128 wiz 9711: <tr class="question" title="22.7.">
1.78 rillig 9712: <td align="left" valign="top">
1.129 ! wiz 9713: <a name="devfaq.mailinglists"></a><a name="id1168230172830"></a><p><b>22.7.</b></p>
1.78 rillig 9714: </td>
9715: <td align="left" valign="top"><p>Which mailing lists are there for package
9716: developers?</p></td>
9717: </tr>
9718: <tr class="answer">
1.91 rillig 9719: <td align="left" valign="top"></td>
1.78 rillig 9720: <td align="left" valign="top"><div class="variablelist"><dl>
1.110 hubertf 9721: <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 9722: <dd><p>This is a list for technical discussions related
9723: to pkgsrc development, e.g. soliciting feedback for changes to
9724: pkgsrc infrastructure, proposed new features, questions related
9725: to porting pkgsrc to a new platform, advice for maintaining a
9726: package, patches that affect many packages, help requests moved
9727: from pkgsrc-users when an infrastructure bug is found,
9728: etc.</p></dd>
1.110 hubertf 9729: <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 9730: <dd><p>All bug reports in category "pkg" sent with
1.110 hubertf 9731: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78 rillig 9732: directly; use one of the other mailing
9733: lists.</p></dd>
9734: </dl></div></td>
9735: </tr>
1.128 wiz 9736: <tr class="question" title="22.8.">
1.80 rillig 9737: <td align="left" valign="top">
1.129 ! wiz 9738: <a name="devfaq.documentation"></a><a name="id1168230172862"></a><p><b>22.8.</b></p>
1.80 rillig 9739: </td>
9740: <td align="left" valign="top"><p>Where is the pkgsrc
9741: documentation?</p></td>
9742: </tr>
9743: <tr class="answer">
1.91 rillig 9744: <td align="left" valign="top"></td>
1.80 rillig 9745: <td align="left" valign="top">
9746: <p>There are many places where you can find
9747: documentation about pkgsrc:</p>
1.128 wiz 9748: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9749: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9750: of chapters that explain large parts of pkgsrc, but some
9751: chapters tend to be outdated. Which ones they are is hard to
9752: say.</p></li>
1.128 wiz 9753: <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 9754: about certain features, announcements of new parts of the pkgsrc
9755: infrastructure and sometimes even announcements that a certain
9756: feature has been marked as obsolete. The benefit here is that
9757: each message has a date appended to it.</p></li>
1.128 wiz 9758: <li class="listitem"><p>Many of the files in the
1.80 rillig 9759: <code class="filename">mk/</code> directory start with a comment that
9760: describes the purpose of the file and how it can be used by the
1.92 rillig 9761: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9762: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9763: help</strong></span>.</p></li>
1.128 wiz 9764: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9765: information, but they tend to be highly abbreviated, especially
9766: for actions that occur often. Some contain a detailed
9767: description of what has changed, but they are geared towards the
9768: other pkgsrc developers, not towards an average pkgsrc user.
9769: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9770: don't know what has been before, these messages may not be worth
9771: too much to you.</p></li>
1.128 wiz 9772: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9773: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9774: mind of the developer who wrote the code. To get this
1.110 hubertf 9775: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9776: to see who has written it and ask on the
9777: <code class="literal">tech-pkg</code> mailing list, so that others can
9778: find your questions later (see above). To be sure that the
9779: developer in charge reads the mail, you may CC him or
9780: her.</p></li>
9781: </ul></div>
9782: </td>
9783: </tr>
1.128 wiz 9784: <tr class="question" title="22.9.">
1.92 rillig 9785: <td align="left" valign="top">
1.129 ! wiz 9786: <a name="devfaq.too-much-time"></a><a name="id1168230172917"></a><p><b>22.9.</b></p>
1.92 rillig 9787: </td>
9788: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9789: do?</p></td>
9790: </tr>
9791: <tr class="answer">
9792: <td align="left" valign="top"></td>
9793: <td align="left" valign="top">
1.93 rillig 9794: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9795: anyway.</p>
1.128 wiz 9796: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9797: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92 rillig 9798: <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
9799: will tell you about newer versions of installed packages that are
9800: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9801: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9802: — it contains a list of suggested new packages and a list of
1.92 rillig 9803: cleanups and enhancements for pkgsrc that would be nice to
9804: have.</p></li>
1.128 wiz 9805: <li class="listitem"><p>Review packages for which review was requested on
1.110 hubertf 9806: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92 rillig 9807: mailing list.</p></li>
9808: </ul></div>
9809: </td>
9810: </tr>
1.75 rillig 9811: </tbody>
9812: </table>
9813: </div>
9814: </div>
1.128 wiz 9815: <div class="chapter" title="Chapter 23. GNOME packaging and porting">
1.85 jmmv 9816: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9817: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9818: <div class="toc">
9819: <p><b>Table of Contents</b></p>
9820: <dl>
1.106 rillig 9821: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9822: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9823: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9824: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9825: </dl>
9826: </div>
1.110 hubertf 9827: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9828: site</a>:</p>
9829: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9830: environment, an intuitive and attractive desktop for users, and the
9831: GNOME development platform, an extensive framework for building
9832: applications that integrate into the rest of the desktop.</p></blockquote></div>
9833: <p>pkgsrc provides a seamless way to automatically build and install
9834: a complete GNOME environment <span class="emphasis"><em>under many different
9835: platforms</em></span>. We can say with confidence that pkgsrc is one of
9836: the most advanced build and packaging systems for GNOME due to its
9837: included technologies buildlink3, the wrappers and tools framework and
9838: automatic configuration file management. Lots of efforts are put into
9839: achieving a completely clean deinstallation of installed software
9840: components.</p>
1.110 hubertf 9841: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9842: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9843: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9844: pkgsrc as its preferred packaging system, contributing lots of
9845: portability fixes to make GNOME build and install under it.</p>
9846: <p>This chapter is aimed at pkgsrc developers and other people
9847: interested in helping our GNOME porting and packaging efforts. It
9848: provides instructions on how to manage the existing packages and some
9849: important information regarding their internals.</p>
1.128 wiz 9850: <div class="note" title="We need your help!" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9851: <h3 class="title">We need your help!</h3>
9852: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9853: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9854: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9855: work</a> list! There is still a long way to go to get a
9856: fully-functional GNOME desktop under NetBSD and we need your help to
9857: achieve it!</p>
9858: </div>
1.128 wiz 9859: <div class="sect1" title="23.1. Meta packages">
1.85 jmmv 9860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9861: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9862: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.128 wiz 9863: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9864: <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 9865: the core GNOME desktop environment. It only includes the necessary
9866: bits to get it to boot correctly, although it may lack important
9867: functionality for daily operation. The idea behind this package is
9868: to let end users build their own configurations on top of this one,
9869: first installing this meta package to achieve a functional setup and
9870: then adding individual applications.</p></li>
1.128 wiz 9871: <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 9872: complete installation of the GNOME platform and desktop as defined
9873: by the GNOME project; this is based on the components distributed in
9874: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9875: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9876: official FTP server. Developer-only tools found in those
9877: directories are not installed unless required by some other
9878: component to work properly. Similarly, packages from the bindings
9879: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9880: in unless required as a dependency for an end-user component. This
1.91 rillig 9881: 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 9882: <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 9883: Installs all the tools required to build a GNOME component when
9884: fetched from the CVS repository. These are required to let the
1.110 hubertf 9885: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9886: </ul></div>
9887: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9888: sorted in a way that eases updates: a package may depend on other
9889: packages listed before it but not on any listed after it. It is very
9890: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9891: change it to alphabetical sorting!</em></span></p>
9892: </div>
1.128 wiz 9893: <div class="sect1" title="23.2. Packaging a GNOME application">
1.85 jmmv 9894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9895: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9896: <p>Almost all GNOME applications are written in C and use a common
9897: set of tools as their build system. Things get different with the new
9898: bindings to other languages (such as Python), but the following will
9899: give you a general idea on the minimum required tools:</p>
1.128 wiz 9900: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9901: <li class="listitem">
1.85 jmmv 9902: <p>Almost all GNOME applications use the GNU Autotools as their
9903: build system. As a general rule you will need to tell this to your
9904: package:</p>
1.100 rillig 9905: <pre class="programlisting">
9906: GNU_CONFIGURE=yes
1.85 jmmv 9907: USE_LIBTOOL=yes
1.100 rillig 9908: USE_TOOLS+=gmake
9909: </pre>
1.85 jmmv 9910: </li>
1.128 wiz 9911: <li class="listitem">
1.85 jmmv 9912: <p>If the package uses pkg-config to detect dependencies, add this
9913: tool to the list of required utilities:</p>
9914: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9915: <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 9916: the end of the build process to ensure that you did not miss to
9917: specify any dependency in your package and that the version
9918: requirements are all correct.</p>
9919: </li>
1.128 wiz 9920: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9921: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9922: to handle dependencies and to force the package to use the latest
9923: available version.</p></li>
1.128 wiz 9924: <li class="listitem">
1.85 jmmv 9925: <p>If the package uses gtk-doc (a documentation generation
9926: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9927: tool is rather big and the distfile should come with pregenerated
9928: documentation anyway; if it does not, it is a bug that you ought to
9929: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9930: the default):</p>
9931: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9932: <p>The default location of installed HTML files
9933: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9934: and should not be changed unless the package insists on installing
9935: them somewhere else. Otherwise programs as
1.110 hubertf 9936: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9937: do that with an entry similar to:</p>
9938: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9939: </li>
9940: </ul></div>
9941: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9942: files under the installation prefix to maintain databases. In this
9943: context, shared means that those exact same directories and files are
9944: used among several different packages, leading to conflicts in the
9945: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9946: handle the most common cases, so you have to forget about using
9947: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9948: omitting shared files from them. If you find yourself doing those,
9949: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9950: <p>The following table lists the common situations that result in
9951: using shared directories or files. For each of them, the appropriate
9952: solution is given. After applying the solution be sure to
9953: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9954: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9955: <div class="table">
1.106 rillig 9956: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9957: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9958: <colgroup>
9959: <col>
9960: <col>
9961: </colgroup>
9962: <thead><tr>
9963: <th>If the package...</th>
9964: <th>Then...</th>
9965: </tr></thead>
9966: <tbody>
9967: <tr>
9968: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9969: <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 9970: </tr>
9971: <tr>
9972: <td>Installs icons under the
9973: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9974: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9975: <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 9976: </tr>
9977: <tr>
9978: <td>Installs files under
9979: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9980: <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 9981: </tr>
9982: <tr>
9983: <td>Installs <code class="filename">.desktop</code> files under
9984: <code class="filename">share/applications</code> and these include MIME
9985: information.</td>
1.110 hubertf 9986: <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 9987: </tr>
9988: </tbody>
1.91 rillig 9989: </table></div>
1.85 jmmv 9990: </div>
1.91 rillig 9991: <br class="table-break">
1.85 jmmv 9992: </div>
1.128 wiz 9993: <div class="sect1" title="23.3. Updating GNOME to a newer version">
1.85 jmmv 9994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9995: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9996: <p>When seeing GNOME as a whole, there are two kinds of
9997: updates:</p>
9998: <div class="variablelist"><dl>
9999: <dt><span class="term">Major update</span></dt>
10000: <dd>
10001: <p>Given that there is still a very long way for GNOME 3 (if it
10002: ever appears), we consider a major update one that goes from a
10003: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10004: where <code class="literal">Y</code> is even and greater than
10005: <code class="literal">X</code>. These are hard to achieve because they
10006: introduce lots of changes in the components' code and almost all
10007: GNOME distfiles are updated to newer versions. Some of them can
10008: even break API and ABI compatibility with the previous major
10009: version series. As a result, the update needs to be done all at
10010: once to minimize breakage.</p>
10011: <p>A major update typically consists of around 80 package
10012: updates and the addition of some new ones.</p>
10013: </dd>
10014: <dt><span class="term">Minor update</span></dt>
10015: <dd>
10016: <p>We consider a minor update one that goes from a
10017: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10018: one where <code class="literal">Y</code> is greater than
10019: <code class="literal">X</code>. These are easy to achieve because they do
10020: not update all GNOME components, can be done in an incremental way
10021: and do not break API nor ABI compatibility.</p>
10022: <p>A minor update typically consists of around 50 package
10023: updates, although the numbers here may vary a lot.</p>
10024: </dd>
10025: </dl></div>
10026: <p>In order to update the GNOME components in pkgsrc to a new stable
10027: release (either major or minor), the following steps should be
10028: followed:</p>
1.128 wiz 10029: <div class="orderedlist"><ol class="orderedlist" type="1">
10030: <li class="listitem">
1.85 jmmv 10031: <p>Get a list of all the tarballs that form the new release by
10032: using the following commands. These will leave the full list of the
1.120 snj 10033: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 10034: file:</p>
1.88 wiz 10035: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10036: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10037: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 10038: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10039: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10040: awk '{ print $9 }' >>list.txt</code></strong></pre>
10041: </li>
1.128 wiz 10042: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 10043: bump their version to the release you are updating them to. The
10044: three meta packages should be always consistent with versioning.
10045: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10046: in them.</p></li>
1.128 wiz 10047: <li class="listitem">
1.85 jmmv 10048: <p>For each meta package, update all its
10049: <code class="varname">DEPENDS</code> lines to match the latest versions as
10050: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10051: newer version (even if found in the FTP) because the meta packages
10052: are supposed to list the exact versions that form a specific GNOME
10053: release. Exceptions are permitted here if a newer version solves a
10054: serious issue in the overall desktop experience; these typically
10055: come in the form of a revision bump in pkgsrc, not in newer versions
10056: from the developers.</p>
10057: <p>Packages not listed in the <code class="filename">list.txt</code> file
10058: should be updated to the latest version available (if found in
10059: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 10060: 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 10061: </li>
1.128 wiz 10062: <li class="listitem">
1.85 jmmv 10063: <p>Generate a patch from the modified meta packages and extract the
10064: list of "new" lines. This will provide you an outline on what
10065: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10066: <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 10067: </li>
1.128 wiz 10068: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 10069: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 10070: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 10071: of <code class="filename">todo.txt</code> and update the packages listed in
10072: it in order. For major desktop updates none of these should be
1.93 rillig 10073: committed until the entire set is completed because there are chances
1.85 jmmv 10074: of breaking not-yet-updated packages.</p></li>
1.128 wiz 10075: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 10076: the tree one by one with appropriate log messages. At the end,
10077: commit the three meta package updates and all the corresponding
10078: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10079: <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>
10080: </ol></div>
10081: </div>
1.128 wiz 10082: <div class="sect1" title="23.4. Patching guidelines">
1.85 jmmv 10083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10084: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10085: <p>GNOME is a very big component in pkgsrc which approaches 100
10086: packages. Please, it is very important that you always, always,
10087: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10088: 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 10089: their attention on portability issues and to ensure that future versions
10090: can be built out-of-the box on NetBSD. The less custom patches in
10091: pkgsrc, the easier further updates are. Those developers in charge of
10092: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10093: <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 10094: Bugzilla</a>. Not all components use these to track bugs, but most
10095: of them do. Do not be short on your reports: always provide detailed
10096: explanations of the current failure, how it can be improved to achieve
10097: maximum portability and, if at all possible, provide a patch against CVS
10098: head. The more verbose you are, the higher chances of your patch being
10099: accepted.</p>
10100: <p>Also, please avoid using preprocessor magic to fix portability
10101: issues. While the FreeBSD GNOME people are doing a great job in porting
10102: GNOME to their operating system, the official GNOME sources are now
10103: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10104: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10105: 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 10106: details.</p>
10107: </div>
10108: </div>
1.75 rillig 10109: </div>
1.128 wiz 10110: <div class="part" title="Part III. The pkgsrc infrastructure internals">
1.75 rillig 10111: <div class="titlepage"><div><div><h1 class="title">
10112: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.128 wiz 10113: <div class="partintro" title="The pkgsrc infrastructure internals">
1.75 rillig 10114: <div></div>
10115: <p>This part of the guide deals with everything
10116: from the infrastructure that is behind the interfaces described
10117: in the developer's guide. A casual package maintainer should not
10118: need anything from this part.</p>
10119: <div class="toc">
10120: <p><b>Table of Contents</b></p>
10121: <dl>
1.106 rillig 10122: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10123: <dd><dl>
1.106 rillig 10124: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10125: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10126: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10127: <dd><dl>
1.106 rillig 10128: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10129: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10130: </dl></dd>
1.106 rillig 10131: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10132: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10133: <dd><dl>
1.106 rillig 10134: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10135: <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 10136: </dl></dd>
1.106 rillig 10137: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10138: <dd><dl>
1.128 wiz 10139: <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>
10140: <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 10141: </dl></dd>
10142: </dl></dd>
1.106 rillig 10143: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10144: <dd><dl>
1.106 rillig 10145: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10146: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10147: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10148: <dd><dl>
1.106 rillig 10149: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10150: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10151: </dl></dd>
10152: </dl></dd>
1.106 rillig 10153: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10154: <dd><dl>
1.106 rillig 10155: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10156: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10157: </dl></dd>
10158: </dl>
10159: </div>
10160: </div>
1.128 wiz 10161: <div class="chapter" title="Chapter 24. Design of the pkgsrc infrastructure">
1.75 rillig 10162: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10163: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10164: <div class="toc">
10165: <p><b>Table of Contents</b></p>
10166: <dl>
1.106 rillig 10167: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10168: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10169: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10170: <dd><dl>
1.106 rillig 10171: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10172: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10173: </dl></dd>
1.106 rillig 10174: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10175: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10176: <dd><dl>
1.106 rillig 10177: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10178: <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 10179: </dl></dd>
1.106 rillig 10180: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10181: <dd><dl>
1.128 wiz 10182: <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>
10183: <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 10184: </dl></dd>
10185: </dl>
10186: </div>
10187: <p>The pkgsrc infrastructure consists of many small Makefile
10188: fragments. Each such fragment needs a properly specified
10189: interface. This chapter explains how such an interface looks
10190: like.</p>
1.128 wiz 10191: <div class="sect1" title="24.1. The meaning of variable definitions">
1.75 rillig 10192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10193: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10194: <p>Whenever a variable is defined in the pkgsrc
10195: infrastructure, the location and the way of definition provide
10196: much information about the intended use of that variable.
10197: Additionally, more documentation may be found in a header
10198: comment or in this pkgsrc guide.</p>
10199: <p>A special file is
10200: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10201: variables that are intended to be user-defined. They are either
10202: defined using the <code class="literal">?=</code> operator or they are
10203: left undefined because defining them to anything would
1.128 wiz 10204: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10205: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10206: file.</p>
10207: <p>Outside this file, the following conventions apply:
10208: Variables that are defined using the <code class="literal">?=</code>
10209: operator may be overridden by a package.</p>
10210: <p>Variables that are defined using the <code class="literal">=</code>
10211: operator may be used read-only at run-time.</p>
10212: <p>Variables whose name starts with an underscore must not be
10213: accessed outside the pkgsrc infrastructure at all. They may
10214: change without further notice.</p>
1.128 wiz 10215: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10216: <h3 class="title">Note</h3>
10217: <p>These conventions are currently not applied
10218: consistently to the complete pkgsrc
10219: infrastructure.</p>
10220: </div>
10221: </div>
1.128 wiz 10222: <div class="sect1" title="24.2. Avoiding problems before they arise">
1.81 rillig 10223: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10224: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10225: <p>All variables that contain lists of things should default
10226: to being empty. Two examples that do not follow this rule are
10227: <code class="varname">USE_LANGUAGES</code> and
10228: <code class="varname">DISTFILES</code>. These variables cannot simply be
10229: modified using the <code class="literal">+=</code> operator in package
10230: <code class="filename">Makefile</code>s (or other files included by
10231: them), since there is no guarantee whether the variable is
10232: already set or not, and what its value is. In the case of
1.128 wiz 10233: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10234: the default value and just define it as in the following
10235: example.</p>
10236: <pre class="programlisting">
1.100 rillig 10237: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10238: </pre>
10239: <p>Because of the selection of this default value, the same
10240: value appears in many package Makefiles. Similarly for
10241: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10242: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10243: doesn't stand out. Nevertheless it is mentioned in many
10244: files.</p>
10245: </div>
1.128 wiz 10246: <div class="sect1" title="24.3. Variable evaluation">
1.81 rillig 10247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10248: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.128 wiz 10249: <div class="sect2" title="24.3.1. At load time">
1.75 rillig 10250: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10251: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10252: <p>Variable evaluation takes place either at load time or at
10253: runtime, depending on the context in which they occur. The
10254: contexts where variables are evaluated at load time are:</p>
1.128 wiz 10255: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
10256: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10257: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10258: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10259: <code class="literal">.for</code>,</p></li>
1.128 wiz 10260: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10261: </ul></div>
10262: <p>A special exception are references to the iteration
10263: variables of <code class="literal">.for</code> loops, which are expanded
10264: inline, no matter in which context they appear.</p>
10265: <p>As the values of variables may change during load time,
10266: care must be taken not to evaluate them by accident. Typical
10267: examples for variables that should not be evaluated at load time
10268: are <code class="varname">DEPENDS</code> and
10269: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10270: clear, here is an example:</p>
10271: <pre class="programlisting">
1.100 rillig 10272: CONFIGURE_ARGS= # none
10273: CFLAGS= -O
10274: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10275:
1.100 rillig 10276: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10277:
1.100 rillig 10278: CFLAGS+= -Wall
1.75 rillig 10279: </pre>
10280: <p>This code shows how the use of the <code class="literal">:=</code>
10281: operator can quickly lead to unexpected results. The first
10282: paragraph is fairly common code. The second paragraph evaluates
10283: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10284: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10285: <code class="literal">-Wall</code> is appended to the
10286: <code class="varname">CFLAGS</code>, but this addition will not appear in
10287: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10288: paragraphs from above typically occur in completely unrelated
10289: files.</p>
10290: </div>
1.128 wiz 10291: <div class="sect2" title="24.3.2. At runtime">
1.75 rillig 10292: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10293: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10294: <p>After all the files have been loaded, the values of the
10295: variables cannot be changed anymore. Variables that are used in
10296: the shell commands are expanded at this point.</p>
10297: </div>
10298: </div>
1.128 wiz 10299: <div class="sect1" title="24.4. How can variables be specified?">
1.75 rillig 10300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10301: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10302: <p>There are many ways in which the definition and use of a
10303: variable can be restricted in order to detect bugs and
10304: violations of the (mostly unwritten) policies. See the
10305: <code class="literal">pkglint</code> developer's documentation for further
10306: details.</p>
10307: </div>
1.128 wiz 10308: <div class="sect1" title="24.5. Designing interfaces for Makefile fragments">
1.78 rillig 10309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10310: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10311: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10312: of the following classes. Cases where a file falls into more
10313: than one class should be avoided as it often leads to subtle
10314: bugs.</p>
1.128 wiz 10315: <div class="sect2" title="24.5.1. Procedures with parameters">
1.75 rillig 10316: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10317: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10318: <p>In a traditional imperative programming language some of
1.76 rillig 10319: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10320: procedures. They take some input parameters and—after
10321: inclusion—provide a result in output parameters. Since all
1.76 rillig 10322: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10323: care must be taken not to use parameter names that have already
10324: another meaning. For example, <code class="varname">PKGNAME</code> is a
10325: bad choice for a parameter name.</p>
10326: <p>Procedures are completely evaluated at preprocessing time.
10327: That is, when calling a procedure all input parameters must be
10328: completely resolvable. For example,
10329: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10330: parameter since it is very likely that further text will be
10331: added after calling the procedure, which would effectively apply
10332: the procedure to only a part of the variable. Also, references
10333: to other variables wit will be modified after calling the
10334: procedure.</p>
10335: <p>A procedure can declare its output parameters either as
10336: suitable for use in preprocessing directives or as only
10337: available at runtime. The latter alternative is for variables
10338: that contain references to other runtime variables.</p>
10339: <p>Procedures shall be written such that it is possible to
10340: call the procedure more than once. That is, the file must not
10341: contain multiple-inclusion guards.</p>
10342: <p>Examples for procedures are
1.76 rillig 10343: <code class="filename">mk/bsd.options.mk</code> and
10344: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10345: that the parameters are evaluated at load time, they should be
10346: assigned using the <code class="literal">:=</code> operator, which should
10347: be used only for this purpose.</p>
10348: </div>
1.128 wiz 10349: <div class="sect2" title="24.5.2. Actions taken on behalf of parameters">
1.75 rillig 10350: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10351: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10352: <p>Action files take some input parameters and may define
10353: runtime variables. They shall not define loadtime variables.
10354: There are action files that are included implicitly by the
10355: pkgsrc infrastructure, while other must be included
10356: explicitly.</p>
10357: <p>An example for action files is
1.76 rillig 10358: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10359: </div>
10360: </div>
1.128 wiz 10361: <div class="sect1" title="24.6. The order in which files are loaded">
1.81 rillig 10362: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10363: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10364: <p>Package <code class="filename">Makefile</code>s usually consist of
10365: a set of variable definitions, and include the file
10366: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10367: Before that, they may also include various other
10368: <code class="filename">*.mk</code> files if they need to query the
10369: availability of certain features like the type of compiler or
10370: the X11 implementation. Due to the heavy use of preprocessor
10371: directives like <code class="literal">.if</code> and
10372: <code class="literal">.for</code>, the order in which the files are loaded
10373: matters.</p>
10374: <p>This section describes at which point the various files
10375: are loaded and gives reasons for that order.</p>
1.128 wiz 10376: <div class="sect2" title="24.6.1. The order in bsd.prefs.mk">
1.81 rillig 10377: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10378: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10379: </h3></div></div></div>
10380: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10381: is to define some essential variables like
10382: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10383: <code class="varname">MACHINE_ARCH</code>.</p>
10384: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10385: 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 10386: After that, those variables
1.81 rillig 10387: that have not been overridden by the user are loaded from
10388: <code class="filename">mk/defaults/mk.conf</code>.</p>
10389: <p>After the user settings, the system settings and platform
10390: settings are loaded, which may override the user
10391: settings.</p>
10392: <p>Then, the tool definitions are loaded. The tool wrappers
10393: are not yet in effect. This only happens when building a
10394: package, so the proper variables must be used instead of the
10395: direct tool names.</p>
10396: <p>As the last steps, some essential variables from the
10397: wrapper and the package system flavor are loaded, as well as the
10398: variables that have been cached in earlier phases of a package
10399: build.</p>
10400: </div>
1.128 wiz 10401: <div class="sect2" title="24.6.2. The order in bsd.pkg.mk">
1.81 rillig 10402: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10403: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10404: </h3></div></div></div>
1.81 rillig 10405: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10406: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10407: loaded, which fill default values for those variables that have
1.93 rillig 10408: not been defined by the package. These variables may later
1.81 rillig 10409: be used even in unrelated files.</p>
10410: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10411: provides the target <code class="literal">error-check</code> that is added
10412: as a special dependency to all other targets that use
10413: <code class="varname">DELAYED_ERROR_MSG</code> or
10414: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10415: <p>Then, the package-specific hacks from
10416: <code class="filename">hacks.mk</code> are included.</p>
10417: <p>Then, various other files follow. Most of them don't have
10418: any dependencies on what they need to have included before or
10419: after them, though some do.</p>
10420: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10421: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10422: restricts the use of these variables to all the files that have
10423: been included before. Appearances in later files will be
10424: silently ignored.</p>
10425: <p>Then, the files for the main targets are included, in the
10426: order of later execution, though the actual order should not
10427: matter.</p>
10428: <p>At last, some more files are included that don't set any
10429: interesting variables but rather just define make targets to be
10430: executed.</p>
10431: </div>
10432: </div>
1.75 rillig 10433: </div>
1.128 wiz 10434: <div class="chapter" title="Chapter 25. Regression tests">
1.75 rillig 10435: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10436: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10437: <div class="toc">
10438: <p><b>Table of Contents</b></p>
10439: <dl>
1.106 rillig 10440: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10441: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10442: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10443: <dd><dl>
1.106 rillig 10444: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10445: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10446: </dl></dd>
10447: </dl>
10448: </div>
10449: <p>The pkgsrc infrastructure consists of a large codebase,
10450: and there are many corners where every little bit of a file is
10451: well thought out, making pkgsrc likely to fail as soon as
10452: anything is changed near those parts. To prevent most changes
10453: from breaking anything, a suite of regression tests should go
10454: along with every important part of the pkgsrc infrastructure.
10455: This chapter describes how regression tests work in pkgsrc and
10456: how you can add new tests.</p>
1.128 wiz 10457: <div class="sect1" title="25.1. The regression tests framework">
1.75 rillig 10458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10459: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10460: <p></p>
10461: </div>
1.128 wiz 10462: <div class="sect1" title="25.2. Running the regression tests">
1.75 rillig 10463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10464: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10465: <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 10466: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10467: can simply run that command, which will run all tests in the
1.76 rillig 10468: <code class="filename">regress</code> category.</p>
1.75 rillig 10469: </div>
1.128 wiz 10470: <div class="sect1" title="25.3. Adding a new regression test">
1.75 rillig 10471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10472: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10473: <p>Every directory in the <code class="filename">regress</code>
10474: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10475: is considered a regression test. This file is a shell program
1.110 hubertf 10476: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10477: The following functions can be overridden to suit your
10478: needs.</p>
1.128 wiz 10479: <div class="sect2" title="25.3.1. Overridable functions">
1.75 rillig 10480: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10481: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10482: <p>These functions do not take any parameters. They are all
1.128 wiz 10483: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10484: to check the exitcodes of any commands you run in the
10485: test.</p>
10486: <div class="variablelist"><dl>
10487: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10488: <dd><p>This function prepares the environment for the
10489: test. By default it does nothing.</p></dd>
10490: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10491: <dd><p>This function runs the actual test. By default,
10492: it calls <code class="varname">TEST_MAKE</code> with the arguments
10493: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10494: error messages into the file
10495: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10496: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10497: <dd><p>This function is run after the test and is
10498: typically used to compare the actual output from the one that is
10499: expected. It can make use of the various helper functions from
10500: the next section.</p></dd>
10501: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10502: <dd><p>This function cleans everything up after the
10503: test has been run. By default it does nothing.</p></dd>
10504: </dl></div>
10505: </div>
1.128 wiz 10506: <div class="sect2" title="25.3.2. Helper functions">
1.75 rillig 10507: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10508: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10509: <div class="variablelist"><dl>
10510: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10511: <dd><p>This function compares the exitcode of the
1.110 hubertf 10512: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10513: If they differ, the test will fail.</p></dd>
10514: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10515: <dd><p>This function checks for each of its parameters
1.110 hubertf 10516: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10517: extended regular expression. If it does not, the test will
10518: fail.</p></dd>
10519: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10520: <dd><p>This function checks for each of its parameters
1.110 hubertf 10521: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10522: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10523: If any of the regular expressions matches, the test will
10524: fail.</p></dd>
10525: </dl></div>
10526: </div>
10527: </div>
10528: </div>
1.128 wiz 10529: <div class="chapter" title="Chapter 26. Porting pkgsrc">
1.75 rillig 10530: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10531: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10532: <div class="toc">
10533: <p><b>Table of Contents</b></p>
10534: <dl>
1.106 rillig 10535: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10536: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10537: </dl>
10538: </div>
10539: <p>The pkgsrc system has already been ported to many
10540: operating systems, hardware architectures and compilers. This
10541: chapter explains the necessary steps to make pkgsrc even more
10542: portable.</p>
1.128 wiz 10543: <div class="sect1" title="26.1. Porting pkgsrc to a new operating system">
1.75 rillig 10544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10545: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10546: <p>To port pkgsrc to a new operating system (called
10547: <code class="literal">MyOS</code> in this example), you need to touch the
10548: following files:</p>
10549: <div class="variablelist"><dl>
1.93 rillig 10550: <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 10551: <dd><p>This file contains some basic definitions, for
10552: example the name of the C
10553: compiler.</p></dd>
1.76 rillig 10554: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10555: <dd><p>Insert code that defines the variables
10556: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10557: <code class="varname">LOWER_OS_VERSION</code>,
10558: <code class="varname">LOWER_VENDOR</code>,
10559: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10560: <code class="varname">APPEND_ELF</code>, and the other variables that
10561: appear in this file.</p></dd>
1.93 rillig 10562: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10563: <dd><p>This file contains the platform-specific
10564: definitions that are used by pkgsrc. Start by copying one of the
10565: other files and edit it to your
10566: needs.</p></dd>
1.93 rillig 10567: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10568: <dd><p>This file contains a list of directories,
10569: together with their permission bits and ownership. These
10570: directories will be created automatically with every package
1.98 wiz 10571: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10572: be removed.</p></dd>
1.93 rillig 10573: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10574: <dd><p>Just copy one of the pre-existing x11.dist files
10575: to your
1.76 rillig 10576: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10577: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10578: <dd><p>On some operating systems, the tools that are
10579: provided with the base system are not good enough for pkgsrc.
1.110 hubertf 10580: For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.75 rillig 10581: narrow limit on the line length they can process. Therefore
10582: pkgsrc brings its own tools, which can be enabled
10583: here.</p></dd>
1.93 rillig 10584: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10585: <dd><p>This file defines the paths to all the tools
10586: that are needed by one or the other package in pkgsrc, as well
10587: as by pkgsrc itself. Find out where these tools are on your
10588: platform and add them.</p></dd>
10589: </dl></div>
10590: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10591: <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 10592: </div>
1.128 wiz 10593: <div class="sect1" title="26.2. Adding support for a new compiler">
1.75 rillig 10594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10595: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10596: <p>TODO</p>
10597: </div>
10598: </div>
10599: </div>
1.128 wiz 10600: <div class="appendix" title="Appendix A. A simple example package: bison">
1.75 rillig 10601: <div class="titlepage"><div><div><h2 class="title">
10602: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10603: <div class="toc">
10604: <p><b>Table of Contents</b></p>
10605: <dl>
10606: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10607: <dd><dl>
10608: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10609: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10610: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10611: <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 10612: </dl></dd>
10613: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10614: </dl>
10615: </div>
10616: <p>We checked to find a piece of software that wasn't in the packages
10617: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10618: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10619: present in the tree is beyond us, but it's useful for the purposes of
10620: this exercise.</p>
1.128 wiz 10621: <div class="sect1" title="A.1. files">
1.75 rillig 10622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10623: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.128 wiz 10624: <div class="sect2" title="A.1.1. Makefile">
1.75 rillig 10625: <div class="titlepage"><div><div><h3 class="title">
10626: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10627: <pre class="programlisting">
1.100 rillig 10628: # $NetBSD$
10629: #
1.1 grant 10630:
1.100 rillig 10631: DISTNAME= bison-1.25
10632: CATEGORIES= devel
10633: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10634:
1.100 rillig 10635: MAINTAINER= thorpej@NetBSD.org
10636: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10637: COMMENT= GNU yacc clone
1.1 grant 10638:
1.100 rillig 10639: GNU_CONFIGURE= yes
10640: INFO_FILES= bison.info
1.1 grant 10641:
1.100 rillig 10642: .include "../../mk/bsd.pkg.mk"
1.1 grant 10643: </pre>
1.75 rillig 10644: </div>
1.128 wiz 10645: <div class="sect2" title="A.1.2. DESCR">
1.75 rillig 10646: <div class="titlepage"><div><div><h3 class="title">
10647: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10648: <pre class="programlisting">
1.100 rillig 10649: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.110 hubertf 10650: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 10651: of the NetBSD source tree is beyond me.
1.1 grant 10652: </pre>
1.75 rillig 10653: </div>
1.128 wiz 10654: <div class="sect2" title="A.1.3. PLIST">
1.75 rillig 10655: <div class="titlepage"><div><div><h3 class="title">
10656: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10657: <pre class="programlisting">
1.100 rillig 10658: @comment $NetBSD$
10659: bin/bison
10660: man/man1/bison.1.gz
10661: share/bison.simple
10662: share/bison.hairy
1.1 grant 10663: </pre>
1.75 rillig 10664: </div>
1.128 wiz 10665: <div class="sect2" title="A.1.4. Checking a package with pkglint">
1.75 rillig 10666: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10667: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10668: </h3></div></div></div>
1.75 rillig 10669: <p>The NetBSD package system comes with
1.91 rillig 10670: <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 10671: which helps to check the contents of these
10672: files. After installation it is quite easy to use, just change to the
10673: directory of the package you wish to examine and execute
1.110 hubertf 10674: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10675: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10676: looks fine.</pre>
10677: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10678: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10679: -Wall</strong></span> for a very thorough check.</p>
10680: </div>
10681: </div>
1.128 wiz 10682: <div class="sect1" title="A.2. Steps for building, installing, packaging">
1.75 rillig 10683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10684: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10685: <p>Create the directory where the package lives,
10686: plus any auxiliary directories:</p>
10687: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10688: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10689: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10690: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10691: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10692: <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 10693: then continue with fetching the distfile:</p>
10694: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10695: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10696: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10697: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10698: ftp: Error retrieving file: 500 Internal error
10699:
10700: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10701: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10702: ftp: Error retrieving file: 500 Internal error
10703:
10704: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10705: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10706: Successfully retrieved file.</pre>
10707: <p>Generate the checksum of the distfile into
1.76 rillig 10708: <code class="filename">distinfo</code>:</p>
1.88 wiz 10709: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10710: <p>Now compile:</p>
10711: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10712: >> Checksum OK for bison-1.25.tar.gz.
10713: ===> Extracting for bison-1.25
10714: ===> Patching for bison-1.25
10715: ===> Ignoring empty patch directory
10716: ===> Configuring for bison-1.25
10717: creating cache ./config.cache
10718: checking for gcc... cc
10719: checking whether we are using GNU C... yes
10720: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10721: checking how to run the C preprocessor... cc -E
10722: checking for minix/config.h... no
10723: checking for POSIXized ISC... no
10724: checking whether cross-compiling... no
10725: checking for ANSI C header files... yes
10726: checking for string.h... yes
10727: checking for stdlib.h... yes
10728: checking for memory.h... yes
10729: checking for working const... yes
10730: checking for working alloca.h... no
10731: checking for alloca... yes
10732: checking for strerror... yes
10733: updating cache ./config.cache
10734: creating ./config.status
10735: creating Makefile
10736: ===> Building for bison-1.25
10737: 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
10738: 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
10739: 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
10740: 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
10741: 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 10742: 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 10743: 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
10744: 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
10745: 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
10746: 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
10747: 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
10748: 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
10749: 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
10750: 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
10751: 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
10752: 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
10753: 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
10754: 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
10755: 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
10756: 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
10757: 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
10758: 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
10759: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10760: rm -f bison.s1
1.75 rillig 10761: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10762: <p>Everything seems OK, so install the files:</p>
10763: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10764: >> Checksum OK for bison-1.25.tar.gz.
10765: ===> Installing for bison-1.25
10766: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10767: rm -f /usr/pkg/bin/bison
10768: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10769: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10770: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10771: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10772: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10773: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10774: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10775: ===> Registering installation for bison-1.25</pre>
10776: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10777: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10778: binary package, do this now:</p>
10779: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10780: >> Checksum OK for bison-1.25.tar.gz.
10781: ===> Building package for bison-1.25
10782: Creating package bison-1.25.tgz
10783: Registering depends:.
1.75 rillig 10784: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10785: <p>Now that you don't need the source and object files
10786: any more, clean up:</p>
10787: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10788: ===> Cleaning for bison-1.25</pre>
10789: </div>
10790: </div>
1.128 wiz 10791: <div class="appendix" title="Appendix B. Build logs">
1.75 rillig 10792: <div class="titlepage"><div><div><h2 class="title">
10793: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10794: <div class="toc">
10795: <p><b>Table of Contents</b></p>
10796: <dl>
10797: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10798: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10799: </dl>
10800: </div>
1.128 wiz 10801: <div class="sect1" title="B.1. Building figlet">
1.75 rillig 10802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10803: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10804: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10805: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10806: => figlet221.tar.gz doesn't seem to exist on this system.
10807: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10808: => [172219 bytes]
10809: Connected to ftp.plig.net.
10810: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10811: 331 Guest login ok, send your complete e-mail address as password.
10812: 230-You are user #5 of 500 simultaneous users allowed.
10813: 230-
1.68 rillig 10814: 230- ___ _ _ _
10815: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10816: 230- | _| _| . |_| . | | | . |_| . | _| . |
10817: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10818: 230- |_| |_| |___| |___|
10819: 230-
10820: 230-** Welcome to ftp.plig.org **
10821: 230-
10822: 230-Please note that all transfers from this FTP site are logged. If you
10823: 230-do not like this, please disconnect now.
10824: 230-
1.120 snj 10825: 230-This archive is available via
1.1 grant 10826: 230-
10827: 230-HTTP: http://ftp.plig.org/
10828: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10829: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10830: 230-
10831: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10832: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10833: 230-
10834: 230-
10835: 230 Logged in anonymously.
10836: Remote system type is UNIX.
10837: Using binary mode to transfer files.
10838: 200 Type okay.
10839: 250 "/pub" is new cwd.
10840: 250-"/pub/figlet" is new cwd.
10841: 250-
10842: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10843: 250-
1.75 rillig 10844: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10845: 250-
10846: 250-The official FIGlet web page is:
1.75 rillig 10847: 250- http://www.figlet.org/
1.1 grant 10848: 250-
10849: 250-If you have questions, please mailto:info@figlet.org. If you want to
10850: 250-contribute a font or something else, you can email us.
1.68 rillig 10851: 250
1.1 grant 10852: 250 "/pub/figlet/program" is new cwd.
10853: 250 "/pub/figlet/program/unix" is new cwd.
10854: local: figlet221.tar.gz remote: figlet221.tar.gz
10855: 502 Unimplemented command.
10856: 227 Entering Passive Mode (195,40,6,41,246,104)
10857: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10858: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10859: 226 Transfer completed.
10860: 172219 bytes received in 00:02 (75.99 KB/s)
10861: 221 Goodbye.
10862: => Checksum OK for figlet221.tar.gz.
10863: ===> Extracting for figlet-2.2.1nb2
10864: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10865: ===> Patching for figlet-2.2.1nb2
10866: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10867: ===> Overriding tools for figlet-2.2.1nb2
10868: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10869: ===> Configuring for figlet-2.2.1nb2
10870: ===> Building for figlet-2.2.1nb2
10871: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10872: chmod a+x figlet
10873: gcc -O2 -o chkfont chkfont.c
10874: => Unwrapping files-to-be-installed.
1.14 xtraeme 10875: <code class="prompt">#</code>
1.75 rillig 10876: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10877: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10878: ===> Installing for figlet-2.2.1nb2
10879: install -d -o root -g wheel -m 755 /usr/pkg/bin
10880: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10881: mkdir -p /usr/pkg/share/figlet
10882: cp figlet /usr/pkg/bin
10883: cp chkfont /usr/pkg/bin
10884: chmod 555 figlist showfigfonts
10885: cp figlist /usr/pkg/bin
10886: cp showfigfonts /usr/pkg/bin
10887: cp fonts/*.flf /usr/pkg/share/figlet
10888: cp fonts/*.flc /usr/pkg/share/figlet
10889: cp figlet.6 /usr/pkg/man/man6
10890: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10891: <code class="prompt">#</code></pre>
10892: </div>
1.128 wiz 10893: <div class="sect1" title="B.2. Packaging figlet">
1.75 rillig 10894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10895: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10896: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10897: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10898: ===> Packaging figlet-2.2.1nb2
10899: ===> Building binary package for figlet-2.2.1nb2
10900: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10901: Using SrcDir value of /usr/pkg
1.68 rillig 10902: Registering depends:.
1.75 rillig 10903: <code class="prompt">#</code></pre>
10904: </div>
10905: </div>
1.128 wiz 10906: <div class="appendix" title="Appendix C. Directory layout of the pkgsrc FTP server">
1.75 rillig 10907: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10908: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10909: <div class="toc">
10910: <p><b>Table of Contents</b></p>
10911: <dl>
1.128 wiz 10912: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10913: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10914: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10915: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10916: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10917: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10918: source packages</a></span></dt>
10919: </dl>
10920: </div>
10921: <p>As in other big projects, the directory layout of pkgsrc
10922: is quite complex for newbies. This chapter explains where you
10923: find things on the FTP server. The base directory on
1.110 hubertf 10924: <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 10925: On other servers it may be different, but inside this directory,
10926: everything should look the same, no matter on which server you
10927: are. This directory contains some subdirectories, which are
10928: explained below.</p>
1.128 wiz 10929: <div class="sect1" title="C.1. distfiles: The distributed source files">
1.76 rillig 10930: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10931: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10932: <p>The directory <code class="filename">distfiles</code> contains lots
10933: of archive files from all pkgsrc packages, which are mirrored
10934: here. The subdirectories are called after their package names
10935: and are used when the distributed files have names that don't
10936: explicitly contain a version number or are otherwise too generic
10937: (for example <code class="filename">release.tar.gz</code>).</p>
10938: </div>
1.128 wiz 10939: <div class="sect1" title="C.2. misc: Miscellaneous things">
1.76 rillig 10940: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10941: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10942: <p>This directory contains things that individual pkgsrc
10943: developers find worth publishing.</p>
10944: </div>
1.128 wiz 10945: <div class="sect1" title="C.3. packages: Binary packages">
1.76 rillig 10946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10947: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10948: <p>This directory contains binary packages for the various
10949: platforms that are supported by pkgsrc.
10950: 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.128 wiz 10951: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
10952: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10953: operating system for which the packages have been built. The
1.110 hubertf 10954: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10955: command, so it may differ from the one you are used to
10956: hear.</p></li>
1.128 wiz 10957: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10958: architecture of the platform for which the packages have been
1.110 hubertf 10959: built. It also includes the <code class="varname">ABI</code> (Application
10960: Binary Interface) for platforms that have several of
10961: them.</p></li>
1.128 wiz 10962: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10963: the operating system. For version numbers that change often (for
10964: example NetBSD-current), the often-changing part should be
10965: replaced with an <code class="literal">x</code>, for example
10966: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 10967: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10968: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10969: for a stable branch, or <code class="literal">head</code> for packages
10970: built from the HEAD branch. The latter should only be used when
10971: the packages are updated on a regular basis. Otherwise the date
10972: from checking out pkgsrc should be appended, for example
10973: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10974: </ul></div>
10975: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10976: can quickly click through the directories on the
10977: server and find the best binary packages for their machines. Since they
10978: usually know the operating system and the hardware architecture, OPSYS
10979: and ARCH are placed first. After these choices, they can select the
10980: best combination of OSVERSION and TAG together, since it is usually the
10981: case that packages stay compatible between different version of the
10982: operating system.</p>
10983: <p>In each of these directories, there is a
10984: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10985: <code class="filename">All</code> which contains all binary packages.
10986: Besides that, there are various category directories that
10987: contain symbolic links to the real binary packages.</p>
10988: </div>
1.128 wiz 10989: <div class="sect1" title="C.4. reports: Bulk build reports">
1.76 rillig 10990: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10991: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10992: <p>Here are the reports from bulk builds, for those who want
10993: to fix packages that didn't build on some of the platforms. The
1.128 wiz 10994: 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 10995: </div>
1.128 wiz 10996: <div class="sect1" title="C.5. current, pkgsrc-20xxQy: source packages">
1.108 rillig 10997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10998: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10999: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11000: source packages</h2></div></div></div>
1.128 wiz 11001: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11002: that is the files that define how to create binary packages from
11003: source archives.</p>
11004: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11005: snapshot of the CVS repository, which is updated regularly. The
11006: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11007: directory, ready to be downloaded as a whole.</p>
1.76 rillig 11008: <p>In the directories for the quarterly branches, there is an
11009: additional file called
1.126 jakllsch 11010: <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 11011: which contains the state of pkgsrc when it was branched.</p>
11012: </div>
1.75 rillig 11013: </div>
1.128 wiz 11014: <div class="appendix" title="Appendix D. Editing guidelines for the pkgsrc guide">
1.75 rillig 11015: <div class="titlepage"><div><div><h2 class="title">
11016: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
11017: <div class="toc">
11018: <p><b>Table of Contents</b></p>
11019: <dl>
1.79 rillig 11020: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 11021: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11022: </dl>
11023: </div>
1.79 rillig 11024: <p>This section contains information on editing the pkgsrc
11025: guide itself.</p>
1.128 wiz 11026: <div class="sect1" title="D.1. Make targets">
1.75 rillig 11027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 11028: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11029: <p>The pkgsrc guide's source code is stored in
11030: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11031: are created from it:</p>
1.128 wiz 11032: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
11033: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11034: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
11035: <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>
11036: <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 11037: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 11038: <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 11039: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 11040: </ul></div>
11041: </div>
1.128 wiz 11042: <div class="sect1" title="D.2. Procedure">
1.75 rillig 11043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11044: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 11045: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 11046: <div class="procedure"><ol class="procedure" type="1">
11047: <li class="step" title="Step 1"><p>Make sure you have the packages needed to
1.83 wiz 11048: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 11049: 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
11050: 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 11051: PostScript and PDF versions. You will need both packages
11052: installed, to make sure documentation is consistent across all
11053: formats.</p></li>
1.128 wiz 11054: <li class="step" title="Step 2"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 11055: right directory. All further steps will take place
11056: here.</p></li>
1.128 wiz 11057: <li class="step" title="Step 3"><p>Edit the XML file(s) in
1.79 rillig 11058: <code class="filename">files/</code>.</p></li>
1.128 wiz 11059: <li class="step" title="Step 4"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 11060: guide for valid XML and to build the final output files. If you
11061: get any errors at this stage, you can just edit the files, as
11062: there are only symbolic links in the working directory, pointing
11063: to the files in <code class="filename">files/</code>.</p></li>
1.128 wiz 11064: <li class="step" title="Step 5"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 11065: commit)</strong></span></p></li>
1.128 wiz 11066: <li class="step" title="Step 6"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 11067: regenerate the output files with the proper RCS
11068: Ids.</p></li>
1.128 wiz 11069: <li class="step" title="Step 7">
1.110 hubertf 11070: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 11071: commit the files in both <code class="filename">pkgsrc/doc</code> and
11072: <code class="filename">htdocs</code>.</p>
1.128 wiz 11073: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 11074: <h3 class="title">Note</h3>
11075: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 11076: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11077: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 11078: directory.</p>
11079: </div>
11080: </li>
1.79 rillig 11081: </ol></div>
1.75 rillig 11082: </div>
11083: </div>
11084: </div></body>
1.1 grant 11085: </html>
CVSweb <webmaster@jp.NetBSD.org>