Annotation of pkgsrc/doc/pkgsrc.html, revision 1.101
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.101 ! rillig 6: <link rel="stylesheet" href="/global.css" type="text/css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
21: <div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
27: <div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
33: <div><p class="copyright">Copyright © 1994-2006 The NetBSD Foundation, Inc</p></div>
1.92 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.24 2006/11/11 05:39:09 rillig Exp $</p></div>
1.76 rillig 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
48: <dl>
49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 70: </dl></dd>
71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
72: <dd><dl>
73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
75: </dl></dd>
76: </dl></dd>
77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
78: <dd><dl>
1.82 rillig 79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
82: <dd><dl>
83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 90: </dl></dd>
91: </dl></dd>
92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
93: <dd><dl>
94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 104: </dl></dd>
105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
106: <dd><dl>
107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
110: </dl></dd>
111: </dl></dd>
112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
113: <dd><dl>
114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 116: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 117: <dd><dl>
1.89 rillig 118: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
119: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
120: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 121: </dl></dd>
1.78 rillig 122: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
123: <dt><span class="sect1"><a href="#selecting-build-options">5.5. 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>
129: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
130: <dd><dl>
131: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
132: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
133: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
134: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
135: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
136: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
137: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
138: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
139: </dl></dd>
140: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
142: </dl></dd>
1.90 rillig 143: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
1.75 rillig 144: <dd><dl>
1.91 rillig 145: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90 rillig 146: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
147: </dl></dd>
148: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
149: <dd><dl>
150: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
151: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
152: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
153: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
154: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
155: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
156: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
157: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
158: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
159: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
160: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 161: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
164: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
165: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
166: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
167: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 169: </dl></dd>
170: </dl></dd>
171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
172: <dd><dl>
1.90 rillig 173: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 174: <dd><dl>
175: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
176: <dd><dl>
177: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
178: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
179: </dl></dd>
180: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
181: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
182: </dl></dd>
1.90 rillig 183: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 184: <dd><dl>
1.90 rillig 185: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
186: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
187: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
188: <dd><dl>
1.93 rillig 189: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
190: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
191: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
192: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
193: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 194: </dl></dd>
195: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
196: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
197: <dd><dl>
198: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
199: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
200: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
201: </dl></dd>
202: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
203: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
204: </dl></dd>
205: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
206: <dd><dl>
1.97 rillig 207: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
208: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
209: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
210: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
211: <dd><dl>
212: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
213: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
214: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
215: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
216: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90 rillig 217: </dl></dd>
218: </dl></dd>
219: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
220: <dd><dl>
221: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
222: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
223: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
224: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
225: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
226: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
227: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
228: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
229: </dl></dd>
230: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
231: <dd><dl>
232: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
233: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
234: <dd><dl>
235: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
236: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.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>
237: </dl></dd>
238: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
239: <dd><dl>
240: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
241: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
242: </dl></dd>
243: </dl></dd>
244: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
245: <dd><dl>
246: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
247: <dd><dl>
248: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
249: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
250: </dl></dd>
251: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
252: <dd><dl>
253: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
254: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
255: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
256: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
257: </dl></dd>
258: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
259: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
260: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
261: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
262: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
263: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
264: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
265: </dl></dd>
266: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
267: <dd><dl>
268: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
269: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
270: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
271: </dl></dd>
272: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
273: <dd><dl>
274: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
275: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
276: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
277: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
278: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
279: <dd><dl>
280: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
281: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
282: </dl></dd>
283: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
284: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
285: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
286: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
287: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
288: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
289: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
294: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
295: </dl></dd>
296: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
297: <dd><dl>
298: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
299: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
300: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 301: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90 rillig 302: </dl></dd>
303: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
304: <dd><dl>
305: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
306: <dd><dl>
307: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
308: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
309: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
310: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
311: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
312: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
313: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
314: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
315: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
316: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
317: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
318: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
319: </dl></dd>
320: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
321: <dd><dl>
322: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
323: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
324: </dl></dd>
325: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
326: <dd><dl>
327: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
328: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
329: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
330: </dl></dd>
331: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
332: <dd><dl>
333: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
334: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
335: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
336: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
337: </dl></dd>
338: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
339: <dd><dl>
340: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
341: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
342: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
343: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
344: </dl></dd>
345: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
346: <dd><dl>
347: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
348: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100 rillig 349: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.90 rillig 350: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
351: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
352: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
353: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
354: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
355: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
356: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
357: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
358: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
359: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
360: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
361: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
362: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
363: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 364: emulation</a></span></dt>
1.90 rillig 365: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
366: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77 rillig 367: </dl></dd>
1.90 rillig 368: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 369: </dl></dd>
1.90 rillig 370: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
371: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 372: <dd><dl>
1.90 rillig 373: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
374: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
375: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
376: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
377: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
378: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
379: </dl></dd>
380: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
381: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
382: <dd><dl>
383: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
384: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
385: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
386: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 387: </dl></dd>
1.75 rillig 388: </dl></dd>
389: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
390: <dd><dl>
1.90 rillig 391: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 392: <dd><dl>
1.90 rillig 393: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
394: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
395: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 396: <dd><dl>
1.90 rillig 397: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
398: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 399: </dl></dd>
1.90 rillig 400: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
401: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 402: <dd><dl>
1.90 rillig 403: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
404: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 405: </dl></dd>
1.90 rillig 406: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 407: <dd><dl>
1.90 rillig 408: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
409: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 410: </dl></dd>
411: </dl></dd>
1.90 rillig 412: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 413: <dd><dl>
1.90 rillig 414: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
415: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
416: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 417: <dd><dl>
1.90 rillig 418: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
419: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 420: </dl></dd>
421: </dl></dd>
1.90 rillig 422: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 423: <dd><dl>
1.90 rillig 424: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
425: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 426: </dl></dd>
427: </dl></dd>
428: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
429: <dd><dl>
430: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
431: <dd><dl>
432: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
433: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
434: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
435: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
436: </dl></dd>
437: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
438: </dl></dd>
439: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
440: <dd><dl>
441: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
442: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
443: </dl></dd>
1.76 rillig 444: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
445: <dd><dl>
446: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
447: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
448: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
449: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
450: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
451: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 rillig 452: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 453: source packages</a></span></dt>
454: </dl></dd>
1.75 rillig 455: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
456: <dd><dl>
1.79 rillig 457: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 458: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
459: </dl></dd>
460: </dl>
461: </div>
1.82 rillig 462: <div class="list-of-tables">
463: <p><b>List of Tables</b></p>
464: <dl>
465: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
466: </dt>
467: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
468: </dt>
1.90 rillig 469: <dt>10.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 470: </dt>
1.90 rillig 471: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 472: </dt>
1.82 rillig 473: </dl>
474: </div>
1.75 rillig 475: <div class="chapter" lang="en">
476: <div class="titlepage"><div><div><h2 class="title">
477: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
478: <div class="toc">
479: <p><b>Table of Contents</b></p>
480: <dl>
481: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 482: <dd><dl>
483: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
484: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
485: </dl></dd>
1.75 rillig 486: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
487: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 488: <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 489: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
490: </dl>
491: </div>
492: <div class="sect1" lang="en">
493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
494: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 495: <p>There is a lot of software freely available for Unix-based
496: systems, which is usually available in form of the source code. Before
497: such software can be used, it needs to be configured to the local
498: system, compiled and installed, and this is exactly what The NetBSD
499: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
500: to handle binary packages, so that not every user has to build the
501: packages for himself, which is a time-costly task.</p>
1.75 rillig 502: <p>pkgsrc currently contains several thousand packages,
503: including:</p>
504: <div class="itemizedlist"><ul type="disc">
1.91 rillig 505: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.75 rillig 506: web server</p></li>
1.91 rillig 507: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75 rillig 508: web browser</p></li>
1.91 rillig 509: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75 rillig 510: Desktop Environment</p></li>
1.91 rillig 511: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.75 rillig 512: Desktop Environment</p></li>
513: </ul></div>
514: <p>...just to name a few.</p>
515: <p>pkgsrc has built-in support for handling varying dependencies,
516: such as pthreads and X11, and extended features such as IPv6 support on
517: a range of platforms.</p>
1.82 rillig 518: <div class="sect2" lang="en">
519: <div class="titlepage"><div><div><h3 class="title">
520: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
521: <p>
522: pkgsrc provides the following key features:
523: </p>
524: <div class="itemizedlist"><ul type="disc">
525: <li><p>Easy building of software from source as well as the creation
526: and installation of binary packages. The source and latest
527: patches are retrieved from a master or mirror download site, checksum
528: verified, then built on your system. Support for binary-only
529: distributions is available for both native platforms and NetBSD
530: emulated platforms.</p></li>
531: <li><p>All packages are installed in a consistent directory tree,
532: including binaries, libraries, man pages and other
533: documentation.</p></li>
534: <li><p>Package dependencies, including when performing package updates,
535: are handled automatically. The configuration files of various
536: packages are handled automatically during updates, so local changes
537: are preserved.</p></li>
538: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
539: consists of highly portable code. This allows the greatest speed of
540: development when porting to new a platform. This portability also
541: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
542: platforms</em></span>.</p></li>
543: <li><p>The installation prefix, acceptable software licenses,
544: international encryption requirements and build-time options for a
545: large number of packages are all set in a simple, central
546: configuration file.</p></li>
547: <li><p>The entire source (not including the distribution files) is
548: freely available under a BSD license, so you may extend and adapt
549: pkgsrc to your needs. Support for local packages and patches is
550: available right out of the box, so you can configure it specifically
551: for your environment.</p></li>
552: </ul></div>
1.91 rillig 553: <p>The following principles are basic to pkgsrc:</p>
554: <div class="itemizedlist"><ul type="disc">
555: <li><p>“<span class="quote">It should only work if it's right.</span>”
556: — That means, if a package contains bugs, it's better to find
557: them and to complain about them rather than to just install the package
558: and hope that it works. There are numerous checks in pkgsrc that try to
559: 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
560: of shell scripts), and post-installation checks (installed files,
561: references to shared libraries, script interpreters).</p></li>
562: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
563: — Like NetBSD has been ported to many hardware architectures,
564: pkgsrc has been ported to many operating systems. Care is taken that
565: packages behave the same on all platforms.</p></li>
566: </ul></div>
1.82 rillig 567: </div>
568: <div class="sect2" lang="en">
569: <div class="titlepage"><div><div><h3 class="title">
570: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
571: <p>pkgsrc consists of both a source distribution and a binary
572: distribution for these operating systems. After retrieving the required
573: source or binaries, you can be up and running with pkgsrc in just
574: minutes!</p>
1.75 rillig 575: <p>pkgsrc was derived from FreeBSD's ports system, and
576: initially developed for NetBSD only. Since then, pkgsrc has
577: grown a lot, and now supports the following platforms:</p>
1.82 rillig 578: <div class="table">
579: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 580: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 581: <colgroup>
582: <col>
583: <col>
584: </colgroup>
585: <thead><tr>
586: <th>Platform</th>
587: <th>Date Support Added</th>
588: </tr></thead>
589: <tbody>
590: <tr>
591: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
592: <td align="center">Aug 1997</td>
593: </tr>
594: <tr>
595: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
596: <td align="center">Mar 1999</td>
597: </tr>
598: <tr>
599: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
600: <td align="center">Jun 1999</td>
601: </tr>
602: <tr>
603: <td>
604: <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
605: (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
606: </td>
607: <td align="center">Oct 2001</td>
608: </tr>
609: <tr>
610: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
611: <td align="center">Nov 2002</td>
612: </tr>
613: <tr>
614: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
615: <td align="center">Nov 2002</td>
616: </tr>
617: <tr>
618: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
619: <td align="center">Dec 2002</td>
620: </tr>
621: <tr>
622: <td>BSD/OS</td>
623: <td align="center">Dec 2003</td>
624: </tr>
625: <tr>
626: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
627: <td align="center">Dec 2003</td>
628: </tr>
629: <tr>
630: <td>
631: <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
632: (Microsoft Windows Services for Unix)
633: </td>
634: <td align="center">Mar 2004</td>
635: </tr>
636: <tr>
637: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
638: <td align="center">Oct 2004</td>
639: </tr>
640: <tr>
641: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
642: <td align="center">Nov 2004</td>
643: </tr>
1.98 wiz 644: <tr>
645: <td><a href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
646: <td align="center">Apr 2007</td>
647: </tr>
1.82 rillig 648: </tbody>
1.91 rillig 649: </table></div>
1.82 rillig 650: </div>
1.91 rillig 651: <br class="table-break">
1.82 rillig 652: </div>
1.75 rillig 653: </div>
654: <div class="sect1" lang="en">
655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
656: <a name="overview"></a>1.2. Overview</h2></div></div></div>
657: <p>This document is divided into three parts. The first,
658: <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
659: describes how one can use one of the packages in the Package
660: Collection, either by installing a precompiled binary package,
1.93 rillig 661: or by building one's own copy using the NetBSD package system.
1.75 rillig 662: The second part, <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
663: package so it can be easily built by other NetBSD users without
664: knowing about the package's building details. The third part,
665: <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
666: is intended for those who want to understand how pkgsrc is
667: implemented.</p>
668: <p>This document is available in various formats:
669: <span class="simplelist"><a href="index.html" target="_top">HTML</a>, <a href="pkgsrc.pdf" target="_top">PDF</a>, <a href="pkgsrc.ps" target="_top">PS</a>, <a href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
670: </div>
671: <div class="sect1" lang="en">
672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
673: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
674: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
675: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
676: terminology used within this document.</p>
677: <div class="variablelist"><dl>
678: <dt><span class="term">Package</span></dt>
679: <dd><p>A set of files and building instructions
680: that describe what's necessary
681: to build a certain piece of software using
682: pkgsrc. Packages are traditionally stored under
1.76 rillig 683: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 684: <dt><span class="term">The NetBSD package system</span></dt>
1.87 wiz 685: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
686: is part of the NetBSD operating system and can be bootstrapped
687: to run on non-NetBSD operating systems as well. It handles
688: building (compiling), installing, and removing of
689: packages.</p></dd>
1.75 rillig 690: <dt><span class="term">Distfile</span></dt>
691: <dd><p>This term describes the file or files that are
692: provided by the author of the piece of software to
693: distribute his work. All the changes necessary to build on
694: NetBSD are reflected in the corresponding package. Usually
695: the distfile is in the form of a compressed tar-archive,
696: but other types are possible, too. Distfiles are usually
697: stored below
1.76 rillig 698: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 699: <dt><span class="term">Port</span></dt>
700: <dd><p>This is the term used by FreeBSD and OpenBSD people
701: for what we call a package.
702: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
703: architecture.</p></dd>
704: <dt><span class="term">Precompiled/binary package</span></dt>
705: <dd>
706: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 707: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 708: file so it can be installed on machines of the same
709: machine architecture without the need to
710: recompile. Packages are usually generated in
1.76 rillig 711: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.75 rillig 712: an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
713: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
714: especially in the context of precompiled packages.</p>
715: </dd>
716: <dt><span class="term">Program</span></dt>
1.88 wiz 717: <dd><p>The piece of software to be installed which will be
718: constructed from all the files in the distfile by the
719: actions defined in the corresponding package.</p></dd>
1.75 rillig 720: </dl></div>
721: <div class="sect2" lang="en">
722: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 723: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75 rillig 724: <div class="variablelist"><dl>
725: <dt><span class="term">pkgsrc users</span></dt>
726: <dd>
727: <p>The
728: pkgsrc users are people who use the packages provided by pkgsrc.
729: Typically they are system administrators. The people using the
730: software that is inside the packages (maybe called “<span class="quote">end
731: users</span>”) are not covered by the pkgsrc guide.</p>
732: <p>There are two kinds of pkgsrc users: Some only want to
733: install pre-built binary packages. Others build the pkgsrc
734: packages from source, either for installing them directly or for
735: building binary packages themselves. For pkgsrc users <a href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
736: documentation.</p>
737: </dd>
738: <dt><span class="term">package maintainers</span></dt>
739: <dd><p>A
740: package maintainer creates packages as described in <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
741: <dt><span class="term">infrastructure developers</span></dt>
742: <dd><p>These people are involved in all those files
1.76 rillig 743: that live in the <code class="filename">mk/</code> directory and below.
1.75 rillig 744: Only these people should need to read through <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
745: too.</p></dd>
746: </dl></div>
747: </div>
748: </div>
749: <div class="sect1" lang="en">
750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
751: <a name="typography"></a>1.4. Typography</h2></div></div></div>
752: <p>When giving examples for commands, shell prompts are used to
753: show if the command should/can be issued as root, or if
754: “<span class="quote">normal</span>” user privileges are sufficient. We use a
755: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
756: shell prompt, assuming they use the C-shell or tcsh.</p>
757: </div>
758: </div>
759: <div class="part" lang="en">
760: <div class="titlepage"><div><div><h1 class="title">
761: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
762: <div class="toc">
763: <p><b>Table of Contents</b></p>
764: <dl>
765: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
766: <dd><dl>
767: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
768: <dd><dl>
769: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
770: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 771: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 772: </dl></dd>
773: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
774: <dd><dl>
775: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
776: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
777: </dl></dd>
778: </dl></dd>
779: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
780: <dd><dl>
1.82 rillig 781: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
782: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
783: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
784: <dd><dl>
785: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
786: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
787: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
788: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
789: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
790: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
791: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 792: </dl></dd>
793: </dl></dd>
794: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
795: <dd><dl>
796: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
797: <dd><dl>
798: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
799: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 800: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
801: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
802: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
803: <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>
804: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
805: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 806: </dl></dd>
807: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
808: <dd><dl>
809: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
810: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
811: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
812: </dl></dd>
813: </dl></dd>
814: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
815: <dd><dl>
816: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
817: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 818: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 819: <dd><dl>
1.89 rillig 820: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
821: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
822: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 823: </dl></dd>
1.78 rillig 824: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
825: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 826: </dl></dd>
827: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
828: <dd><dl>
829: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
830: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
831: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
832: <dd><dl>
833: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
834: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
835: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
836: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
837: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
838: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
839: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
840: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
841: </dl></dd>
842: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
843: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
844: </dl></dd>
1.90 rillig 845: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
846: <dd><dl>
1.91 rillig 847: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90 rillig 848: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
849: </dl></dd>
850: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
1.75 rillig 851: <dd><dl>
1.90 rillig 852: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
853: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
854: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
855: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
856: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
857: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
858: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
859: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
860: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
861: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
862: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 863: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 864: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
865: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
866: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
867: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
868: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
869: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
870: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 871: </dl></dd>
872: </dl>
873: </div>
874: <div class="chapter" lang="en">
875: <div class="titlepage"><div><div><h2 class="title">
876: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
877: <div class="toc">
878: <p><b>Table of Contents</b></p>
879: <dl>
880: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
881: <dd><dl>
882: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
883: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 884: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 885: </dl></dd>
886: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
887: <dd><dl>
888: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
889: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
890: </dl></dd>
891: </dl>
892: </div>
1.91 rillig 893: <p>Before you download and extract the files, you need to decide
894: where you want to extract them. When using pkgsrc as root user, pkgsrc
895: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
896: free to install the sources and binary packages wherever you want in
897: your filesystem, provided that the pathname does not contain white-space
898: or other characters that are interpreted specially by the shell and some
899: other programs. A safe bet is to use only letters, digits, underscores
900: and dashes.</p>
1.75 rillig 901: <div class="sect1" lang="en">
902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
903: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
904: <p>Before you download any pkgsrc files, you should decide
905: whether you want the <span class="emphasis"><em>current</em></span> branch or the
906: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
907: quarterly basis from the current branch and only gets modified
908: for security updates. The names of the stable branches are built
909: from the year and the quarter, for example
1.98 wiz 910: <code class="literal">2007Q1</code>.</p>
1.75 rillig 911: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
912: want to download pkgsrc. You can get it as a tar file, via SUP,
913: or via CVS. All three ways are described here.</p>
914: <div class="sect2" lang="en">
915: <div class="titlepage"><div><div><h3 class="title">
916: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
917: <p>The primary download location for all pkgsrc files is
918: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
919: number of subdirectories for different purposes, which are
1.76 rillig 920: described in detail in <a 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 921: <p>The tar file for the current branch is in the directory
1.76 rillig 922: <code class="filename">current</code> and is called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75 rillig 923: It is autogenerated daily.</p>
1.98 wiz 924: <p>The tar file for the stable branch 2007Q1 is in the
925: directory <code class="filename">pkgsrc-2007Q1</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q1/pkgsrc-2007Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q1.tar.gz</code></a>.</p>
1.75 rillig 926: <p>After downloading the tar file, change to the directory
927: where you want to have pkgsrc. This is usually
1.91 rillig 928: <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
929: pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
1.75 rillig 930: </div>
931: <div class="sect2" lang="en">
932: <div class="titlepage"><div><div><h3 class="title">
933: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
934: <p>As an alternative to the tar file, you can get pkgsrc via
935: the Software Update Protocol, SUP. To do so, make sure your
936: supfile has a line
1.1 grant 937:
1.75 rillig 938: </p>
939: <pre class="programlisting">
1.100 rillig 940: release=pkgsrc
1.1 grant 941: </pre>
1.75 rillig 942: <p>
1.1 grant 943:
1.75 rillig 944: in it, see the examples in
1.76 rillig 945: <code class="filename">/usr/share/examples/supfiles</code>, and that the
946: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.75 rillig 947: run <span><strong class="command">sup -v
948: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
949: </div>
950: <div class="sect2" lang="en">
951: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 952: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.75 rillig 953: <p>To get pkgsrc via CVS, make sure you have <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cvs</span>(1)</span></a>
954: installed. To do an initial (full) checkout of pkgsrc, you first
955: have to set some environment variables. For the C-Shell,
956: type:</p>
957: <pre class="screen">
958: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
959: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
960: </pre>
961: <p>Or, the same for the bourne shell:</p>
962: <pre class="screen">
963: <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
964: <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
965: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
966: </pre>
1.101 ! rillig 967: <p>By default, cvs doesn't do things like most people would
! 968: expect it to do, and this is unlikely to change. But there is a
! 969: way to convince cvs, by creating a file called
! 970: <code class="filename">.cvsrc</code> in your home directory and saving
! 971: the following lines to it. This file will save you lots of
! 972: headache and some bug reports, so we strongly recommend it. You
! 973: can find an explanation of this file in the CVS
! 974: documentation.</p>
! 975: <pre class="programlisting">
! 976: # recommended CVS configuration file from the pkgsrc guide
! 977: checkout -P
! 978: update -d
! 979: release -d
! 980: diff -up
! 981: cvs -q -z3
! 982: rdiff -u
! 983: </pre>
1.75 rillig 984: <p>Then, you change to the directory where you want to have
985: your copy of pkgsrc. In most cases this is
1.76 rillig 986: <code class="filename">/usr</code>. In that directory you run the
1.75 rillig 987: checkout command, which is <span><strong class="command">cvs -q checkout -P
988: pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1.98 wiz 989: checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
1.75 rillig 990: branch. This command will create a directory called
1.76 rillig 991: <code class="filename">pkgsrc</code> with all the pkgsrc files in
1.75 rillig 992: it.</p>
993: </div>
994: </div>
995: <div class="sect1" lang="en">
996: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
997: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
998: <p>The preferred way to keep pkgsrc up-to-date is via CVS
999: (which also works if you have first installed it via a tar
1000: file). It saves bandwidth and hard disk activity, compared to
1001: downloading the tar file again.</p>
1002: <div class="sect2" lang="en">
1003: <div class="titlepage"><div><div><h3 class="title">
1004: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1005: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1006: <h3 class="title">Warning</h3>
1.77 rillig 1007: <p>When updating from a tar file, you first need to
1008: completely remove the old pkgsrc directory. Otherwise those
1009: files that have been removed from pkgsrc in the mean time will
1010: not be removed on your local disk, resulting in inconsistencies.
1011: When removing the old files, any changes that you have done to
1012: the pkgsrc files will be lost after updating. Therefore updating
1013: via CVS is strongly recommended.</p>
1.75 rillig 1014: </div>
1.82 rillig 1015: <p>Note that by default the distfiles and the binary packages
1016: are saved in the pkgsrc tree, so don't forget to rescue them
1017: before updating. You can also configure pkgsrc to use other than
1018: the default directories by setting the
1019: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1020: variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1021: <p>To update pkgsrc from a tar file, download the tar file as
1022: explained above. Then, make sure that you have not made any
1023: changes to the files in the pkgsrc directory. Remove the pkgsrc
1024: directory and extract the new tar file. Done.</p>
1025: </div>
1026: <div class="sect2" lang="en">
1027: <div class="titlepage"><div><div><h3 class="title">
1028: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1029: <p>To update pkgsrc via CVS, make sure the environment
1030: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1031: change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1.77 rillig 1032: -dP</strong></span>.</p>
1.75 rillig 1033: <div class="sect3" lang="en">
1034: <div class="titlepage"><div><div><h4 class="title">
1035: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1036: <p>When updating pkgsrc, the CVS program keeps track of the
1037: branch you selected. But if you, for whatever reason, want to
1038: switch from the stable branch to the current one, you can do it
1039: by adding the option “<span class="quote">-A</span>” after the
1040: “<span class="quote">update</span>” keyword. To switch from the current branch
1041: back to the stable branch, add the
1.98 wiz 1042: “<span class="quote">-rpkgsrc-2007Q1</span>” option.</p>
1.75 rillig 1043: </div>
1044: <div class="sect3" lang="en">
1045: <div class="titlepage"><div><div><h4 class="title">
1046: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1047: <p>When you update pkgsrc, the CVS program will only touch
1048: those files that are registered in the CVS repository. That
1049: means that any packages that you created on your own will stay
1050: unmodified. If you change files that are managed by CVS, later
1051: updates will try to merge your changes with those that have been
1052: done by others. See the CVS manual, chapter
1053: “<span class="quote">update</span>” for details.</p>
1054: </div>
1055: </div>
1056: </div>
1057: </div>
1058: <div class="chapter" lang="en">
1059: <div class="titlepage"><div><div><h2 class="title">
1060: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1061: <div class="toc">
1062: <p><b>Table of Contents</b></p>
1063: <dl>
1.82 rillig 1064: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1065: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1066: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1067: <dd><dl>
1068: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1069: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1070: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1071: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1072: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1073: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1074: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1075: </dl></dd>
1076: </dl>
1077: </div>
1078: <div class="sect1" lang="en">
1079: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1080: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1081: <p>
1082: We provide a bootstrap kit in both source and binary form for other
1083: platforms than NetBSD, consisting of the pkg administration tools and other
1084: tools required to use pkgsrc and build packages.
1085: </p>
1086: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1087: <h3 class="title">Note</h3>
1088: <p>
1089: Older binary snapshots are available in the
1090: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
1091: directory on ftp.NetBSD.org.</p>
1092: </div>
1093: <div class="table">
1094: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1.91 rillig 1095: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1.82 rillig 1096: <colgroup>
1097: <col>
1098: <col>
1099: <col>
1100: <col>
1101: </colgroup>
1102: <thead><tr>
1103: <th>Platform</th>
1104: <th>Latest snapshot</th>
1105: <th>Binary kit</th>
1106: <th>Binary packages</th>
1107: </tr></thead>
1108: <tbody>
1109: <tr>
1110: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
1111: <td class="date">20021209</td>
1112: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-5.5-powerpc-20021209.tar.gz" target="_top">binary kit</a></td>
1113: <td class="binary-pkgs-url"> </td>
1114: </tr>
1115: <tr>
1116: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
1117: <td class="date">20030623</td>
1118: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-6.6-powerpc-20030623.tar.gz" target="_top">binary kit</a></td>
1119: <td class="binary-pkgs-url"> </td>
1120: </tr>
1121: <tr>
1122: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
1123: <td class="date">20041219</td>
1124: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.6.0-powerpc-20041219.tar.gz" target="_top">binary kit</a></td>
1125: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
1126: </tr>
1127: <tr>
1128: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
1129: <td class="date">20050320</td>
1130: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.8.0-powerpc-20050320.tar.gz" target="_top">binary kit</a></td>
1131: <td class="binary-pkgs-url"> </td>
1132: </tr>
1133: <tr>
1134: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
1135: <td class="date">20050625</td>
1136: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-8.1.0-powerpc-20050625.tar.gz" target="_top">binary kit</a></td>
1137: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-8.1/powerpc/current/" target="_top">binary packages</a></td>
1138: </tr>
1139: <tr>
1140: <td class="osname">Debian GNU Linux/i386</td>
1141: <td class="date">20031023</td>
1142: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-debian-i386-20031023.tar.gz" target="_top">binary kit</a></td>
1143: <td class="binary-pkgs-url"> </td>
1144: </tr>
1145: <tr>
1146: <td class="osname">Fedora Core 2 Linux/i386</td>
1147: <td class="date">20050618</td>
1148: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.10-i386-fc2-20050618.tar.gz" target="_top">binary kit</a></td>
1149: <td class="binary-pkgs-url"> </td>
1150: </tr>
1151: <tr>
1152: <td class="osname">Fedora Core 4 Linux/i386</td>
1153: <td class="date">20060105</td>
1154: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.11-i386-fc4-20060105.tar.gz" target="_top">binary kit</a></td>
1155: <td class="binary-pkgs-url"> </td>
1156: </tr>
1157: <tr>
1158: <td class="osname">FreeBSD 3.5/i386</td>
1159: <td class="date">20030411</td>
1160: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-3.5-STABLE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1161: <td class="binary-pkgs-url"> </td>
1162: </tr>
1163: <tr>
1164: <td class="osname">FreeBSD 4.7/i386</td>
1165: <td class="date">20021211</td>
1166: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-4.7-RELEASE-i386-20021211.tar.gz" target="_top">binary kit</a></td>
1167: <td class="binary-pkgs-url"> </td>
1168: </tr>
1169: <tr>
1170: <td class="osname">FreeBSD 5.0/i386</td>
1171: <td class="date">20030411</td>
1172: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.0-RELEASE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1173: <td class="binary-pkgs-url"> </td>
1174: </tr>
1175: <tr>
1176: <td class="osname">FreeBSD 5.1/i386</td>
1177: <td class="date">20030630</td>
1178: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.1-RELEASE-i386-20030630.tar.gz" target="_top">binary kit</a></td>
1179: <td class="binary-pkgs-url"> </td>
1180: </tr>
1181: <tr>
1182: <td class="osname">FreeBSD 5.2.1/i386</td>
1183: <td class="date">20040227</td>
1184: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.2.1-RELEASE-i386-20040227.tar.gz" target="_top">binary kit</a></td>
1185: <td class="binary-pkgs-url"> </td>
1186: </tr>
1187: <tr>
1188: <td class="osname">FreeBSD 5.3/i386</td>
1189: <td class="date">20050119</td>
1190: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.3-RELEASE-i386-20050119.tar" target="_top">binary kit</a></td>
1191: <td class="binary-pkgs-url"> </td>
1192: </tr>
1193: <tr>
1.98 wiz 1194: <td class="osname">HP-UX 11.11/hppa</td>
1195: <td class="date">20070421</td>
1196: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-HPUX-B.11.11-hppa-20070421.tar.gz" target="_top">binary kit</a></td>
1197: <td class="binary-pkgs-url"> </td>
1198: </tr>
1199: <tr>
1.82 rillig 1200: <td class="osname">Interix 3.5</td>
1.93 rillig 1201: <td class="date">20061106</td>
1202: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Interix-3.5-i386-20061106.tar.gz" target="_top">binary kit</a></td>
1203: <td class="binary-pkgs-url"> </td>
1.82 rillig 1204: </tr>
1205: <tr>
1206: <td class="osname">IRIX 6.5 n32-bit ABI</td>
1207: <td class="date">20040911</td>
1208: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX-6.5-mips-20040911.tar.gz" target="_top">binary kit</a></td>
1209: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
1210: </tr>
1211: <tr>
1212: <td class="osname">IRIX 6.5 64-bit ABI</td>
1213: <td class="date">20040912</td>
1214: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX64-6.5-mips-20040912.tar.gz" target="_top">binary kit</a></td>
1215: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
1216: </tr>
1217: <tr>
1218: <td class="osname">OpenBSD 3.2/i386</td>
1219: <td class="date">20030420</td>
1220: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.2-i386-20030420.tar.gz" target="_top">binary kit</a></td>
1221: <td class="binary-pkgs-url"> </td>
1222: </tr>
1223: <tr>
1224: <td class="osname">OpenBSD 3.3/i386</td>
1225: <td class="date">20030503</td>
1226: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.3-i386-20030503.tar.gz" target="_top">binary kit</a></td>
1227: <td class="binary-pkgs-url"> </td>
1228: </tr>
1229: <tr>
1230: <td class="osname">OpenBSD 3.5/i386</td>
1.93 rillig 1231: <td class="date">20040703</td>
1.82 rillig 1232: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.5-i386-20040703.tar.gz" target="_top">binary kit</a></td>
1233: <td class="binary-pkgs-url"> </td>
1234: </tr>
1235: <tr>
1.98 wiz 1236: <td class="osname">OSF1 5.1/alpha</td>
1237: <td class="date">20070420</td>
1238: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OSF1-V5.1-alpha-20070420.tar.gz" target="_top">binary kit</a></td>
1239: <td class="binary-pkgs-url"> </td>
1240: </tr>
1241: <tr>
1.82 rillig 1242: <td class="osname">Slackware Linux 8.1/i386</td>
1243: <td class="date">20030417</td>
1244: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.18-slackware-20030417.tar.gz" target="_top">binary kit</a></td>
1245: <td class="binary-pkgs-url"> </td>
1246: </tr>
1247: <tr>
1248: <td class="osname">Slackware Linux 9/i386</td>
1.93 rillig 1249: <td class="date">20040703</td>
1.82 rillig 1250: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-i386-slackware9-20040703.tar.gz" target="_top">binary kit</a></td>
1251: <td class="binary-pkgs-url"> </td>
1252: </tr>
1253: <tr>
1254: <td class="osname">Solaris 8/sparc</td>
1255: <td class="date">20050220</td>
1256: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-sparc-20050220.tar.gz" target="_top">binary kit</a></td>
1257: <td class="binary-pkgs-url"> </td>
1258: </tr>
1259: <tr>
1260: <td class="osname">Solaris 8/i386</td>
1261: <td class="date">20050220</td>
1262: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-i386-20050220.tar.gz" target="_top">binary kit</a></td>
1263: <td class="binary-pkgs-url"> </td>
1264: </tr>
1265: <tr>
1266: <td class="osname">Solaris 9/sparc</td>
1.93 rillig 1267: <td class="date">20060713</td>
1268: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-sparc-pkgsrc-2006Q2.tar.gz" target="_top">binary kit</a></td>
1269: <td class="binary-pkgs-url"> </td>
1.82 rillig 1270: </tr>
1271: <tr>
1272: <td class="osname">Solaris 9/i386</td>
1273: <td class="date">20030411</td>
1274: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1275: <td class="binary-pkgs-url"> </td>
1276: </tr>
1277: </tbody>
1.91 rillig 1278: </table></div>
1.82 rillig 1279: </div>
1.91 rillig 1280: <br class="table-break"><p>
1.82 rillig 1281: Simply download the binary kit for your platform, and extract it into
1282: <code class="filename">/</code> e.g.
1283: </p>
1284: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
1285: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
1286: | tar -xpf -</code></strong></pre>
1287: <p>
1288: Of course, as with any binary distributions, you should verify the
1289: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
1290: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
1291: file and inspect the contents before extracting it.
1292: </p>
1293: </div>
1294: <div class="sect1" lang="en">
1295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1296: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1297: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1298: <pre class="screen">
1299: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1300: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1301: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1302: </pre>
1.75 rillig 1303: <p>See <a 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 1304: pkgsrc before bootstrapping. The given
1305: <span><strong class="command">bootstrap</strong></span> command will use the defaults of
1306: <code class="filename">/usr/pkg</code> for the
1307: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1308: and <code class="filename">/var/db/pkg</code> for the package database
1309: directory where pkgsrc will do its internal bookkeeping.
1310: However, these can also be set using command-line
1311: arguments.</p>
1.75 rillig 1312: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1.87 wiz 1313: available for supported platforms. An up-to-date list of these can be
1314: found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
1315: Note that this only works for privileged builds that install
1316: into <code class="filename">/usr/pkg</code>.</p>
1.75 rillig 1317: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1318: <h3 class="title">Note</h3>
1319: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1.87 wiz 1320: Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
1321: For examples in this guide, use <span><strong class="command">bmake</strong></span>
1322: instead of “<span class="quote">make</span>”.</p>
1.75 rillig 1323: </div>
1324: </div>
1325: <div class="sect1" lang="en">
1326: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1327: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1328: <p>Here are some platform-specific notes you should be aware of.</p>
1329: <div class="sect2" lang="en">
1330: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1331: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85 jmmv 1332: <p>Darwin 5.x and up are supported. There are two methods of using
1.82 rillig 1333: pkgsrc on Mac OS X, by using a <a href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1.89 rillig 1334: image</a>, or a <a href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75 rillig 1335: partition</a>.</p>
1336: <p>Before you start, you will need to download and install the Mac OS X Developer
1.87 wiz 1337: Tools from Apple's Developer Connection. See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1338: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1339: from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1340: if you intend to build packages that use the X11 Window System.</p>
1.89 rillig 1341: <p>If you already have a UFS or HFSX partition, or have a spare partition
1342: that you can format as UFS or HFSX, it is recommended to use that instead of
1.87 wiz 1343: the disk image. It'll be somewhat faster and will mount automatically
1344: at boot time, where you must manually mount a disk image.</p>
1.75 rillig 1345: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1346: <h3 class="title">Note</h3>
1.85 jmmv 1347: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89 rillig 1348: requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
1.75 rillig 1349: </div>
1350: <div class="sect3" lang="en">
1351: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1352: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75 rillig 1353: <p>Create the disk image:</p>
1354: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95 tron 1355: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85 jmmv 1356: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75 rillig 1357: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85 jmmv 1358: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1359: <h3 class="title">Note</h3>
1.89 rillig 1360: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid. In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page. In the case of HFSX, it will disable journalling.</p>
1.85 jmmv 1361: </div>
1.89 rillig 1362: <p>Allow suid:</p>
1363: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.75 rillig 1364: </div>
1365: <div class="sect3" lang="en">
1366: <div class="titlepage"><div><div><h4 class="title">
1.89 rillig 1367: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76 rillig 1368: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87 wiz 1369: system, normally HFS+. It is possible to use the default
1370: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1371: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89 rillig 1372: or HFSX file system. Obviously, another symlink is required if you want to
1.87 wiz 1373: place the package database directory outside the
1374: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75 rillig 1375: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1376: <p>If you created your partitions at the time of installing Mac OS X
1.89 rillig 1377: and formatted the target partition as UFS or HFSX, it should automatically
1.87 wiz 1378: mount on <code class="filename">/Volumes/<volume name></code> when the
1.89 rillig 1379: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87 wiz 1380: to ensure that the partition map correctly reflects
1.89 rillig 1381: “<span class="quote">Apple_UFS</span>” or “<span class="quote">Apple_HFSX</span>” and not “<span class="quote">Apple_HFS</span>”.</p>
1.75 rillig 1382: <p>The problem is that none of the disk tools will let you touch a
1.87 wiz 1383: disk that is booted from. You can unmount the partition, but even if
1384: you newfs it, the partition type will be incorrect and the
1385: automounter won't mount it. It can be mounted manually, but it won't
1386: appear in Finder.</p>
1.75 rillig 1387: <p>You'll need to boot off of the OS X Installation (User) CD. When
1.87 wiz 1388: the Installation program starts, go up to the menu and select Disk
1389: Utility. Now, you will be able to select the partition you want
1.89 rillig 1390: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1391: installer which will reboot your machine. The new UFS or HFSX file system
1.87 wiz 1392: will appear in Finder.</p>
1.75 rillig 1393: <p>Be aware that the permissions on the new file system will be writable
1.87 wiz 1394: by root only.</p>
1.75 rillig 1395: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87 wiz 1396: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75 rillig 1397: </div>
1398: </div>
1399: <div class="sect2" lang="en">
1400: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1401: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1402: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1403: other versions may work.</p>
1.75 rillig 1404: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1405: with the FreeBSD userland tools. There are several steps:</p>
1.75 rillig 1406: <div class="orderedlist"><ol type="1">
1407: <li><p>FreeBSD stores its ports pkg database in
1.87 wiz 1408: <code class="filename">/var/db/pkg</code>. It is therefore
1409: recommended that you choose a different location (e.g.
1410: <code class="filename">/usr/pkgdb</code>) by
1411: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1412: <li>
1413: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1414: good idea to move them out of the way to avoid confusion, e.g.</p>
1415: <pre class="screen">
1416: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1417: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1418: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1419: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1420: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1421: </pre>
1.75 rillig 1422: </li>
1.76 rillig 1423: <li><p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87 wiz 1424: <code class="filename">/etc/mk.conf.example</code> file
1425: when you use the bootstrap script.</p></li>
1.75 rillig 1426: </ol></div>
1427: </div>
1428: <div class="sect2" lang="en">
1429: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1430: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1431: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1432: providing a Unix-like environment with a tighter kernel integration than
1433: available with Cygwin. It is part of the Windows Services for Unix
1434: package, available for free for any licensed copy of Windows 2000, XP
1435: (not including XP Home), or 2003. SFU can be downloaded from <a href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93 rillig 1436: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1437: are not officially supported. (The main difference in 3.0/3.1 is lack
1438: of pthreads, but other parts of libc may also be lacking.)</p>
1439: <p>Services for Unix Applications (aka SUA) is an integrated component
1440: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1.95 tron 1441: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75 rillig 1442: <div class="sect3" lang="en">
1443: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1444: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1445: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1446: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75 rillig 1447: <div class="itemizedlist"><ul type="disc">
1448: <li><p>Utilities -> Base Utilities</p></li>
1449: <li><p>Interix GNU Components -> (all)</p></li>
1450: <li><p>Remote Connectivity</p></li>
1451: <li><p>Interix SDK</p></li>
1452: </ul></div>
1453: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1454: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1455: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1456: pkgsrc (or from a binary package).</p>
1.75 rillig 1457: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1458: not need to be installed, but Remote Connectivity itself should be
1459: installed in order to have a working inetd.</p>
1.75 rillig 1460: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1461: behavior for Interix programs, and whether to make pathnames default to
1462: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1463: enabled. (Without case-sensitivity, a large number of packages including
1464: perl will not build.)</p>
1.75 rillig 1465: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1466: works (via the Data Execution Prevention feature). In order to use
1467: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1468: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1469: must be installed. Hotfixes are available from Microsoft through a
1470: support contract; however, a NetBSD developer has made most Interix
1471: hotfixes available for personal use from <a href="http://www.duh.org/interix/hotfixes.php" target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
1.93 rillig 1472: <p>In addition to the hotfix noted above, it may be necessary to
1473: disable Data Execution Prevention entirely to make Interix functional.
1474: This may happen only with certain types of CPUs; the cause is not fully
1475: understood at this time. If gcc or other applications still segfault
1476: repeatedly after installing one of the hotfixes note above, the
1477: following option can be added to the appropriate "boot.ini" line on the
1478: Windows boot drive: /NoExecute=AlwaysOff
1479: (WARNING, this will disable DEP completely, which may be a security
1480: risk if applications are often run as a user in the Administrators
1481: group!)</p>
1.75 rillig 1482: </div>
1483: <div class="sect3" lang="en">
1484: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1485: <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 1486: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1487: with pkgsrc, note the following things.</p>
1.75 rillig 1488: <div class="itemizedlist"><ul type="disc">
1489: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1490: Windows Services for UNIX, then click Change. In the installer, choose
1491: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.75 rillig 1492: <li>
1493: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1494: change the following registry key:</p>
1.75 rillig 1495: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1496: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1497: </li>
1498: <li>
1499: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1500: following registry key:</p>
1.75 rillig 1501: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1502: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1503: </li>
1504: </ul></div>
1505: </div>
1506: <div class="sect3" lang="en">
1507: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1508: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1509: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1510: running "pkg_add") must be a member of the local Administrators
1511: group. Such a user must also be used to run the bootstrap. This is
1512: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1513: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1514: automatically complain if this is not the case. This ensures that
1515: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1516: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1517: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1518: NOT be used in conjunction with pkgsrc. If you choose to use them at
1519: the same time as the pkgsrc packages, ensure that you use the proper
1520: pkg_* tools for each type of binary package.</p>
1.75 rillig 1521: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1522: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1523: don't have a termcap/terminfo entry for it, but the following .termcap
1524: entry provides adequate emulation in most cases:</p>
1.75 rillig 1525: <pre class="programlisting">
1.100 rillig 1526: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1527: </pre>
1.75 rillig 1528: </div>
1529: <div class="sect3" lang="en">
1530: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1531: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1532: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1533: for a full Unix-like platform, it has some drawbacks that should
1534: be noted for those desiring to make the most of Interix.</p>
1.75 rillig 1535: <div class="itemizedlist"><ul type="disc">
1536: <li>
1537: <p><span class="strong"><strong>X11:</strong></span></p>
1538: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1539: and can run X11 based applications, but it does
1540: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1541: <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1542: <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1543: (available in a trimmed version for Interix from Interop Systems as the
1544: <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1545: and the free X11 server included with
1546: <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1547: </li>
1548: <li>
1549: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1550: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1551: Win32 applications, it does not currently support various X11
1552: protocol extensions for acceleration (such as MIT-SHM or DGA).
1553: Most interactive applications to a local X server will run
1554: reasonably fast, but full motion video and other graphics
1555: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1556: </li>
1557: <li>
1558: <p><span class="strong"><strong>Audio:</strong></span></p>
1559: <p>Interix has no native support for audio output. For audio
1.87 wiz 1560: support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
1561: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1562: <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.87 wiz 1563: <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
1564: server component. To output audio via an Interix host, the
1.91 rillig 1565: <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 1566: must also be installed.</p>
1.75 rillig 1567: </li>
1568: <li>
1569: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1570: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1571: is not currently possible to access CD/DVD drives, USB devices,
1572: or SCSI devices through non-filesystem means. Among other things,
1573: this makes it impossible to use Interix directly for CD/DVD
1574: burning.</p>
1.75 rillig 1575: </li>
1576: <li>
1577: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1578: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1579: drives are also not directly accessible in Interix. However,
1580: support is in work to make tape drive access possible by using
1581: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1582: esound server).</p>
1.75 rillig 1583: </li>
1584: </ul></div>
1585: </div>
1586: <div class="sect3" lang="en">
1587: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1588: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1589: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1590: Windows system; any member of the local Administrators group will
1591: suffice. However, some packages currently assume that the user
1592: named "root" is the privileged user. To accommodate these, you
1593: may create such a user; make sure it is in the local group
1594: Administrators (or your language equivalent).</p>
1595: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
1596: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1597: time being, install packages as the local Administrator (or
1598: your language equivalent), or run the following command after
1599: installing a package to work around the issue:</p>
1.75 rillig 1600: <pre class="screen">
1.87 wiz 1601: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1602: </pre>
1.75 rillig 1603: </div>
1604: </div>
1605: <div class="sect2" lang="en">
1606: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1607: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1608: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1609: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1610: according to your preference. If you do not have a license for the MIPSpro
1611: compiler suite, you can download a gcc tardist file from <a href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75 rillig 1612: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87 wiz 1613: version of IRIX providing support for <a 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 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>,
1614: etc.</p>
1.86 schwarz 1615: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1616: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1617: you start out using "abi=n32", that's what all your packages will be built
1618: with.</p>
1619: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1620: <code class="varname">CFLAGS</code> in your environment or the
1621: <code class="filename">/etc/mk.conf</code>. Particularly, make sure that you do not
1622: try to link n32 object files with lib64 or vice versa. Check your
1623: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1624: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1625: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1626: as it appears that IRIX linker occasionally runs into issues when trying to
1627: link over a network-mounted file system.</p>
1.75 rillig 1628: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1629: as imake(1), but you may want to set some options depending on your local
1630: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1631: course, your compiler's man pages for details.</p>
1.75 rillig 1632: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1633:
1.87 wiz 1634: </p>
1.75 rillig 1635: <pre class="programlisting">
1.100 rillig 1636: PKGSRC_COMPILER= mipspro
1.87 wiz 1637: </pre>
1.75 rillig 1638: <p>
1.1 grant 1639:
1.87 wiz 1640: in <code class="filename">/etc/mk.conf</code>. Otherwise, pkgsrc will assume you
1641: are using gcc and may end up passing invalid flags to the compiler. Note that
1642: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1643: default.</p>
1.75 rillig 1644: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1645: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1646: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1647: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1648: '--preserve-path' flag.</p>
1.75 rillig 1649: </div>
1650: <div class="sect2" lang="en">
1651: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1652: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1653: <p>Some versions of Linux (for example Debian GNU/Linux) need
1654: either libtermcap or libcurses (libncurses). Installing the
1655: distributions libncurses-dev package (or equivalent) should fix
1656: the problem.</p>
1657: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1658: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1659: i386 have been tested.</p>
1.75 rillig 1660: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1661: directory:</p>
1.75 rillig 1662: <pre class="programlisting">
1.100 rillig 1663: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1664: ac_cv___attribute__=yes ./bootstrap
1.87 wiz 1665: </pre>
1.75 rillig 1666: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1667: <h3 class="title">Note</h3>
1668: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1669: </div>
1670: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1671: function, which icc does not support. #undef'ing __attribute__ has the
1672: unfortunate side-effect of breaking many of the Linux header files, which
1673: cannot be compiled properly without __attribute__. The test must be
1674: overridden so that __attribute__ is assumed supported by the
1675: compiler.</p>
1.75 rillig 1676: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.87 wiz 1677: in <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 1678: <pre class="programlisting">
1.100 rillig 1679: PKGSRC_COMPILER= icc
1.87 wiz 1680: </pre>
1.75 rillig 1681: <p>The default installation directory for icc is
1.87 wiz 1682: <code class="filename">/opt/intel_cc_80</code>, which
1683: is also the pkgsrc default. If you have installed it into a different
1684: directory, set <code class="varname">ICCBASE</code> in
1685: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 1686: <pre class="programlisting">
1.100 rillig 1687: ICCBASE= /opt/icc
1.87 wiz 1688: </pre>
1.75 rillig 1689: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1690: provided by icc, so binaries can be run on other systems which do not
1691: have the shared libraries installed.</p>
1692: <p>Libtool, however, extracts a list of libraries from the
1693: <a 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
1694: records it, throwing away the -Bstatic and -Bdynamic options
1695: interspersed between the libraries. This means that
1696: libtool-linked C++ shared libraries will have a runtime
1697: dependency on the icc libraries until this is fixed in
1698: libtool.</p>
1.75 rillig 1699: </div>
1700: <div class="sect2" lang="en">
1701: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1702: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1703: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1704: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1705: with the OpenBSD userland tools. There are several steps:</p>
1.75 rillig 1706: <div class="orderedlist"><ol type="1">
1707: <li><p>OpenBSD stores its ports pkg database in
1.87 wiz 1708: <code class="filename">/var/db/pkg</code>. It is therefore
1709: recommended that you choose a different location (e.g.
1710: <code class="filename">/usr/pkgdb</code>) by
1711: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1712: <li>
1713: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1714: good idea to move them out of the way to avoid confusion, e.g.</p>
1715: <pre class="screen">
1716: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1717: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1718: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1719: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1720: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1721: </pre>
1.75 rillig 1722: </li>
1723: <li>
1.76 rillig 1724: <p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87 wiz 1725: <code class="filename">/etc/mk.conf.example</code> file
1726: when you use the bootstrap script. OpenBSD's make program uses
1727: <code class="filename">/etc/mk.conf</code>
1728: as well. You can work around this by enclosing all the pkgsrc-specific parts
1729: of the file with:</p>
1730: <pre class="programlisting">
1.100 rillig 1731: .ifdef BSD_PKG_MK
1732: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1733: .else
1734: # OpenBSD stuff
1735: .endif
1.87 wiz 1736: </pre>
1.75 rillig 1737: </li>
1738: </ol></div>
1739: </div>
1740: <div class="sect2" lang="en">
1741: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1742: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1743: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1744: You will need a working C compiler. Both gcc 2.95.3 and
1745: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1746: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1747: process and to build packages.</p>
1.75 rillig 1748: <div class="itemizedlist"><ul type="disc">
1749: <li><p>SUNWsprot</p></li>
1750: <li><p>SUNWarc</p></li>
1751: <li><p>SUNWbtool</p></li>
1752: <li><p>SUNWtoo</p></li>
1753: <li><p>SUNWlibm</p></li>
1754: </ul></div>
1.78 rillig 1755: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1756: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1757: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1758: your $prefix are in your <code class="varname">PATH</code>. This includes
1759: <code class="filename">/usr/ccs/{bin,lib}</code>
1760: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75 rillig 1761: <div class="sect3" lang="en">
1762: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1763: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1764: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1765: for building all packages.</p>
1.75 rillig 1766: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1767: then either build gcc from
1.91 rillig 1768: <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 1769: package, then remove gcc used during bootstrapping.</p>
1.93 rillig 1770: <p>Binary packages of gcc can be found through <a href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75 rillig 1771: </div>
1772: <div class="sect3" lang="en">
1773: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1774: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1775: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1776: 5.0)</p>
1.75 rillig 1777: <div class="itemizedlist"><ul type="disc">
1778: <li><p>SPROcc
1.87 wiz 1779: - Sun WorkShop Compiler C 5.0</p></li>
1.75 rillig 1780: <li><p>SPROcpl
1.87 wiz 1781: - Sun WorkShop Compiler C++ 5.0</p></li>
1.75 rillig 1782: <li><p>SPROild
1.87 wiz 1783: - Sun WorkShop Incremental Linker</p></li>
1.75 rillig 1784: <li><p>SPROlang
1.87 wiz 1785: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1786: </ul></div>
1.96 rillig 1787: <p>You should set the following variables in your
1788: <code class="filename">mk.conf</code> file:</p>
1789: <pre class="programlisting">
1.100 rillig 1790: CC= cc
1791: CXX= CC
1792: CPP= cc -E
1793: CXXCPP= CC -E
1.96 rillig 1794: </pre>
1795: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1796: <h3 class="title">Note</h3>
1797: <p>The <code class="varname">CPP</code> setting might break some
1798: packages that use the C preprocessor for processing things other
1799: than C source code.</p>
1800: </div>
1.75 rillig 1801: </div>
1802: <div class="sect3" lang="en">
1803: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1804: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1805: <p>To build 64-bit packages, you just need to have the
1806: following lines in your <code class="filename">mk.conf</code>
1.75 rillig 1807: file:</p>
1808: <pre class="programlisting">
1.100 rillig 1809: PKGSRC_COMPILER= sunpro
1810: ABI= 64
1.96 rillig 1811: </pre>
1812: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1813: <h3 class="title">Note</h3>
1814: <p>This setting has been tested for the SPARC
1815: architecture. Intel and AMD machines need some more
1816: work.</p>
1817: </div>
1.75 rillig 1818: </div>
1819: <div class="sect3" lang="en">
1820: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1821: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75 rillig 1822: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87 wiz 1823: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1824: The workaround is to use another shell for the configure
1.91 rillig 1825: 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.87 wiz 1826: to your <code class="filename">mk.conf</code>:</p>
1827: <pre class="programlisting">
1.100 rillig 1828: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1829: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1830: </pre>
1.91 rillig 1831: <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 1832: </div>
1833: </div>
1834: </div>
1835: </div>
1836: <div class="chapter" lang="en">
1837: <div class="titlepage"><div><div><h2 class="title">
1838: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1839: <div class="toc">
1840: <p><b>Table of Contents</b></p>
1841: <dl>
1842: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1843: <dd><dl>
1844: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1845: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1846: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1847: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1848: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1849: <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>
1850: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1851: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1852: </dl></dd>
1853: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1854: <dd><dl>
1855: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1856: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1857: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1858: </dl></dd>
1859: </dl>
1860: </div>
1861: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1862: is to only install the package tools and to use binary packages
1863: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1864: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1865: of pkgsrc, too. Then you are able to build your own packages,
1866: and you can still use binary packages from someone else.</p>
1.75 rillig 1867: <div class="sect1" lang="en">
1868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1869: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1870: <p>To use binary packages, you need some tools to manage
1.88 wiz 1871: them. On NetBSD, these tools are already installed. On all other
1872: operating systems, you need to install them first. For the
1873: following platforms, prebuilt versions of the package tools
1874: are available and can simply be downloaded and unpacked in the
1875: <code class="filename">/</code> directory:</p>
1.75 rillig 1876: <div class="informaltable">
1877: <a name="binary-bootstrap-kits"></a><table border="1">
1878: <colgroup>
1879: <col>
1880: <col>
1881: </colgroup>
1882: <thead><tr>
1883: <th>Platform</th>
1884: <th>URL</th>
1885: </tr></thead>
1886: <tbody>
1887: <tr>
1888: <td>Solaris 9</td>
1.76 rillig 1889: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1890: </tr>
1891: <tr>
1892: <td>Solaris 10</td>
1.76 rillig 1893: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1894: </tr>
1895: </tbody>
1896: </table>
1897: </div>
1.82 rillig 1898: <p>These pre-built package tools use
1.88 wiz 1899: <code class="filename">/usr/pkg</code> for the base directory, and
1900: <code class="filename">/var/db/pkg</code> for the database of installed
1901: packages. If you cannot use these directories for whatever
1902: reasons (maybe because you're not root), you have to build the
1903: package tools yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.75 rillig 1904: <div class="sect2" lang="en">
1905: <div class="titlepage"><div><div><h3 class="title">
1906: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1907: <p>To install binary packages, you first need to know from
1.88 wiz 1908: where to get them. You can get them on CD-ROMs, DVDs, or via FTP
1909: or HTTP.</p>
1.81 rillig 1910: <p>The binary packages can be found at the following
1.88 wiz 1911: locations.</p>
1.75 rillig 1912: <div class="informaltable">
1913: <a name="binary-packages"></a><table border="1">
1914: <colgroup>
1915: <col>
1916: <col>
1917: </colgroup>
1918: <thead><tr>
1919: <th>Platform</th>
1920: <th>URL</th>
1921: </tr></thead>
1922: <tbody>
1923: <tr>
1.81 rillig 1924: <td>NetBSD</td>
1925: <td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
1926: </tr>
1927: <tr>
1.75 rillig 1928: <td>Solaris 9</td>
1.76 rillig 1929: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
1.75 rillig 1930: </tr>
1931: <tr>
1932: <td>Solaris 10</td>
1.76 rillig 1933: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/</code></td>
1.75 rillig 1934: </tr>
1935: </tbody>
1936: </table>
1937: </div>
1.81 rillig 1938: <p>Most of these directories contain binary packages for
1.88 wiz 1939: multiple platforms. Select the appropriate subdirectories,
1940: according to your machine architecture and operating system,
1941: until you find a directory called <code class="filename">All</code>. This
1942: directory contains all the binary packages. Further, there are
1943: subdirectories for categories that contain symbolic links that
1944: point to the actual binary package in
1945: <code class="filename">../All</code>. This directory layout is used for
1946: all package repositories, no matter if they are accessed via
1947: HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
1.75 rillig 1948: </div>
1949: <div class="sect2" lang="en">
1950: <div class="titlepage"><div><div><h3 class="title">
1951: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87 wiz 1952: <p>If you have the files on a CD-ROM or downloaded them to
1.88 wiz 1953: your hard disk, you can install them with the following command
1954: (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75 rillig 1955: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87 wiz 1956: <p>If you have FTP access and you don't want to download the
1.88 wiz 1957: packages via FTP prior to installation, you can do this
1958: automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.82 rillig 1959: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All/package</code></strong></pre>
1.75 rillig 1960: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1961: package in question will be installed, too, assuming they are
1962: present where you install from.</p>
1.75 rillig 1963: <p>To save some typing, you can set the
1.88 wiz 1964: <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
1965: list of paths (including remote URLs); trailing slashes are not allowed.
1966: </p>
1.76 rillig 1967: <p>Additionally to the <code class="filename">All</code> directory
1.88 wiz 1968: there exists a <code class="filename">vulnerable</code> directory to
1969: which binary packages with known vulnerabilities are
1970: moved, since removing them could cause missing dependencies. To
1971: use these packages, add the <code class="filename">vulnerable</code>
1972: directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91 rillig 1973: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> regularly,
1.88 wiz 1974: especially after installing new packages, and verify that the
1975: vulnerabilities are acceptable for your configuration. An example
1976: <code class="varname">PKG_PATH</code> would be:
1977: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
1978: Please note that semicolon (';') is a shell meta-character, so
1979: you'll probably have to quote it.</p>
1.75 rillig 1980: <p>After you've installed packages, be sure to have
1.88 wiz 1981: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1982: <code class="varname">PATH</code> so you can actually start the just
1983: installed program.</p>
1.75 rillig 1984: </div>
1985: <div class="sect2" lang="en">
1986: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1987: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1988: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1989: installed from source code or from a binary package. The
1990: <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
1991: To delete a package, you can just run <span><strong class="command">pkg_delete
1992: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1993: name can be given with or without version number. Wildcards can
1994: also be used to deinstall a set of packages, for example
1995: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1996: so that the shell does not expand them before
1997: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1998: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1999: removes all the packages that require the package in question
2000: and then removes the package itself. For example:
1.82 rillig 2001:
1.88 wiz 2002: </p>
1.82 rillig 2003: <pre class="screen">
1.88 wiz 2004: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
2005: </pre>
1.82 rillig 2006: <p>
2007:
1.88 wiz 2008: will remove jpeg and all the packages that used it; this allows
2009: upgrading the jpeg package.</p>
1.82 rillig 2010: </div>
2011: <div class="sect2" lang="en">
2012: <div class="titlepage"><div><div><h3 class="title">
2013: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
2014: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88 wiz 2015: installed packages or binary package files.</p>
1.82 rillig 2016: </div>
2017: <div class="sect2" lang="en">
2018: <div class="titlepage"><div><div><h3 class="title">
2019: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
2020: <p>
1.88 wiz 2021: The NetBSD Security-Officer and Packages Groups maintain a list of
2022: known security vulnerabilities to packages which are (or have been)
2023: included in pkgsrc. The list is available from the NetBSD
2024: FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
2025: </p>
1.82 rillig 2026: <p>
1.93 rillig 2027: Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
1.88 wiz 2028: this list can be downloaded
2029: automatically, and a security audit of all packages installed on a system
2030: can take place.
2031: </p>
1.82 rillig 2032: <p>
1.93 rillig 2033: There are two components to
1.91 rillig 2034: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>. The first
1.88 wiz 2035: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
2036: the list of vulnerabilities from the NetBSD FTP site. The second
2037: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
2038: installed packages are vulnerable. If a package is vulnerable, you
2039: will see output similar to the following:
2040: </p>
1.82 rillig 2041: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 2042: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 2043: <p>
1.91 rillig 2044: One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.88 wiz 2045: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
2046: file daily, and include a package audit in the daily security script.
2047: Details on this are located in the <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.91 rillig 2048: file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
1.88 wiz 2049: </p>
1.82 rillig 2050: </div>
2051: <div class="sect2" lang="en">
2052: <div class="titlepage"><div><div><h3 class="title">
2053: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
2054: <p>
1.93 rillig 2055: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a> and run
1.88 wiz 2056: <span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
2057: argument to check if your packages are up-to-date, e.g.
2058: </p>
2059: <pre class="screen">
2060: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 2061: ...
1.88 wiz 2062: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
2063: </pre>
1.82 rillig 2064: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88 wiz 2065: package on your system and rebuild any dependencies.
2066: </p>
1.82 rillig 2067: </div>
2068: <div class="sect2" lang="en">
2069: <div class="titlepage"><div><div><h3 class="title">
2070: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
2071: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88 wiz 2072: administrative functions on the package system.</p>
1.82 rillig 2073: </div>
2074: <div class="sect2" lang="en">
2075: <div class="titlepage"><div><div><h3 class="title">
2076: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 2077: <p>Please pay very careful attention to the warnings
1.88 wiz 2078: expressed in the <a 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
2079: inherent dangers of installing binary packages which you did
2080: not create yourself, and the security holes that can be
2081: introduced onto your system by indiscriminate adding of such
2082: files.</p>
1.75 rillig 2083: <p>The same warning of course applies to every package you
1.88 wiz 2084: install from source when you haven't completely read and
2085: understood the source code of the package, the compiler that
2086: is used to build the package and all the other tools that are
2087: involved.</p>
1.75 rillig 2088: </div>
2089: </div>
2090: <div class="sect1" lang="en">
2091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2092: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 2093: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
2094: directory now contains a set of packages, organized into
2095: categories. You can browse the online index of packages, or run
2096: <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
2097: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 2098: 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 2099: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
2100: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
2101: should do so by setting <code class="varname">LOCALBASE</code> in
2102: <code class="filename">mk.conf</code>. You should not try to use multiple
2103: different <code class="varname">LOCALBASE</code> definitions on the same
2104: system (inside a chroot is an exception). </p>
2105: <p>The rest of this chapter assumes that the package is already
2106: in pkgsrc. If it is not, see <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
2107: instructions how to create your own packages.</p>
1.75 rillig 2108: <div class="sect2" lang="en">
2109: <div class="titlepage"><div><div><h3 class="title">
2110: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 2111: <p>To build packages from source, you need a working C
1.88 wiz 2112: compiler. On NetBSD, you need to install the
2113: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
2114: sets. If you want to build X11-related packages, the
2115: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
2116: sets are required, too.</p>
1.75 rillig 2117: </div>
2118: <div class="sect2" lang="en">
2119: <div class="titlepage"><div><div><h3 class="title">
2120: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
2121: <p>The first step for building a package is downloading the
1.88 wiz 2122: distfiles (i.e. the unmodified source). If they have not yet been
2123: downloaded, pkgsrc will fetch them automatically.</p>
2124: <p>If you have all files that you need in the
2125: <code class="filename">distfiles</code> directory,
2126: you don't need to connect. If the distfiles are on CD-ROM, you can
2127: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
2128: </p>
1.82 rillig 2129: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
2130: <p>
1.88 wiz 2131: to your <code class="filename">mk.conf</code>.</p>
1.91 rillig 2132: <p>By default a list of distribution sites will be randomly
2133: intermixed to prevent huge load on servers which holding popular
2134: packages (for example, SourceForge.net mirrors). Thus, every
2135: time when you need to fetch yet another distfile all the mirrors
2136: will be tried in new (random) order. You can turn this feature
2137: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
2138: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 2139: <p>You can overwrite some of the major distribution sites to
2140: fit to sites that are close to your own. By setting one or two
2141: variables you can modify the order in which the master sites are
2142: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
2143: delimited list of domain suffixes.
2144: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
2145: contains a whitespace delimited list of regular expressions. It
2146: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
2147: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
2148: some examples. This may save some of your bandwidth and
2149: time.</p>
1.75 rillig 2150: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 2151: if you want to keep the settings, by editing the
2152: <code class="filename">/etc/mk.conf</code> file,
2153: and adding the definitions there.</p>
1.82 rillig 2154: <p>
1.88 wiz 2155: If a package depends on many other packages (such as
1.93 rillig 2156: <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 2157: alternate between periods of
2158: downloading source, and compiling. To ensure you have all the source
2159: downloaded initially you can run the command:
2160: </p>
1.82 rillig 2161: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
2162: <p>
1.88 wiz 2163: which will output and run a set of shell commands to fetch the
2164: necessary files into the <code class="filename">distfiles</code> directory. You can
2165: also choose to download the files manually.
2166: </p>
1.75 rillig 2167: </div>
2168: <div class="sect2" lang="en">
2169: <div class="titlepage"><div><div><h3 class="title">
2170: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 2171: <p>
1.88 wiz 2172: Once the software has downloaded, any patches will be applied, then it
2173: will be compiled for you. This may take some time depending on your
2174: computer, and how many other packages the software depends on and their
2175: compile time.
2176: </p>
1.75 rillig 2177: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2178: <h3 class="title">Note</h3>
2179: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88 wiz 2180: use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
2181: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 2182: </div>
1.87 wiz 2183: <p>For example, type</p>
1.88 wiz 2184: <pre class="screen">
2185: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2186: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2187: </pre>
1.75 rillig 2188: <p>at the shell prompt to build the various components of the
1.88 wiz 2189: package.</p>
1.82 rillig 2190: <p>The next stage is to actually install the newly compiled
1.88 wiz 2191: program onto your system. Do this by entering:
1.82 rillig 2192:
1.88 wiz 2193: </p>
1.82 rillig 2194: <pre class="screen">
1.88 wiz 2195: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2196: </pre>
1.82 rillig 2197: <p>
2198:
1.88 wiz 2199: while you are still in the directory for whatever package you
2200: are installing.</p>
1.82 rillig 2201: <p>Installing the package on your system may require you to
1.88 wiz 2202: be root. However, pkgsrc has a
2203: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2204: to only become root for the actual installation step.</p>
1.82 rillig 2205: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2206: You can now enter:
1.82 rillig 2207:
1.88 wiz 2208: </p>
1.82 rillig 2209: <pre class="screen">
1.88 wiz 2210: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2211: </pre>
1.82 rillig 2212: <p>
2213:
1.88 wiz 2214: to remove the compiled files in the work directory, as you shouldn't need
2215: them any more. If other packages were also added to your system
2216: (dependencies) to allow your program to compile, you can tidy these up
2217: also with the command:</p>
1.82 rillig 2218: <pre class="screen">
1.88 wiz 2219: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2220: </pre>
1.75 rillig 2221: <p>Taking the figlet utility as an example, we can install it on our
1.88 wiz 2222: system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
2223: <p>The program is installed under the default root of the
2224: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2225: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2226: variable in your environment, and it will use that value as the
2227: root of your packages tree. So, to use
2228: <code class="filename">/usr/local</code>, set
2229: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2230: Please note that you should use a directory which is dedicated to
2231: packages and not shared with other programs (i.e., do not try and
2232: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2233: to add any of your own files or directories (such as
2234: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2235: <code class="filename">pkgsrc/</code>) below the
2236: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2237: conflicts between programs and other files installed by the
2238: package system and whatever else may have been installed
2239: there.</p>
2240: <p>Some packages look in <code class="filename">/etc/mk.conf</code> to
2241: alter some configuration options at build time. Have a look at
2242: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2243: of what will be set there by default. Environment variables such
2244: as <code class="varname">LOCALBASE</code> can be set in
2245: <code class="filename">/etc/mk.conf</code> to save having to remember to
2246: set them each time you want to use pkgsrc.</p>
2247: <p>Occasionally, people want to “<span class="quote">look under the
2248: covers</span>” to see what is going on when a package is building
2249: or being installed. This may be for debugging purposes, or out of
2250: simple curiosity. A number of utility values have been added to
2251: help with this.</p>
1.75 rillig 2252: <div class="orderedlist"><ol type="1">
2253: <li>
1.88 wiz 2254: <p>If you invoke the <a 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
2255: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2256: information will be displayed. For example,</p>
1.75 rillig 2257: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2258: <p>will show all the commands that are invoked, up to and
2259: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 2260: </li>
2261: <li>
1.88 wiz 2262: <p>If you want to know the value of a certain <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
2263: definition, then the <code class="varname">VARNAME</code> definition
2264: should be used, in conjunction with the show-var
2265: target. e.g. to show the expansion of the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
2266: variable <code class="varname">LOCALBASE</code>:</p>
2267: <pre class="screen">
2268: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2269: /usr/pkg
2270: <code class="prompt">%</code>
1.88 wiz 2271: </pre>
1.75 rillig 2272: </li>
2273: </ol></div>
2274: <p>If you want to install a binary package that you've either
1.88 wiz 2275: created yourself (see next section), that you put into
2276: pkgsrc/packages manually or that is located on a remote FTP
2277: server, you can use the "bin-install" target. This target will
2278: install a binary package - if available - via <a 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>,
2279: else do a <span><strong class="command">make package</strong></span>. The list of remote FTP
2280: sites searched is kept in the variable
2281: <code class="varname">BINPKG_SITES</code>, which defaults to
2282: ftp.NetBSD.org. Any flags that should be added to <a 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>
2283: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2284: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2285: details.</p>
2286: <p>A final word of warning: If you set up a system that has a
2287: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2288: set that before any packages are installed, as you cannot use
2289: several directories for the same purpose. Doing so will result in
2290: pkgsrc not being able to properly detect your installed packages,
2291: and fail miserably. Note also that precompiled binary packages are
2292: usually built with the default <code class="varname">LOCALBASE</code> of
2293: <code class="filename">/usr/pkg</code>, and that you should
2294: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2295: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2296: </div>
2297: </div>
2298: </div>
2299: <div class="chapter" lang="en">
2300: <div class="titlepage"><div><div><h2 class="title">
2301: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2302: <div class="toc">
2303: <p><b>Table of Contents</b></p>
2304: <dl>
2305: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2306: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 2307: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2308: <dd><dl>
1.89 rillig 2309: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
2310: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2311: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 2312: </dl></dd>
1.78 rillig 2313: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
2314: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 2315: </dl>
2316: </div>
1.89 rillig 2317: <p>The whole pkgsrc system is configured in a single file, usually
2318: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2319: that file depends on the installation. On NetBSD, when you use
2320: <a 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
2321: <code class="filename">/etc/</code>. In all other cases the default location is
2322: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2323: bootstrap program to install the binary packages.</p>
2324: <p>During the bootstrap, an example configuration file is created. To
2325: use that, you have to create the directory
2326: <code class="filename">${PREFIX}/etc</code> and copy the example file
2327: there.</p>
2328: <p>The format of the configuration file is that of the usual
2329: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2330: is done by setting variables in this file. Note that you can define all
2331: kinds of variables, and no special error checking (for example for
2332: spelling mistakes) takes place, so you have to try it out to see if it
2333: works.</p>
1.75 rillig 2334: <div class="sect1" lang="en">
2335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2336: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2337: <p>In this section, you can find some variables that apply to all
1.89 rillig 2338: pkgsrc packages. A complete list of the variables that can be
2339: configured by the user is available in
2340: <code class="filename">mk/defaults/mk.conf</code>, together with some
2341: comments that describe each variable's intent.</p>
1.75 rillig 2342: <div class="itemizedlist"><ul type="disc">
2343: <li><p><code class="varname">LOCALBASE</code>: Where
2344: packages will be installed. The default is
1.76 rillig 2345: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2346: with different <code class="varname">LOCALBASE</code>s!</p></li>
2347: <li><p><code class="varname">CROSSBASE</code>: Where
2348: “<span class="quote">cross</span>” category packages will be
2349: installed. The default is
1.76 rillig 2350: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2351: <li><p><code class="varname">X11BASE</code>: Where
2352: X11 is installed on the system. The default is
1.76 rillig 2353: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2354: <li><p><code class="varname">DISTDIR</code>: Where to store the
2355: downloaded copies of the original source distributions used
2356: for building pkgsrc packages. The default is
1.76 rillig 2357: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97 rillig 2358: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2359: database about installed packages is stored. The default is
2360: <code class="filename">/var/db/pkg</code>.</p></li>
1.75 rillig 2361: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2362: If set, override the packages'
2363: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2364: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2365: Backup location(s) for distribution files and patch files
2366: if not found locally or in
1.76 rillig 2367: <code class="filename">${MASTER_SITES}</code> or
2368: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2369: The defaults are
1.76 rillig 2370: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2371: and
1.76 rillig 2372: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2373: <li><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2374: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2375: <em class="replaceable"><code>arch</code></em> are replaced with OS
2376: release (“<span class="quote">2.0</span>”, etc.) and architecture
2377: (“<span class="quote">mipsel</span>”, etc.).</p></li>
1.82 rillig 2378: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2379: List of acceptable licenses. Whenever you try to build a package
2380: whose license is not in this list, you will get an error message
2381: that includes instructions on how to change this variable.</p></li>
1.75 rillig 2382: </ul></div>
2383: </div>
2384: <div class="sect1" lang="en">
2385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2386: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2387: <p>XXX
2388: </p>
2389: <div class="itemizedlist"><ul type="disc">
2390: <li><p><code class="varname">PACKAGES</code>: The top level
2391: directory for the binary packages. The default is
1.76 rillig 2392: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2393: <li><p><code class="varname">WRKOBJDIR</code>:
2394: The top level directory where, if defined, the separate
2395: working directories will get created, and symbolically
1.76 rillig 2396: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2397: This is useful for building packages on several
1.76 rillig 2398: architectures, then <code class="filename">${PKGSRCDIR}</code>
2399: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2400: is local to every architecture. (It should be noted that
2401: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.89 rillig 2402: — it is an internal definition which refers to the
1.75 rillig 2403: root of the pkgsrc tree. It is possible to have many
2404: pkgsrc tree instances.)</p></li>
2405: <li><p><code class="varname">LOCALPATCHES</code>:
2406: Directory for local patches that aren't part of pkgsrc.
1.90 rillig 2407: See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more
1.93 rillig 2408: information.</p></li>
1.75 rillig 2409: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.76 rillig 2410: the <code class="filename">mk.conf</code> file used by a package's
1.75 rillig 2411: BSD-style Makefile. If this is not set,
2412: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2413: <code class="filename">/dev/null</code> to avoid picking up
2414: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2415: <li><p><code class="varname">DEPENDS_TARGET</code>:
2416: By default, dependencies are only installed, and no binary
2417: package is created for them. You can set this variable to
2418: <code class="literal">package</code> to automatically create binary
2419: packages after installing dependencies.</p></li>
1.75 rillig 2420: </ul></div>
2421: </div>
2422: <div class="sect1" lang="en">
2423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78 rillig 2424: <a name="conf.compiler"></a>5.3. Selecting and configuring the compiler</h2></div></div></div>
2425: <div class="sect2" lang="en">
2426: <div class="titlepage"><div><div><h3 class="title">
1.89 rillig 2427: <a name="selecting-the-compiler"></a>5.3.1. Selecting the compiler</h3></div></div></div>
2428: <p>By default, pkgsrc will use GCC to build packages. This may be
2429: overridden by setting the following variables in /etc/mk.conf:</p>
2430: <div class="variablelist"><dl>
2431: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2432: <dd>
2433: <p>This is a list of values specifying the chain of
2434: compilers to invoke when building packages. Valid values
2435: are:</p>
2436: <div class="itemizedlist"><ul type="disc">
2437: <li><p><code class="varname">distcc</code>:
2438: distributed C/C++ (chainable)</p></li>
2439: <li><p><code class="varname">ccache</code>:
2440: compiler cache (chainable)</p></li>
2441: <li><p><code class="varname">gcc</code>:
2442: GNU C/C++ Compiler</p></li>
2443: <li><p><code class="varname">mipspro</code>:
2444: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2445: <li><p><code class="varname">mipspro</code>:
2446: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2447: <li><p><code class="varname">sunpro</code>:
2448: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2449: </ul></div>
2450: <p>The default is
2451: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2452: <code class="varname">ccache</code> and/or
2453: <code class="varname">distcc</code> with an appropriate
2454: <code class="varname">PKGSRC_COMPILER</code> setting,
2455: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
1.94 dmcmahil 2456: variable should always be terminated with a value for
2457: a real compiler. Note that only one real compiler
2458: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2459: is not allowed).</p>
1.89 rillig 2460: </dd>
2461: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2462: <dd><p>This specifies the minimum version of GCC to use
2463: when building packages. If the system GCC doesn't
2464: satisfy this requirement, then pkgsrc will build and
2465: install one of the GCC packages to use instead.</p></dd>
2466: </dl></div>
2467: </div>
2468: <div class="sect2" lang="en">
2469: <div class="titlepage"><div><div><h3 class="title">
2470: <a name="conf.cflags"></a>5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78 rillig 2471: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2472: please make sure to use the <code class="literal">+=</code> operator
2473: instead of the <code class="literal">=</code> operator:</p>
2474: <pre class="programlisting">
1.100 rillig 2475: CFLAGS+= -your -flags
1.78 rillig 2476: </pre>
2477: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2478: “<span class="quote">+</span>”) may lead to problems with packages that need
2479: to add their own flags. Also, you may want to take a look at
1.91 rillig 2480: the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a> package if
1.78 rillig 2481: you're interested in optimization for the current CPU.</p>
2482: </div>
1.88 wiz 2483: <div class="sect2" lang="en">
2484: <div class="titlepage"><div><div><h3 class="title">
1.89 rillig 2485: <a name="conf.ldflags"></a>5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88 wiz 2486: <p>If you want to pass flags to the linker, both in the configure
2487: step and the build step, you can do this in two ways. Either set
2488: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2489: between the two is that <code class="varname">LIBS</code> will be appended to
2490: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2491: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2492: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2493: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2494: <code class="varname">CFLAGS</code>, if you do not wish to override these
2495: settings, use the <code class="literal">+=</code> operator:</p>
2496: <pre class="programlisting">
1.100 rillig 2497: LDFLAGS+= -your -linkerflags
1.88 wiz 2498: </pre>
2499: </div>
1.78 rillig 2500: </div>
2501: <div class="sect1" lang="en">
2502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2503: <a name="developer-advanced-settings"></a>5.4. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2504: <p>XXX
2505: </p>
2506: <div class="itemizedlist"><ul type="disc">
2507: <li>
2508: <p><code class="varname">PKG_DEVELOPER</code>:
2509: Run some sanity checks that package developers want:
2510: </p>
2511: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2512: <li><p>make sure patches apply with zero
2513: fuzz</p></li>
2514: <li><p>run check-shlibs to see that all
2515: binaries will find their shared libs.</p></li>
1.75 rillig 2516: </ul></div>
2517: <p>
1.87 wiz 2518: </p>
1.75 rillig 2519: </li>
1.88 wiz 2520: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2521: of debugging output which is displayed whilst making and
2522: installing the package. The default value for this is 0,
2523: which will not display the commands as they are executed
2524: (normal, default, quiet operation); the value 1 will display
2525: all shell commands before their invocation, and the value 2
2526: will display both the shell commands before their invocation,
2527: and their actual execution progress with <span><strong class="command">set
2528: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2529: </ul></div>
2530: <p>
2531: </p>
2532: </div>
2533: <div class="sect1" lang="en">
2534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78 rillig 2535: <a name="selecting-build-options"></a>5.5. Selecting Build Options</h2></div></div></div>
1.88 wiz 2536: <p>Some packages have build time options, usually to select
2537: between different dependencies, enable optional support for big
2538: dependencies or enable experimental features.</p>
1.75 rillig 2539: <p>To see which options, if any, a package supports, and which
1.88 wiz 2540: options are mutually exclusive, run <span><strong class="command">make
2541: show-options</strong></span>, for example:</p>
1.75 rillig 2542: <pre class="programlisting">
2543: The following options are supported by this package:
2544: ssl Enable SSL support.
2545: Exactly one of the following gecko options is required:
2546: firefox Use firefox as gecko rendering engine.
2547: mozilla Use mozilla as gecko rendering engine.
2548: At most one of the following database options may be selected:
2549: mysql Enable support for MySQL database.
2550: pgsql Enable support for PostgreSQL database.
1.1 grant 2551:
1.75 rillig 2552: These options are enabled by default: firefox
2553: These options are currently enabled: mozilla ssl
1.1 grant 2554: </pre>
1.75 rillig 2555: <p>The following variables can be defined in
1.88 wiz 2556: <code class="filename">/etc/mk.conf</code> to select which options to
2557: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2558: which can be used to select or disable options for all packages
2559: that support them, and
2560: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2561: which can be used to select or disable options specifically for
2562: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2563: these variables are selected, options preceded by “<span class="quote">-</span>”
2564: are disabled. A few examples:</p>
1.75 rillig 2565: <pre class="screen">
2566: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" /etc/mk.conf</strong></span>
2567: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2568: PKG_OPTIONS.kdebase= debug -sasl
2569: PKG_OPTIONS.apache= suexec </pre>
1.88 wiz 2570: <p>The following settings are consulted in the order given, and
2571: the last setting that selects or disables an option is
2572: used:</p>
1.75 rillig 2573: <div class="orderedlist"><ol type="1">
2574: <li><p>the default options as suggested by the package
1.88 wiz 2575: maintainer</p></li>
1.75 rillig 2576: <li><p>the options implied by the settings of legacy
1.88 wiz 2577: variables (see below)</p></li>
1.75 rillig 2578: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2579: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2580: </ol></div>
2581: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2582: selected is used, all others are automatically disabled. If an
2583: option of the group is explicitly disabled, the previously
2584: selected option, if any, is used. It is an error if no option
2585: from a required group of options is selected, and building the
2586: package will fail.</p>
2587: <p>Before the options framework was introduced, build options
2588: were selected by setting a variable (often named
2589: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
2590: <code class="filename">/etc/mk.conf</code> for each option. To ease
2591: transition to the options framework for the user, these legacy
2592: variables are converted to the appropriate options setting
2593: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2594: automatically. A warning is issued to prompt the user to update
2595: <code class="filename">/etc/mk.conf</code> to use the options framework
2596: directly. Support for the legacy variables will be removed
2597: eventually.</p>
1.75 rillig 2598: </div>
2599: </div>
2600: <div class="chapter" lang="en">
2601: <div class="titlepage"><div><div><h2 class="title">
2602: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2603: <div class="toc">
2604: <p><b>Table of Contents</b></p>
2605: <dl>
2606: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2607: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2608: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
2609: <dd><dl>
2610: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
2611: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
2612: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
2613: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
2614: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
2615: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2616: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
2617: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
2618: </dl></dd>
2619: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2620: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
2621: </dl>
2622: </div>
2623: <div class="sect1" lang="en">
2624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2625: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2626: <p>Once you have built and installed a package, you can create
2627: a <span class="emphasis"><em>binary package</em></span> which can be installed on
2628: another system with <a 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
2629: the same package on a group of hosts and wasting CPU time. It also
2630: provides a simple means for others to install your package, should
2631: you distribute it.</p>
2632: <p>To create a binary package, change into the appropriate
2633: directory in pkgsrc, and run <span><strong class="command">make
2634: package</strong></span>:</p>
2635: <pre class="screen">
2636: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2637: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2638: </pre>
2639: <p>This will build and install your package (if not already done),
2640: and then build a binary package from what was installed. You can
2641: then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
2642: it. Binary packages are created by default in
2643: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2644: gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2645: 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.90 rillig 2646: <p>See <a href="#submit" title="Chapter 20. Submitting and Committing">Chapter 20, <i>Submitting and Committing</i></a> for information on how to submit
1.87 wiz 2647: such a binary package.</p>
1.75 rillig 2648: </div>
2649: <div class="sect1" lang="en">
2650: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2651: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90 rillig 2652: <p>See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, “Other helpful targets”</a>.</p>
1.75 rillig 2653: </div>
2654: <div class="sect1" lang="en">
2655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2656: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
2657: <p>If you want to get a full set of precompiled binary
1.87 wiz 2658: packages, this section describes how to get them. Beware that
2659: the bulk build will remove all currently installed packages from
2660: your system!</p>
1.75 rillig 2661: <p>Having an FTP server configured either on the
1.87 wiz 2662: machine doing the bulk builds or on a nearby NFS server can help
2663: to make the packages available to other machines that can then
2664: save time by installing only the binary packages. See <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ftpd+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftpd</span>(8)</span></a> for
2665: more information. If you use a remote NFS server's storage, be
2666: sure to not actually compile on NFS storage, as this slows
2667: things down a lot.</p>
1.75 rillig 2668: <div class="sect2" lang="en">
2669: <div class="titlepage"><div><div><h3 class="title">
2670: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
2671: <div class="sect3" lang="en">
2672: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 2673: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code>
2674: </h4></div></div></div>
1.76 rillig 2675: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2676: configuration file for bulk builds. You can configure how your
2677: copy of pkgsrc is kept up to date, how the distfiles are
2678: downloaded, how the packages are built and how the report is
2679: generated. You can find an annotated example file in
2680: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2681: it, copy <code class="filename">build.conf-example</code> to
2682: <code class="filename">build.conf</code> and edit it, following the
2683: comments in that file.</p>
1.75 rillig 2684: </div>
2685: <div class="sect3" lang="en">
2686: <div class="titlepage"><div><div><h4 class="title">
2687: <a name="binary.mk.conf"></a>6.3.1.2. /etc/mk.conf</h4></div></div></div>
2688: <p>You may want to set variables in
1.87 wiz 2689: <code class="filename">/etc/mk.conf</code>.
2690: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2691: details of the default settings. You will want to ensure that
2692: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2693: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
2694: accepts <span class="emphasis"><em>all</em></span> licenses.</p>
2695: <pre class="programlisting">
1.100 rillig 2696: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2697: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2698: BSDSRCDIR= /usr/src
2699: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2700: OBJHOSTNAME?= yes # use work.`hostname`
2701: FAILOVER_FETCH= yes # insist on the correct checksum
2702: PKG_DEVELOPER?= yes
2703: _ACCEPTABLE= yes
2704: </pre>
1.75 rillig 2705: <p>Some options that are especially useful for bulk builds
2706: can be found at the top lines of the file
1.76 rillig 2707: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2708: options of these are briefly described here.</p>
2709: <div class="itemizedlist"><ul type="disc">
2710: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2711: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2712: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2713: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2714: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2715: to the directory where all log files are created. Otherwise the
2716: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2717: <li><p>Another important variable is
1.87 wiz 2718: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2719: should be always available while building other
2720: packages.</p></li>
1.75 rillig 2721: </ul></div>
2722: <p>Some other options are scattered in the pkgsrc
2723: infrastructure:</p>
2724: <div class="itemizedlist"><ul type="disc">
2725: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2726: should be set to <code class="literal">yes</code>. The purpose of the bulk
2727: builds is creating binary packages, no matter if they are
2728: vulnerable or not. When uploading the packages to a public
2729: server, the vulnerable packages will be put into a directory of
2730: their own. Leaving this variable unset would prevent the bulk
2731: build system from even trying to build them, so possible
2732: building errors would not show up.</p></li>
1.75 rillig 2733: <li><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2734: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87 wiz 2735: “<span class="quote">yes</span>” to check that the installed set of files
2736: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2737: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2738: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87 wiz 2739: “<span class="quote">yes</span>” to check that the installed
2740: “<span class="quote">#!</span>”-scripts will find their
2741: interpreter.</p></li>
1.91 rillig 2742: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2743: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2744: package's self-test before installing it. Note that some
2745: packages make heavy use of “<span class="quote">good</span>” random
2746: numbers, so you need to assure that the machine on which you
2747: are doing the bulk builds is not completely idle. Otherwise
2748: some test programs will seem to hang, while they are just
2749: waiting for new random data to be
2750: available.</p></li>
1.75 rillig 2751: </ul></div>
2752: </div>
2753: <div class="sect3" lang="en">
2754: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 2755: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
2756: </h4></div></div></div>
1.75 rillig 2757: <p>It is possible to configure the bulk build to perform
1.87 wiz 2758: certain site-specific tasks at the end of the pre-build
2759: stage. If the file
2760: <code class="filename">pre-build.local</code> exists in
2761: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2762: (as a <a 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
2763: stage. An example use of
2764: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2765: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2766: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2767: <p>to prevent the system from trying to build a particular package
1.87 wiz 2768: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2769: </div>
2770: </div>
2771: <div class="sect2" lang="en">
2772: <div class="titlepage"><div><div><h3 class="title">
2773: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2774: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2775: deleted at the start of bulk builds, make sure your login
2776: shell is placed somewhere else. Either drop it into
2777: <code class="filename">/usr/local/bin</code> (and adjust your login
2778: shell in the passwd file), or (re-)install it via
2779: <a 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
2780: you can login after a reboot (remember that your current
2781: process won't die if the package is removed, you just can't
2782: start any new instances of the shell any more). Also, if you
2783: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2784: version of ssh for some reason, be sure to install ssh before
2785: starting it from <code class="filename">rc.local</code>:</p>
2786: <pre class="programlisting">
1.100 rillig 2787: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2788: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2789: /usr/pkg/etc/rc.d/sshd
2790: fi
2791: </pre>
1.75 rillig 2792: <p>Not doing so will result in you being not able to log in
1.87 wiz 2793: via ssh after the bulk build is finished or if the machine
2794: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2795: </div>
2796: <div class="sect2" lang="en">
2797: <div class="titlepage"><div><div><h3 class="title">
2798: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
2799: <p>Make sure you don't need any of the packages still
1.87 wiz 2800: installed.</p>
1.75 rillig 2801: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2802: <h3 class="title">Warning</h3>
1.99 rillig 2803: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2804: configuration files and some more files from
2805: <code class="filename">/var</code>, <code class="filename">/home</code> and
2806: possibly other locations will be removed! So don't run a bulk
2807: build with privileges that might harm your
2808: system.</em></span></p>
1.75 rillig 2809: </div>
2810: <p>Be sure to remove all other things that might
1.87 wiz 2811: interfere with builds, like some libs installed in
2812: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2813: <pre class="screen">
2814: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2815: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2816: </pre>
1.75 rillig 2817: <p>If for some reason your last build didn't complete (power
1.87 wiz 2818: failure, system panic, ...), you can continue it by
2819: running:</p>
1.75 rillig 2820: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2821: <p>At the end of the bulk build, you will get a summary via mail,
2822: and find build logs in the directory specified by
2823: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2824: file.</p>
1.75 rillig 2825: </div>
2826: <div class="sect2" lang="en">
2827: <div class="titlepage"><div><div><h3 class="title">
2828: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
2829: <p>The bulk builds consist of three steps:</p>
2830: <div class="variablelist"><dl>
2831: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2832: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2833: cleans out any broken distfiles, and removes all
2834: packages installed.</p></dd>
1.75 rillig 2835: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2836: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2837: an optimised order in which packages will be
2838: built. Packages that don't require other packages will
2839: be built first, and packages with many dependencies will
2840: be built later.</p></dd>
1.75 rillig 2841: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2842: <dd><p>Generates a report that's placed in the directory
2843: specified in the <code class="filename">build.conf</code> file
2844: named <code class="filename">broken.html</code>, a short version
2845: of that report will also be mailed to the build's
2846: admin.</p></dd>
1.75 rillig 2847: </dl></div>
1.87 wiz 2848: <p>During the build, a list of broken packages will be compiled
2849: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2850: <code class="filename">.../.broken.${MACHINE}</code> if
2851: <code class="varname">OBJMACHINE</code> is set), individual build logs
2852: of broken builds can be found in the package's
2853: directory. These files are used by the bulk-targets to mark
2854: broken builds to not waste time trying to rebuild them, and
2855: they can be used to debug these broken package builds
2856: later.</p>
1.75 rillig 2857: </div>
2858: <div class="sect2" lang="en">
2859: <div class="titlepage"><div><div><h3 class="title">
2860: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
2861: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2862: NetBSD 2.0/i386:</p>
1.75 rillig 2863: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2864: <li><p>10 GB - distfiles (NFS ok)</p></li>
2865: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2866: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2867: </ul></div>
2868: <p>Note that all pkgs will be de-installed as soon as they are
2869: turned into a binary package, and that sources are removed,
2870: so there is no excessively huge demand to disk
2871: space. Afterwards, if the package is needed again, it will
2872: be installed via <a 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
2873: there are no cycles wasted by recompiling.</p>
1.75 rillig 2874: </div>
2875: <div class="sect2" lang="en">
2876: <div class="titlepage"><div><div><h3 class="title">
2877: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2878: <p>If you don't want all the packages nuked from a machine
2879: (rendering it useless for anything but pkg compiling), there
2880: is the possibility of doing the package bulk build inside a
2881: chroot environment.</p>
2882: <p>The first step is to set up a chroot sandbox,
2883: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2884: using null mounts, or manually.</p>
2885: <p>There is a shell script called
2886: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2887: up the sandbox environment using null mounts. It will also
2888: create a script called <code class="filename">sandbox</code> in the
2889: root of the sandbox environment, which will allow the null
2890: mounts to be activated using the <span><strong class="command">sandbox
2891: mount</strong></span> command and deactivated using the
2892: <span><strong class="command">sandbox umount</strong></span> command.</p>
2893: <p>To set up a sandbox environment by hand, after extracting all
2894: the sets from a NetBSD installation or doing a <span><strong class="command">make
2895: distribution DESTDIR=/usr/sandbox</strong></span> in
2896: <code class="filename">/usr/src/etc</code>, be sure the following items
2897: are present and properly configured:</p>
1.75 rillig 2898: <div class="procedure"><ol type="1">
2899: <li>
2900: <p>Kernel</p>
2901: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2902: </li>
2903: <li>
1.76 rillig 2904: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2905: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2906: </li>
2907: <li>
1.91 rillig 2908: <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 2909: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2910: </li>
2911: <li>
2912: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2913: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2914: </li>
2915: <li>
1.91 rillig 2916: <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 2917: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2918: </li>
2919: <li>
1.76 rillig 2920: <p><code class="filename">/usr/src</code> (system sources,
1.91 rillig 2921: 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 2922: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2923: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2924: </li>
2925: <li>
1.76 rillig 2926: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2927: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2928: </li>
2929: <li>
1.76 rillig 2930: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2931: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2932: </li>
2933: <li>
2934: <p>Checkout pkgsrc via cvs into
1.87 wiz 2935: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2936: <pre class="screen">
2937: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2938: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2939: </pre>
1.75 rillig 2940: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2941: you do development in, as this will likely cause problems!</p>
1.75 rillig 2942: </li>
2943: <li><p>Make
1.87 wiz 2944: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2945: <code class="filename">.../distfiles</code> point somewhere
2946: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.76 rillig 2947: <li><p>Edit <code class="filename">/etc/mk.conf</code>, see <a href="#binary.mk.conf" title="6.3.1.2. /etc/mk.conf">Section 6.3.1.2, “/etc/mk.conf”</a>.</p></li>
2948: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2949: </ol></div>
2950: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2951: the build with the following steps:</p>
2952: <pre class="screen">
2953: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2954: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2955: </pre>
2956: <p>This will just jump inside the sandbox and start building. At
2957: the end of the build, mail will be sent with the results of
2958: the build. Created binary pkgs will be in
2959: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2960: (wherever that points/mounts to/from).</p>
1.75 rillig 2961: </div>
2962: <div class="sect2" lang="en">
2963: <div class="titlepage"><div><div><h3 class="title">
2964: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2965: <p>In addition to building a complete set of all packages in
2966: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2967: may be used to build a subset of the packages contained in
2968: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
2969: in <code class="filename">/etc/mk.conf</code>, the variables</p>
1.75 rillig 2970: <div class="itemizedlist"><ul type="disc">
2971: <li><p>SITE_SPECIFIC_PKGS</p></li>
2972: <li><p>HOST_SPECIFIC_PKGS</p></li>
2973: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2974: <li><p>USER_SPECIFIC_PKGS</p></li>
2975: </ul></div>
1.87 wiz 2976: <p>will define the set of packages which should be built.
2977: The bulk build code will also include any packages which are
2978: needed as dependencies for the explicitly listed packages.</p>
2979: <p>One use of this is to do a bulk build with
2980: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2981: periodically to have a complete set of the binary packages
2982: needed for your site available without the overhead of
2983: building extra packages that are not needed.</p>
1.75 rillig 2984: </div>
2985: <div class="sect2" lang="en">
2986: <div class="titlepage"><div><div><h3 class="title">
2987: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2988: <p>This section describes how pkgsrc developers can upload binary
2989: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2990: <p>If you would like to automatically create checksum files for the
2991: binary packages you intend to upload, remember to set
2992: <code class="varname">MKSUMS=yes</code> in your
2993: <code class="filename">mk/bulk/build.conf</code>.</p>
2994: <p>If you would like to PGP sign the checksum files (highly
2995: recommended!), remember to set
2996: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2997: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2998: your GPG password to sign the files before uploading everything.</p>
2999: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
3000: set properly in your <code class="filename">mk/bulk/build.conf</code>
3001: file, i.e. adjust it to something like one of the following:</p>
1.93 rillig 3002: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
3003: <p>Please use appropriate values for "packages-200xQy",
1.87 wiz 3004: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
3005: is different from your local login, write your login directly
3006: into the variable, e.g. my local account is "feyrer", but for my
3007: login "hubertf", I use:</p>
1.93 rillig 3008: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 3009: <p>A separate <code class="filename">upload</code> directory is used
3010: here to allow "closing" the directory during upload. To do
3011: so, run the following command on ftp.NetBSD.org next:</p>
1.93 rillig 3012: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87 wiz 3013: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
3014: only appropriate for packages for the NetBSD operating
3015: system. Binary packages for other operating systems should go
3016: into <code class="filename">/pub/pkgsrc</code>.</p>
3017: <p>Before uploading the binary pkgs, ssh authentication needs
3018: to be set up. This example shows how to set up temporary keys
3019: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
3020: (assuming that no keys should be present there usually):</p>
3021: <pre class="screen">
3022: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 3023: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
3024: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 3025: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
3026: </pre>
3027: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
3028: append it to your <code class="filename">~/.ssh/authorized_keys</code>
3029: file on ftp.NetBSD.org. You can remove the key after the
3030: upload is done!</p>
3031: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 3032: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 3033: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
3034: <p>Now after all this works, you can exit the sandbox and start
3035: the upload:</p>
3036: <pre class="screen">
3037: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 3038: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 3039: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3040: </pre>
3041: <p>The upload process may take quite some time. Use <a 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
3042: <a 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
3043: upload. The upload script will take care of not uploading
3044: restricted packages and putting vulnerable packages into the
3045: <code class="filename">vulnerable</code> subdirectory.</p>
3046: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 3047: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 3048: Gdd:x! </pre>
3049: <p>Use whatever is needed to remove the key you've entered
3050: before! Last, move the uploaded packages out of the
3051: <code class="filename">upload</code> directory to have them accessible
3052: to everyone:</p>
3053: <pre class="screen">
1.93 rillig 3054: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 3055: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3056: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 3057: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
3058: </pre>
1.75 rillig 3059: </div>
3060: </div>
3061: <div class="sect1" lang="en">
3062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3063: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 3064: <p>After your pkgsrc bulk-build has completed, you may wish to
3065: create a CD-ROM set of the resulting binary packages to assist
3066: in installing packages on other machines. The
1.91 rillig 3067: <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 3068: a simple tool for creating the ISO 9660 images.
3069: <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
3070: way that keeps all the dependencies for a given package on the same
3071: CD as that package.</p>
1.75 rillig 3072: <div class="sect2" lang="en">
3073: <div class="titlepage"><div><div><h3 class="title">
3074: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 3075: <p>Complete documentation for cdpack is found in the cdpack(1)
3076: man page. The following short example assumes that the binary
3077: packages are left in
3078: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3079: sufficient disk space exists in <code class="filename">/u2</code> to
3080: hold the ISO 9660 images.</p>
3081: <pre class="screen">
3082: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3083: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3084: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3085: </pre>
3086: <p>If you wish to include a common set of files
3087: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3088: etc.) on each CD in the collection, then you need to create a
3089: directory which contains these files. e.g.</p>
3090: <pre class="screen">
3091: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3092: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3093: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3094: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3095: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3096: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3097: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3098: </pre>
1.75 rillig 3099: <p>Now create the images:</p>
3100: <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 3101: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3102: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3103: in their root directories.</p>
1.75 rillig 3104: </div>
3105: </div>
3106: </div>
3107: <div class="chapter" lang="en">
3108: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3109: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
3110: <div class="toc">
3111: <p><b>Table of Contents</b></p>
3112: <dl>
1.91 rillig 3113: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90 rillig 3114: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
3115: </dl>
3116: </div>
3117: <p>The files that are installed by pkgsrc are organized in a way that
3118: is similar to what you find in the <code class="filename">/usr</code> directory
3119: of the base system. But some details are different. This is because
3120: pkgsrc initially came from FreeBSD and had adopted its file system
3121: hierarchy. Later it was largely influenced by NetBSD. But no matter
3122: which operating system you are using pkgsrc with, you can expect the
3123: same layout for pkgsrc.</p>
1.91 rillig 3124: <p>There are mainly four root directories for pkgsrc, which are all
3125: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3126: When pkgsrc has been installed as root, the default locations
3127: are:</p>
3128: <pre class="programlisting">
1.100 rillig 3129: LOCALBASE= /usr/pkg
3130: PKG_SYSCONFBASE= /usr/pkg/etc
3131: VARBASE= /var
3132: PKG_DBDIR= /var/db/pkg
1.91 rillig 3133: </pre>
3134: <p>In unprivileged mode (when pkgsrc has been installed as any other
3135: user), the default locations are:</p>
3136: <pre class="programlisting">
1.100 rillig 3137: LOCALBASE= ${HOME}/pkg
3138: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3139: VARBASE= ${HOME}/pkg/var
3140: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3141: </pre>
3142: <p>What these four directories are for, and what they look like is
3143: explained below.</p>
1.90 rillig 3144: <div class="itemizedlist"><ul type="disc">
3145: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3146: <code class="filename">/usr</code> directory in the base system. It is the
3147: “<span class="quote">main</span>” directory where the files are installed and contains
3148: the well-known subdirectories like <code class="filename">bin</code>,
3149: <code class="filename">include</code>, <code class="filename">lib</code>,
3150: <code class="filename">share</code> and
3151: <code class="filename">sbin</code>.</p></li>
3152: <li><p><code class="varname">VARBASE</code> corresponds to
3153: <code class="filename">/var</code> in the base system. Some programs (especially
3154: games, network daemons) need write access to it during normal
3155: operation.</p></li>
3156: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3157: <code class="filename">/etc</code> in the base system. It contains configuration
3158: files of the packages, as well as pkgsrc's <code class="filename">mk.conf</code>
3159: itself.</p></li>
3160: </ul></div>
3161: <div class="sect1" lang="en">
3162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 3163: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code>
3164: </h2></div></div></div>
1.90 rillig 3165: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3166: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3167: <div class="variablelist"><dl>
3168: <dt><span class="term"><code class="filename">bin</code></span></dt>
3169: <dd><p>Contains executable programs that are intended to be
3170: directly used by the end user.</p></dd>
3171: <dt><span class="term"><code class="filename">emul</code></span></dt>
3172: <dd><p>Contains files for the emulation layers of various other
3173: operating systems, especially for
3174: NetBSD.</p></dd>
3175: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3176: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3177: <dd><p>Contains
3178: the configuration files.</p></dd>
3179: <dt><span class="term"><code class="filename">include</code></span></dt>
3180: <dd><p>Contains headers for the C and C++ programming
3181: languages.</p></dd>
3182: <dt><span class="term"><code class="filename">info</code></span></dt>
3183: <dd><p>Contains GNU info files of various
3184: packages.</p></dd>
3185: <dt><span class="term"><code class="filename">lib</code></span></dt>
3186: <dd><p>Contains shared and static
3187: libraries.</p></dd>
3188: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3189: <dd><p>Contains data files that don't change after
3190: installation. Other data files belong into
3191: <code class="filename">${VARBASE}</code>.</p></dd>
3192: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3193: <dd><p>Contains programs that are not intended to be used by
3194: end users, such as helper programs or network
3195: daemons.</p></dd>
3196: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3197: <dd><p>Contains programs that are intended to be executed as
3198: CGI scripts by a web server.</p></dd>
3199: <dt><span class="term"><code class="filename">man</code> (the usual value of
3200: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3201: <dd><p>Contains brief
3202: documentation in form of manual pages.</p></dd>
3203: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3204: <dd><p>Contains programs that are intended to be used only by
3205: the super-user.</p></dd>
3206: <dt><span class="term"><code class="filename">share</code></span></dt>
3207: <dd><p>Contains platform-independent data files that don't
3208: change after installation.</p></dd>
3209: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3210: <dd><p>Contains documentation files provided by the
3211: packages.</p></dd>
3212: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3213: <dd><p>Contains example files provided by the packages. Among
3214: others, the original configuration files are saved here and copied to
3215: <code class="filename">${PKG_SYSCONFDIR}</code> during
3216: installation.</p></dd>
3217: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3218: <dd><p>Contains the original files for rc.d
3219: scripts.</p></dd>
3220: <dt><span class="term"><code class="filename">var</code> (the usual location of
3221: <code class="filename">${VARBASE}</code>)</span></dt>
3222: <dd><p>Contains files
3223: that may be modified after
3224: installation.</p></dd>
3225: </dl></div>
3226: </div>
3227: <div class="sect1" lang="en">
3228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 3229: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code>
3230: </h2></div></div></div>
1.90 rillig 3231: <div class="variablelist"><dl>
3232: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3233: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3234: <dd><p>Contains
3235: information about the currently installed
3236: packages.</p></dd>
3237: <dt><span class="term"><code class="filename">games</code></span></dt>
3238: <dd><p>Contains highscore
3239: files.</p></dd>
3240: <dt><span class="term"><code class="filename">log</code></span></dt>
3241: <dd><p>Contains log files.</p></dd>
3242: <dt><span class="term"><code class="filename">run</code></span></dt>
3243: <dd><p>Contains informational files about daemons that are
3244: currently running.</p></dd>
3245: </dl></div>
3246: </div>
3247: </div>
3248: <div class="chapter" lang="en">
3249: <div class="titlepage"><div><div><h2 class="title">
3250: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3251: <div class="toc">
3252: <p><b>Table of Contents</b></p>
3253: <dl>
1.90 rillig 3254: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3255: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
3256: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
3257: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
3258: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
3259: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
3260: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
3261: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
3262: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
3263: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
3264: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 3265: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 3266: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
3267: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
3268: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
3269: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
3270: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3271: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
3272: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 3273: </dl>
3274: </div>
3275: <p>This section contains hints, tips & tricks on special things in
3276: pkgsrc that we didn't find a better place for in the previous chapters, and
3277: it contains items for both pkgsrc users and developers.</p>
3278: <div class="sect1" lang="en">
3279: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3280: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3281: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3282: <div class="itemizedlist"><ul type="disc">
1.78 rillig 3283: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
3284: This is a general purpose list for most issues regarding
3285: pkgsrc, regardless of platform, e.g. soliciting user help
3286: for pkgsrc configuration, unexpected build failures, using
3287: particular packages, upgrading pkgsrc installations,
3288: questions regarding the pkgsrc release branches, etc. General announcements or
3289: proposals for changes that impact the pkgsrc user community,
3290: e.g. major infrastructure changes, new features, package
3291: removals, etc., may also be posted.</p></li>
1.75 rillig 3292: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
3293: A list where the results of pkgsrc bulk builds are sent and
3294: discussed.</p></li>
3295: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
3296: This list is for those who are interested in getting a
3297: commit message for every change committed to pkgsrc. It is
3298: also available in digest form, meaning one daily message
3299: containing all commit messages for changes to the package
3300: source tree in that 24 hour period.</p></li>
3301: </ul></div>
3302: <p>To subscribe, do:</p>
3303: <pre class="programlisting">
1.100 rillig 3304: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 3305: </pre>
3306: <p>Archives for all these mailing lists are available from
3307: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3308: </div>
3309: <div class="sect1" lang="en">
3310: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3311: <a name="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3312: <p>Pkgviews is tightly integrated with buildlink. You can find a
3313: pkgviews User's guide in
1.76 rillig 3314: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3315: </div>
3316: <div class="sect1" lang="en">
3317: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3318: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3319: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3320: a number of useful utilities for both users and developers of pkgsrc. This
3321: section attempts only to make the reader aware of the utilities and when
3322: they might be useful, and not to duplicate the documentation that comes
3323: with each package.</p>
3324: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 rillig 3325: <div class="itemizedlist"><ul type="disc"><li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75 rillig 3326: Symlinks for use by buildlink.</p></li></ul></div>
3327: <p>OS tool augmentation (automatically installed when needed):</p>
3328: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3329: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75 rillig 3330: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 rillig 3331: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75 rillig 3332: Compatibility library for pkgsrc tools.</p></li>
1.91 rillig 3333: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87 wiz 3334: non-BSD systems due to lack of native mtree.</p></li>
1.91 rillig 3335: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75 rillig 3336: Up-to-date replacement for
1.76 rillig 3337: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3338: systems where pkg_install is not present.</p></li>
3339: </ul></div>
3340: <p>Utilities used by pkgsrc (not automatically installed):</p>
3341: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3342: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75 rillig 3343: Create a binary package from an
3344: already-installed package. Used by <span><strong class="command">make replace</strong></span> to
3345: save the old package.</p></li>
1.91 rillig 3346: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75 rillig 3347: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3348: from multiple locations. It currently supports the following
3349: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 rillig 3350: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a>: Put X11
1.75 rillig 3351: packages someplace else (enabled by default).</p></li>
1.91 rillig 3352: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine the
1.75 rillig 3353: best compiler flags to optimise code for your current CPU and
3354: compiler.</p></li>
3355: </ul></div>
3356: <p>Utilities for keeping track of installed packages, being up to date,
3357: etc:</p>
3358: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3359: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75 rillig 3360: packages whose installed versions do not match the latest pkgsrc
3361: entries.</p></li>
1.91 rillig 3362: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75 rillig 3363: dependency graphs of packages, to aid in choosing a strategy for
3364: updating.</p></li>
1.91 rillig 3365: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
3366: 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>
3367: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.75 rillig 3368: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3369: does various checks on the complete pkgsrc system.</p></li>
1.91 rillig 3370: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75 rillig 3371: packages you have installed.</p></li>
3372: </ul></div>
3373: <p>Utilities for people maintaining or creating individual packages:</p>
3374: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3375: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75 rillig 3376: making and maintaining patches for a package (includes pkgdiff,
3377: pkgvi, mkpatches, etc.).</p></li>
1.91 rillig 3378: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
3379: <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 3380: converting to pkgsrc.</p></li>
1.91 rillig 3381: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>: Convert
1.75 rillig 3382: pkgsrc to a Solaris package.</p></li>
3383: </ul></div>
3384: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3385: utilities)</p>
3386: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3387: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75 rillig 3388: packages in a chrooted area.</p></li>
1.91 rillig 3389: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75 rillig 3390: kernel version for chrooted cross builds.</p></li>
3391: </ul></div>
3392: </div>
3393: <div class="sect1" lang="en">
3394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3395: <a name="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3396: <p>If you want to use pkgsrc as non-root user, you can set some
3397: variables to make pkgsrc work under these conditions. At the very least,
3398: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3399: will turn on unprivileged mode and set multiple related variables to allow
3400: installation of packages as non-root.</p>
3401: <p>In case the defaults are not enough, you may want to tune some other
3402: variables used. For example, if the automatic user/group detection leads
3403: to incorrect values (or not the ones you would like to use), you can change
3404: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3405: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3406: <p>As regards bootstrapping, please note that the
3407: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
3408: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3409: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3410: installation targets. These directories can be overridden by the
1.75 rillig 3411: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3412: that allow finer tuning of the tree layout.</p>
3413: </div>
3414: <div class="sect1" lang="en">
3415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3416: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3417: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3418: enable this feature by adding the option
3419: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.76 rillig 3420: <code class="filename">/etc/mk.conf</code>. If, during a fetch step, an incomplete
1.75 rillig 3421: distfile is found, pkgsrc will try to resume it.</p>
3422: <p>You can also
3423: use a different program than the default <a 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
3424: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3425: <code class="varname">FETCH_RESUME_ARGS</code> and
3426: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3427: values.</p>
3428: <p>For example, if you want to use
1.76 rillig 3429: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75 rillig 3430: like:</p>
3431: <pre class="programlisting">
1.100 rillig 3432: FETCH_CMD= wget
3433: FETCH_BEFORE_ARGS= --passive-ftp
3434: FETCH_RESUME_ARGS= -c
3435: FETCH_OUTPUT_ARGS= -O
1.1 grant 3436: </pre>
1.75 rillig 3437: </div>
3438: <div class="sect1" lang="en">
3439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3440: <a name="XFree86-from-pkgsrc"></a>8.6. How can I install/use XFree86 from pkgsrc?</h2></div></div></div>
1.75 rillig 3441: <p>If you want to use XFree86 from pkgsrc instead of your system's own
1.76 rillig 3442: X11 (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>,
1.75 rillig 3443: ...), you will have to add the following line into
1.76 rillig 3444: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3445: <pre class="programlisting">
1.100 rillig 3446: X11_TYPE=XFree86
1.1 grant 3447: </pre>
1.75 rillig 3448: </div>
3449: <div class="sect1" lang="en">
3450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3451: <a name="x.org-from-pkgsrc"></a>8.7. How can I install/use X.org from pkgsrc?</h2></div></div></div>
1.75 rillig 3452: <p>If you want to use X.org from pkgsrc instead of your system's own X11
1.76 rillig 3453: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3454: you will have to add the following line into
1.76 rillig 3455: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3456: <pre class="programlisting">
1.100 rillig 3457: X11_TYPE=xorg
1.1 grant 3458: </pre>
1.75 rillig 3459: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3460: <h3 class="title">Note</h3>
3461: <p>The DragonFly operating system defaults to using
1.87 wiz 3462: this X.org X11 implementation from pkgsrc.</p>
1.75 rillig 3463: </div>
3464: </div>
3465: <div class="sect1" lang="en">
3466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3467: <a name="fetch-behind-firewall"></a>8.8. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3468: <p>If you are sitting behind a firewall which does not allow direct
3469: connections to Internet hosts (i.e. non-NAT), you may specify the
3470: relevant proxy hosts. This is done using an environment variable in the
3471: form of a URL, e.g. in Amdahl, the machine
3472: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3473: port 80 as the proxy port number. So the proxy environment variables
3474: are:</p>
3475: <pre class="programlisting">
1.100 rillig 3476: ftp_proxy=ftp://orpheus.amdahl.com:80/
3477: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3478: </pre>
1.75 rillig 3479: </div>
3480: <div class="sect1" lang="en">
3481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3482: <a name="passive-ftp"></a>8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 3483: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3484: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3485: the first available command from the following list:</p>
3486: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3487: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3488: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3489: </ul></div>
3490: <p>On a default NetBSD installation, this will be
1.76 rillig 3491: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3492: connections first, and falls back to active connections if the server
3493: refuses to do passive. For the other tools, add the following to your
1.76 rillig 3494: <code class="filename">/etc/mk.conf</code> file:
1.75 rillig 3495: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3496: <p>Having that option present will prevent
1.76 rillig 3497: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3498: transfers.</p>
3499: </div>
3500: <div class="sect1" lang="en">
3501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3502: <a name="fetching-all-distfiles"></a>8.10. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3503: <p>You would like to download all the distfiles in a single batch
3504: from work or university, where you can't run a <span><strong class="command">make
3505: fetch</strong></span>. There is an archive of distfiles on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75 rillig 3506: but downloading the entire directory may not be appropriate.</p>
3507: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76 rillig 3508: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3509: resulting list to your machine at work/school and use it there. If you
3510: don't have a NetBSD-compatible <a 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
3511: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3512: URL:</p>
3513: <p>At home:</p>
3514: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3515: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3516: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3517: <p>At work:</p>
3518: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3519: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3520: home.</p>
3521: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3522: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3523: machine architecture), you can do so by using the above-mentioned
3524: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
3525: directly by running:</p>
1.75 rillig 3526: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3527: <p>If you even decide to ignore
3528: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3529: by running:</p>
3530: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3531: </div>
3532: <div class="sect1" lang="en">
3533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3534: <a name="tmac.andoc-missing"></a>8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 3535: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 rillig 3536: <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 3537: package, you get the error from make that it doesn't know how to make
1.76 rillig 3538: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3539: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3540: the NetBSD base distribution on your machine. It is recommended to do
3541: that to format man pages.</p>
1.91 rillig 3542: <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 3543: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.76 rillig 3544: environment or in <code class="filename">/etc/mk.conf</code>.</p>
1.75 rillig 3545: </div>
3546: <div class="sect1" lang="en">
3547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3548: <a name="bsd.own.mk-missing"></a>8.12. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</h2></div></div></div>
1.87 wiz 3549: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3550: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3551: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3552: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3553: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3554: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.75 rillig 3555: the one that corresponds to your release (determine via <span><strong class="command">uname
3556: -r</strong></span>).</p>
3557: </div>
3558: <div class="sect1" lang="en">
3559: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3560: <a name="using-sudo-with-pkgsrc"></a>8.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3561: <p>When installing packages as non-root user and using the just-in-time
3562: <a 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
3563: password for each required package installed. To avoid this, the sudo
3564: package can be used, which does password caching over a limited time. To
3565: use it, install sudo (either as binary package or from
1.98 wiz 3566: <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
3567: following into your <code class="filename">/etc/mk.conf</code>, somewhere
3568: <span class="emphasis"><em>after</em></span> the definition of the
3569: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3570: <pre class="programlisting">
1.100 rillig 3571: .if exists(${LOCALBASE}/bin/sudo)
3572: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3573: .endif
1.1 grant 3574: </pre>
1.75 rillig 3575: </div>
3576: <div class="sect1" lang="en">
3577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3578: <a name="faq.conf"></a>8.14. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3579: <p>As the system administrator, you can choose where configuration files
3580: are installed. The default settings make all these files go into
1.76 rillig 3581: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3582: be suboptimal depending on your expectations (e.g., a read-only,
3583: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3584: configuration of the provided packages).</p>
3585: <p>In order to change the defaults, you can modify the
3586: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.76 rillig 3587: <code class="filename">/etc/mk.conf</code>) to point to your preferred configuration
3588: directory; some common examples include <code class="filename">/etc</code> or
3589: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3590: <p>Furthermore, you can change this value on a per-package basis by
3591: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3592: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3593: package you would like to modify, that is, the contents of
3594: <code class="varname">PKGBASE</code>.</p>
3595: <p>Note that after changing these settings, you must rebuild and
3596: reinstall any affected packages.</p>
3597: </div>
3598: <div class="sect1" lang="en">
3599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3600: <a name="audit-packages"></a>8.15. Automated security checks</h2></div></div></div>
1.75 rillig 3601: <p>Please be aware that there can often be bugs in third-party software,
3602: and some of these bugs can leave a machine vulnerable to exploitation by
3603: attackers. In an effort to lessen the exposure, the NetBSD packages team
3604: maintains a database of known-exploits to packages which have at one time
3605: been included in pkgsrc. The database can be downloaded automatically, and
3606: a security audit of all packages installed on a system can take place. To
1.91 rillig 3607: do this, install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> package. It has two
1.75 rillig 3608: components:</p>
3609: <div class="orderedlist"><ol type="1">
3610: <li>
3611: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
3612: download a list of the security vulnerabilities information. This list
3613: is kept up to date by the NetBSD security officer and the NetBSD
3614: packages team, and is distributed from the NetBSD ftp server:</p>
3615: <p><a 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>
3616: </li>
3617: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
3618: current machine, checking each vulnerability which is known. If a
3619: vulnerable package is installed, it will be shown by output to stdout,
3620: including a description of the type of vulnerability, and a URL
3621: containing more information.</p></li>
3622: </ol></div>
1.91 rillig 3623: <p>Use of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>
1.75 rillig 3624: package is strongly recommended! After
3625: “<span class="quote">audit-packages</span>” is installed, please read
3626: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3627: audit-packages</code></strong>.</p>
1.87 wiz 3628: <p>If this package is installed, pkgsrc builds will use it to
3629: perform a security check before building any package. See <a 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
3630: check.</p>
1.75 rillig 3631: </div>
3632: <div class="sect1" lang="en">
3633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3634: <a name="ufaq-cflags"></a>8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3635: <p>When you add your own preferences to the
3636: <code class="varname">CFLAGS</code> variable in your
1.76 rillig 3637: <code class="filename">mk.conf</code>, these flags are passed in
3638: environment variables to the <code class="filename">./configure</code>
1.75 rillig 3639: scripts and to <a 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
3640: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3641: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3642: package.</p>
3643: <p>Currently there is no solution to this problem. If you
3644: really need the package to use your <code class="varname">CFLAGS</code>
3645: you should run <span><strong class="command">make patch</strong></span> in the package
1.76 rillig 3646: directory and then inspect any <code class="filename">Makefile</code> and
3647: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3648: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3649: these lines. But be aware that some “<span class="quote">smart</span>”
3650: programmers write so bad code that it only works for the
3651: specific combination of <code class="varname">CFLAGS</code> they have
3652: chosen.</p>
3653: </div>
1.80 rillig 3654: <div class="sect1" lang="en">
3655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3656: <a name="ufaq-fail"></a>8.17. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3657: <div class="procedure"><ol type="1">
3658: <li><p>Make sure that your copy of pkgsrc is consistent. A
3659: case that occurs often is that people only update pkgsrc in
3660: parts, because of performance reasons. Since pkgsrc is one large
3661: system, not a collection of many small systems, there are
3662: sometimes changes that only work when the whole pkgsrc tree is
3663: updated.</p></li>
3664: <li><p>Make sure that you don't have any CVS conflicts.
3665: Search for “<span class="quote"><<<<<<</span>” or
3666: “<span class="quote">>>>>>></span>” in all your pkgsrc
3667: files.</p></li>
3668: <li><p>Make sure that you don't have old copies of the packages
3669: extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
3670: verify this.</p></li>
3671: <li><p>If the problem still exists, write a mail to the
3672: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3673: </ol></div>
3674: </div>
1.88 wiz 3675: <div class="sect1" lang="en">
3676: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3677: <a name="faq.rcs-conflicts"></a>8.18. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</h2></div></div></div>
1.89 rillig 3678: <p>You have modified a file from pkgsrc, and someone else has
3679: modified that same file afterwards in the CVS repository. Both changes
3680: are in the same region of the file, so when you updated pkgsrc, the
3681: <code class="literal">cvs</code> command marked the conflicting changes in the
3682: file. Because of these markers, the file is no longer a valid
3683: <code class="filename">Makefile</code>.</p>
3684: <p>Have a look at that file, and if you don't need your local changes
3685: anymore, you can remove that file and run <span><strong class="command">cvs -q update
3686: -dP</strong></span> in that directory to download the current version.</p>
3687: </div>
1.75 rillig 3688: </div>
3689: </div>
3690: <div class="part" lang="en">
3691: <div class="titlepage"><div><div><h1 class="title">
3692: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3693: <div class="partintro" lang="en">
3694: <div></div>
3695: <p>This part of the book deals with creating and
3696: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3697: guide on creating a new package. The remaining chapters are more
3698: like a reference manual for pkgsrc.</p>
1.75 rillig 3699: <div class="toc">
3700: <p><b>Table of Contents</b></p>
3701: <dl>
1.90 rillig 3702: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3703: <dd><dl>
3704: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3705: <dd><dl>
3706: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3707: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3708: </dl></dd>
3709: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3710: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
3711: </dl></dd>
1.90 rillig 3712: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 3713: <dd><dl>
1.90 rillig 3714: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
3715: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
3716: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
3717: <dd><dl>
1.93 rillig 3718: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
3719: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
3720: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
3721: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
3722: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 3723: </dl></dd>
3724: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
3725: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
3726: <dd><dl>
3727: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
3728: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
3729: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
3730: </dl></dd>
3731: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
3732: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
3733: </dl></dd>
3734: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3735: <dd><dl>
1.97 rillig 3736: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
3737: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
3738: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
3739: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
3740: <dd><dl>
3741: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
3742: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
3743: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
3744: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
3745: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90 rillig 3746: </dl></dd>
3747: </dl></dd>
3748: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
3749: <dd><dl>
3750: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
3751: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3752: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
3753: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
3754: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
3755: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3756: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
3757: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
3758: </dl></dd>
3759: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
3760: <dd><dl>
3761: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
3762: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3763: <dd><dl>
3764: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3765: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.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>
3766: </dl></dd>
3767: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3768: <dd><dl>
3769: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
3770: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3771: </dl></dd>
3772: </dl></dd>
3773: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
3774: <dd><dl>
3775: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
3776: <dd><dl>
3777: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
3778: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
3779: </dl></dd>
3780: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
3781: <dd><dl>
3782: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3783: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
3784: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
3785: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
3786: </dl></dd>
3787: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
3788: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3789: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
3790: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
3791: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
3792: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
3793: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
3794: </dl></dd>
3795: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
3796: <dd><dl>
3797: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
3798: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
3799: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
3800: </dl></dd>
3801: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
3802: <dd><dl>
3803: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
3804: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
3805: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
3806: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
3807: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3808: <dd><dl>
3809: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
3810: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
3811: </dl></dd>
3812: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3813: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3814: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3815: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3816: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3817: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3818: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3819: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3820: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3821: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3822: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
3823: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
3824: </dl></dd>
3825: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
3826: <dd><dl>
3827: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3828: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3829: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 3830: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90 rillig 3831: </dl></dd>
3832: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
3833: <dd><dl>
3834: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
3835: <dd><dl>
3836: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
3837: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
3838: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
3839: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
3840: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
3841: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
3842: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
3843: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
3844: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
3845: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
3846: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3847: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3848: </dl></dd>
3849: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3850: <dd><dl>
3851: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3852: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
3853: </dl></dd>
3854: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3855: <dd><dl>
3856: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
3857: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3858: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
3859: </dl></dd>
3860: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
3861: <dd><dl>
3862: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
3863: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
3864: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
3865: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
3866: </dl></dd>
3867: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3868: <dd><dl>
3869: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
3870: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
3871: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3872: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
3873: </dl></dd>
3874: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3875: <dd><dl>
3876: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
3877: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100 rillig 3878: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.90 rillig 3879: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
3880: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
3881: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
3882: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
3883: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
3884: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
3885: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
3886: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
3887: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
3888: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
3889: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
3890: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
3891: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
3892: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 3893: emulation</a></span></dt>
1.90 rillig 3894: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
3895: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77 rillig 3896: </dl></dd>
1.90 rillig 3897: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3898: </dl></dd>
1.90 rillig 3899: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
3900: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 3901: <dd><dl>
1.90 rillig 3902: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
3903: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3904: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
3905: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
3906: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
3907: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
3908: </dl></dd>
3909: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
3910: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3911: <dd><dl>
3912: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3913: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3914: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3915: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 3916: </dl></dd>
1.75 rillig 3917: </dl>
3918: </div>
1.77 rillig 3919: </div>
3920: <div class="chapter" lang="en">
3921: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3922: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3923: <div class="toc">
3924: <p><b>Table of Contents</b></p>
3925: <dl>
3926: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3927: <dd><dl>
3928: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3929: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3930: </dl></dd>
3931: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3932: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
3933: </dl>
3934: </div>
1.77 rillig 3935: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3936: most likely have a URL from where you can download the source
3937: code. Starting with this URL, creating a package involves only a
3938: few steps.</p>
1.77 rillig 3939: <div class="procedure"><ol type="1">
1.91 rillig 3940: <li><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.77 rillig 3941: <li><p>Then, choose one of the top-level directories as the
1.91 rillig 3942: category in which you want to place your package. You can also create a
3943: directory of your own (maybe called <code class="filename">local</code>). In that
3944: category directory, create another directory for your package and change
3945: into it.</p></li>
3946: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
3947: you for a URL. Enter the URL of the distribution file (in most cases a
3948: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3949: of your package are created automatically. The distribution file is
3950: extracted automatically to fill in some details in the
3951: <code class="filename">Makefile</code> that would otherwise have to be done
3952: manually.</p></li>
3953: <li>
3954: <p>Examine the extracted files to determine the dependencies of
3955: your package. Ideally, this is mentioned in some
3956: <code class="filename">README</code> file, but things may differ. For each of
3957: these dependencies, look where it exists in pkgsrc, and if there is a
3958: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3959: line to your package <code class="filename">Makefile</code> which includes that
3960: file just before the last line. If the
3961: <code class="filename">buildlink3.mk</code> file does not exist, add a
3962: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3963: version of the dependency and where it can be found in pkgsrc. This line
3964: should be placed in the third paragraph. If the dependency is only
3965: needed for building the package, but not when using it, use
3966: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3967: Your package may then look like this:</p>
1.77 rillig 3968: <pre class="programlisting">
1.100 rillig 3969: [...]
1.77 rillig 3970:
1.100 rillig 3971: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3972: DEPENDS+= screen-[0-9]*:../../misc/screen
3973: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3974:
1.100 rillig 3975: [...]
1.77 rillig 3976:
1.100 rillig 3977: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3978: .include "../../devel/glib2/buildlink3.mk"
3979: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3980: </pre>
3981: </li>
1.91 rillig 3982: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
3983: to be done to make your package a “<span class="quote">good</span>” one. If you don't
3984: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
3985: --explain</strong></span> or <span><strong class="command">pkglint
3986: -e</strong></span>, which outputs additional
3987: explanations.</p></li>
3988: <li><p>In many cases the package is not yet ready to build. You can
3989: find instructions for the most common cases in the next section, <a href="#creating.common" title="9.1. Common types of packages">Section 9.1, “Common types of packages”</a>. After you have followed the instructions
3990: over there, you can hopefully continue here.</p></li>
3991: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
3992: directory from the extracted files. Besides these files, a lot of cache
3993: files and other system information has been saved in the working
3994: directory, which may become wrong after you edited the
3995: <code class="filename">Makefile</code>.</p></li>
3996: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
3997: the various things that can go wrong in this phase, consult <a href="#fixes" title="Chapter 18. Making your package work">Chapter 18, <i>Making your package work</i></a>.</p></li>
3998: <li><p>When the package builds fine, the next step is to install
3999: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
4000: everything works.</p></li>
4001: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
4002: contains a list of the files that are installed by the package, is
4003: nearly empty. Run <span><strong class="command">bmake print-PLIST
4004: >PLIST</strong></span> to generate a probably correct list. Check
4005: the file using your preferred text editor to see if the list of
4006: files looks plausible.</p></li>
4007: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
4008: <code class="filename">PLIST</code> contains garbage or not.</p></li>
4009: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
4010: has been registered in the database of installed files, but with an
4011: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
4012: and <span><strong class="command">bmake install</strong></span> again. Now the package is
4013: registered with the list of files from
4014: <code class="filename">PLIST</code>.</p></li>
4015: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
4016: package from the set of installed files.</p></li>
1.77 rillig 4017: </ol></div>
1.91 rillig 4018: <div class="sect1" lang="en">
4019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4020: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
4021: <div class="sect2" lang="en">
4022: <div class="titlepage"><div><div><h3 class="title">
4023: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
4024: <p>Simple Perl modules are handled automatically by
4025: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
4026: </div>
4027: <div class="sect2" lang="en">
4028: <div class="titlepage"><div><div><h3 class="title">
4029: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
4030: <p>KDE applications should always include
4031: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
4032: settings that are typical of KDE packages.</p>
4033: </div>
4034: </div>
4035: <div class="sect1" lang="en">
4036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4037: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
4038: <div class="sect2" lang="en">
4039: <div class="titlepage"><div><div><h3 class="title">
4040: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
4041: <div class="sect3" lang="en">
4042: <div class="titlepage"><div><div><h4 class="title">
4043: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
4044: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4045: that the “<span class="quote">nvu</span>” package has not yet been imported into
4046: pkgsrc. As the description says it has to do with the web, the obvious
4047: choice for the category is “<span class="quote">www</span>”.</p>
4048: <pre class="programlisting">
1.100 rillig 4049: <code class="prompt">$</code> mkdir www/nvu
4050: <code class="prompt">$</code> cd www/nvu
1.91 rillig 4051: </pre>
4052: <p>The web site says that the sources are available as a tar file, so
4053: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
4054: <pre class="programlisting">
1.100 rillig 4055: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 4056: </pre>
4057: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4058: below the <code class="varname">DISTNAME</code> line, as the package name should
4059: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4060: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4061: <code class="varname">COMMENT</code> fields. Then the package
4062: <code class="filename">Makefile</code> looked like that:</p>
4063: <pre class="programlisting">
1.100 rillig 4064: # $NetBSD$
4065: #
1.91 rillig 4066:
1.100 rillig 4067: DISTNAME= nvu-1.0-sources
4068: PKGNAME= nvu-1.0
4069: CATEGORIES= www
4070: MASTER_SITES= http://cvs.nvu.com/download/
4071: EXTRACT_SUFX= .tar.bz2
4072:
4073: MAINTAINER= rillig@NetBSD.org
4074: HOMEPAGE= http://cvs.nvu.com/
4075: COMMENT= Web Authoring System
1.91 rillig 4076:
1.100 rillig 4077: # url2pkg-marker (please do not remove this line.)
4078: .include "../../mk/bsd.pkg.mk"
1.91 rillig 4079: </pre>
4080: <p>Then, I quit the editor and watched pkgsrc downloading a large
4081: source archive:</p>
4082: <pre class="programlisting">
1.100 rillig 4083: url2pkg> Running "make makesum" ...
4084: => Required installed package digest>=20010302: digest-20060826 found
4085: => Fetching nvu-1.0-sources.tar.bz2
4086: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4087: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4088: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4089: url2pkg> Running "make extract" ...
4090: => Required installed package digest>=20010302: digest-20060826 found
4091: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4092: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4093: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4094: ===> Installing dependencies for nvu-1.0
4095: ===> Overriding tools for nvu-1.0
4096: ===> Extracting for nvu-1.0
4097: url2pkg> Adjusting the Makefile.
1.91 rillig 4098:
1.100 rillig 4099: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 4100:
1.100 rillig 4101: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 4102: </pre>
4103: </div>
4104: <div class="sect3" lang="en">
4105: <div class="titlepage"><div><div><h4 class="title">
4106: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
4107: <p>Now that the package has been extracted, let's see what's inside
4108: it. The package has a <code class="filename">README.txt</code>, but that only
4109: says something about mozilla, so it's probably useless for seeing what
4110: dependencies this package has. But since there is a GNU configure script
4111: in the package, let's hope that it will complain about everything it
4112: needs.</p>
4113: <pre class="programlisting">
1.100 rillig 4114: <code class="prompt">$</code> bmake
4115: => Required installed package digest>=20010302: digest-20060826 found
4116: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4117: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4118: ===> Patching for nvu-1.0
4119: ===> Creating toolchain wrappers for nvu-1.0
4120: ===> Configuring for nvu-1.0
4121: [...]
4122: configure: error: Perl 5.004 or higher is required.
4123: [...]
4124: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4125: [...]
1.91 rillig 4126: </pre>
4127: <p>That worked quite well. So I opened the package Makefile in my
4128: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4129: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4130: package have changed now, and since a perl wrapper is automatically
4131: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4132: from scratch.</p>
4133: <pre class="programlisting">
1.100 rillig 4134: <code class="prompt">$</code> bmake clean
4135: ===> Cleaning for nvu-1.0
4136: <code class="prompt">$</code> bmake
4137: [...]
4138: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4139: GNU Make. You will not be able to build Mozilla without GNU Make.
4140: [...]
1.91 rillig 4141: </pre>
4142: <p>So I added “<span class="quote">gmake</span>” to the
4143: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4144: <pre class="programlisting">
1.100 rillig 4145: [...]
4146: checking for GTK - version >= 1.2.0... no
4147: *** Could not run GTK test program, checking why...
4148: [...]
1.91 rillig 4149: </pre>
4150: <p>Now to the other dependencies. The first question is: Where is the
4151: GTK package hidden in pkgsrc?</p>
4152: <pre class="programlisting">
1.100 rillig 4153: <code class="prompt">$</code> echo ../../*/gtk*
4154: [many packages ...]
4155: <code class="prompt">$</code> echo ../../*/gtk
4156: ../../x11/gtk
4157: <code class="prompt">$</code> echo ../../*/gtk2
4158: ../../x11/gtk2
4159: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4160: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4161: </pre>
4162: <p>The first try was definitely too broad. The second one had exactly
4163: one result, which is very good. But there is one pitfall with GNOME
4164: packages. Before GNOME 2 had been released, there were already many
4165: GNOME 1 packages in pkgsrc. To be able to continue to use these
4166: packages, the GNOME 2 packages were imported as separate packages, and
4167: their names usually have a “<span class="quote">2</span>” appended. So I checked
4168: whether this was the case here, and indeed it was.</p>
4169: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4170: file, adding the dependency is very easy. I just inserted an
4171: <code class="literal">.include</code> line before the last line of the package
4172: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4173: <pre class="programlisting">
1.100 rillig 4174: [...]
4175: .include "../../x11/gtk2/buildlink3.mk"
4176: .include "../../mk/bsd.pkg.mk
1.91 rillig 4177: </pre>
4178: <p>After another <span><strong class="command">bmake clean && bmake</strong></span>, the answer
4179: was:</p>
4180: <pre class="programlisting">
1.100 rillig 4181: [...]
4182: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4183: checking for GTK - version >= 1.2.0... no
4184: *** Could not run GTK test program, checking why...
4185: *** The test program failed to compile or link. See the file config.log for the
4186: *** exact error that occured. This usually means GTK was incorrectly installed
4187: *** or that you have moved GTK since it was installed. In the latter case, you
4188: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4189: configure: error: Test for GTK failed.
4190: [...]
1.91 rillig 4191: </pre>
4192: <p>In this particular case, the assumption that “<span class="quote">every package
4193: prefers GNOME 2</span>” had been wrong. The first of the lines above
4194: told me that this package really wanted to have the GNOME 1 version of
4195: GTK. If the package had looked for GTK2, it would have looked for
4196: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
4197: So I changed the <code class="literal">x11/gtk2</code> to
4198: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4199: and tried again.</p>
4200: <pre class="programlisting">
1.100 rillig 4201: [...]
4202: 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
4203: In file included from xpidl.c:42:
4204: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4205: In file included from xpidl.c:42:
4206: xpidl.h:132: error: parse error before "IDL_ns"
4207: [...]
1.91 rillig 4208: </pre>
4209: <p>The package still does not find all of its dependencies. Now the
4210: question is: Which package provides the
4211: <code class="filename">libIDL/IDL.h</code> header file?</p>
4212: <pre class="programlisting">
1.100 rillig 4213: <code class="prompt">$</code> echo ../../*/*idl*
4214: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4215: <code class="prompt">$</code> echo ../../*/*IDL*
4216: ../../net/libIDL
1.91 rillig 4217: </pre>
4218: <p>Let's take the one from the second try. So I included the
4219: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4220: again. But the error didn't change. After digging through some of the
4221: code, I concluded that the build process of the package was broken and
4222: couldn't have ever worked, but since the Mozilla source tree is quite
4223: large, I didn't want to fix it. So I added the following to the package
4224: <code class="filename">Makefile</code> and tried again:</p>
4225: <pre class="programlisting">
1.100 rillig 4226: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4227: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4228: </pre>
4229: <p>The latter line is needed because the package expects the library
4230: <code class="filename">libIDL.so</code>, but only
4231: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4232: wrapper to rewrite that on the fly.</p>
4233: <p>The next problem was related to a recent change of the FreeType
4234: 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>
4235: which patch files were relevant for this issue and copied them to the
4236: <code class="filename">patches</code> directory. Then I retried, fixed the
4237: patches so that they applied cleanly and retried again. This time,
4238: everything worked.</p>
4239: </div>
4240: <div class="sect3" lang="en">
4241: <div class="titlepage"><div><div><h4 class="title">
4242: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
4243: <pre class="programlisting">
1.100 rillig 4244: <code class="prompt">$</code> bmake CHECK_FILES=no install
4245: [...]
4246: <code class="prompt">$</code> bmake print-PLIST >PLIST
4247: <code class="prompt">$</code> bmake deinstall
4248: <code class="prompt">$</code> bmake install
1.91 rillig 4249: </pre>
4250: </div>
4251: </div>
4252: </div>
1.77 rillig 4253: </div>
1.75 rillig 4254: <div class="chapter" lang="en">
4255: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4256: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4257: <div class="toc">
4258: <p><b>Table of Contents</b></p>
4259: <dl>
1.90 rillig 4260: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
4261: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
4262: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
4263: <dd><dl>
1.93 rillig 4264: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
4265: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
4266: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
4267: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
4268: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 4269: </dl></dd>
4270: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
4271: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
4272: <dd><dl>
4273: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
4274: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
4275: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4276: </dl></dd>
1.90 rillig 4277: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
4278: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4279: </dl>
4280: </div>
1.87 wiz 4281: <p>Whenever you're preparing a package, there are a number of
4282: files involved which are described in the following
4283: sections.</p>
1.75 rillig 4284: <div class="sect1" lang="en">
4285: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4286: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code>
4287: </h2></div></div></div>
1.75 rillig 4288: <p>Building, installation and creation of a binary package are all
1.87 wiz 4289: controlled by the package's <code class="filename">Makefile</code>.
4290: The <code class="filename">Makefile</code> describes various things about
4291: a package, for example from where to get it, how to configure,
4292: build, and install it.</p>
1.76 rillig 4293: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4294: sections that describe the package.</p>
1.75 rillig 4295: <p>In the first section there are the following variables, which
1.87 wiz 4296: should appear exactly in the order given here. The order and
4297: grouping of the variables is mostly historical and has no further
4298: meaning.</p>
1.75 rillig 4299: <div class="itemizedlist"><ul type="disc">
4300: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4301: distribution file to be downloaded from the package's
4302: website.</p></li>
1.75 rillig 4303: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4304: package, as used by pkgsrc. You only need to provide it if
4305: <code class="varname">DISTNAME</code> (which is the default) is not a good
4306: name for the package in pkgsrc. Usually it is the pkgsrc
4307: directory name together with the version number. It must match the
4308: regular expression
4309: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4310: starts with a letter or digit, and contains only letters, digits,
4311: dashes, underscores, dots and plus signs.</p></li>
4312: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4313: the package file to create if the <code class="varname">PKGNAME</code>
4314: isn't unique on a SVR4 system. The default is
4315: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4316: <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 4317: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4318: does not produce an unique package name on a SVR4 system.
4319: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4320: characters.</p></li>
1.75 rillig 4321: <li>
4322: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4323: which the package fits in. You can choose any of the top-level
4324: directories of pkgsrc for it.</p>
1.75 rillig 4325: <p>Currently the following values are available for
1.87 wiz 4326: <code class="varname">CATEGORIES</code>. If more than
4327: one is used, they need to be separated by spaces:</p>
1.75 rillig 4328: <pre class="programlisting">
1.100 rillig 4329: archivers cross geography meta-pkgs security
4330: audio databases graphics misc shells
4331: benchmarks devel ham multimedia sysutils
4332: biology editors inputmethod net textproc
4333: cad emulators lang news time
4334: chat finance mail parallel wm
4335: comms fonts math pkgtools www
4336: converters games mbone print x11
4337: </pre>
1.75 rillig 4338: </li>
1.81 rillig 4339: <li><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4340: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4341: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4342: and <code class="varname">DISTFILES</code> are discussed in detail in
1.90 rillig 4343: <a href="#build.fetch" title="16.5. The fetch phase">Section 16.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.75 rillig 4344: </ul></div>
4345: <p>The second section contains information about separately
1.87 wiz 4346: downloaded patches, if any.
4347: </p>
1.75 rillig 4348: <div class="itemizedlist"><ul type="disc">
4349: <li><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4350: Name(s) of additional files that contain distribution patches.
4351: There is no default. pkgsrc will look for them at
4352: <code class="varname">PATCH_SITES</code>.
4353: They will automatically be uncompressed before patching if
4354: the names end with <code class="filename">.gz</code> or
4355: <code class="filename">.Z</code>.</p></li>
1.75 rillig 4356: <li><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4357: Primary location(s) for distribution patch files (see
4358: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4359: </ul></div>
4360: <p>The third section contains the following variables.
1.87 wiz 4361: </p>
1.75 rillig 4362: <div class="itemizedlist"><ul type="disc">
4363: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87 wiz 4364: of the person who feels responsible for this package, and who is
4365: most likely to look at problems or questions regarding this
4366: package which have been reported with <a href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>. Other
4367: developers should contact the <code class="varname">MAINTAINER</code> before
4368: making major changes to the package. When packaging a new program,
4369: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4370: maintain the package for future updates, set it to
4371: <code class="email"><<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.75 rillig 4372: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4373: find more information about the package.</p></li>
1.75 rillig 4374: <li><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4375: description of the package (should not include the package
4376: name).</p></li>
1.75 rillig 4377: </ul></div>
4378: <p>Other variables that affect the build:
1.87 wiz 4379: </p>
1.75 rillig 4380: <div class="itemizedlist"><ul type="disc"><li>
4381: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4382: interesting distribution files of the package are found. The
4383: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4384: works for most packages.</p>
1.75 rillig 4385: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4386: (most GNU software does, for instance), but extracts itself in
4387: the current directory, you should set
4388: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4389: <p>If a package doesn't create a subdirectory with the
4390: name of <code class="varname">DISTNAME</code> but some different name,
4391: set <code class="varname">WRKSRC</code> to point to the proper name in
4392: <code class="filename">${WRKDIR}</code>, for example
4393: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4394: <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 4395: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4396: taken from the <code class="varname">WRKDIR_BASENAME</code>
4397: variable. By default, its value is
4398: <code class="filename">work</code>. If you want to use the same
4399: pkgsrc tree for building different kinds of binary packages,
4400: you can change the variable according to your needs. Two
4401: other variables handle common cases of setting
4402: <code class="varname">WRKDIR_BASENAME</code> individually. If
4403: <code class="varname">OBJHOSTNAME</code> is defined in
4404: <code class="filename">/etc/mk.conf</code>, the first component of
4405: the host's name is attached to the directory name. If
4406: <code class="varname">OBJMACHINE</code> is defined, the platform name
4407: is attached, which might look like
4408: <code class="filename">work.i386</code> or
4409: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4410: </li></ul></div>
4411: <p>Please pay attention to the following gotchas:</p>
4412: <div class="itemizedlist"><ul type="disc">
1.87 wiz 4413: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4414: installed in compressed form by the package. For packages using
4415: BSD-style makefiles which honor MANZ, there is
4416: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76 rillig 4417: <li><p>Replace <code class="filename">/usr/local</code> with
1.88 wiz 4418: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4419: below).</p></li>
1.90 rillig 4420: <li><p>If the package installs any info files, see <a href="#faq.info-files" title="18.6.6. Packages installing info files">Section 18.6.6, “Packages installing info files”</a>.</p></li>
1.75 rillig 4421: </ul></div>
4422: </div>
4423: <div class="sect1" lang="en">
4424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4425: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code>
4426: </h2></div></div></div>
1.76 rillig 4427: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4428: digest, or checksum, of each distfile needed for the package. This
4429: ensures that the distfiles retrieved from the Internet have not been
4430: corrupted during transfer or altered by a malign force to introduce
4431: a security hole. Due to recent rumor about weaknesses of digest
4432: algorithms, all distfiles are protected using both SHA1 and RMD160
4433: message digests, as well as the file size.</p>
1.76 rillig 4434: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4435: checksums for all the patches found in the
1.90 rillig 4436: <code class="filename">patches</code> directory (see <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a>).</p>
1.76 rillig 4437: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87 wiz 4438: <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
4439: command.</p>
1.75 rillig 4440: <p>Some packages have different sets of distfiles depending on
1.91 rillig 4441: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/navigator/README.html" target="_top"><code class="filename">www/navigator</code></a>). These are kept in the same
1.87 wiz 4442: <code class="filename">distinfo</code> file and care should be taken when
4443: upgrading such a package to ensure distfile information is not
4444: lost.</p>
1.75 rillig 4445: </div>
4446: <div class="sect1" lang="en">
4447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4448: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.93 rillig 4449: <p>Many packages still don't work out-of-the box on the various
4450: platforms that are supported by pkgsrc. Therefore, a number of custom
4451: patch files are needed to make the package work. These patch files are
4452: found in the <code class="filename">patches/</code> directory.</p>
4453: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4454: applied to the files in <code class="varname">WRKSRC</code> directory after
4455: extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
4456: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4457: <code class="filename">patch-ab</code>, etc.</p>
1.93 rillig 4458: <div class="sect2" lang="en">
4459: <div class="titlepage"><div><div><h3 class="title">
4460: <a name="components.patch.structure"></a>10.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4461: <p>The <code class="filename">patch-*</code> files should be in
1.87 wiz 4462: <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4463: problems. (To force patches to apply with fuzz you can set
4464: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4465: should contain only changes for a single file, and no file should be
1.93 rillig 4466: patched by more than one patch file. This helps to keep future
4467: modifications simple.</p>
4468: <p>Each patch file is structured as follows: In the first line,
4469: there is the RCS Id of the patch itself. The second line should be
4470: empty for aesthetic reasons. After that, there should be a comment for
4471: each change that the patch does. There are a number of standard
4472: cases:</p>
4473: <div class="itemizedlist"><ul type="disc">
4474: <li><p>Patches that replace the <code class="literal">==</code>
4475: operator for <a 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
4476: should contain a reference to , to avoid
4477: redundant explanations.</p></li>
4478: <li><p>Patches for commonly known vulnerabilities should
4479: mention the vulnerability ID (CAN, CVE).</p></li>
4480: <li><p>Patches that change source code should mention the
4481: platform and other environment (for example, the compiler) that the
4482: patch is needed for.</p></li>
4483: </ul></div>
4484: <p>In all other cases, the patch should be commented so that any
4485: developer who knows the code of the application can make some use of
4486: the patch. Special care should be taken for the upstream developers,
4487: since we generally want that they accept our patches, so we have less
4488: work in the future.</p>
4489: </div>
4490: <div class="sect2" lang="en">
4491: <div class="titlepage"><div><div><h3 class="title">
4492: <a name="components.patches.caveats"></a>10.3.2. Creating patch files</h3></div></div></div>
4493: <p>One important thing to mention is to pay attention that no RCS
4494: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4495: later checked into the NetBSD CVS tree. Use the
1.93 rillig 4496: <span><strong class="command">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
4497: problems.</p>
1.87 wiz 4498: <p>For even more automation, we recommend using
4499: <span><strong class="command">mkpatches</strong></span> from the same package to make a
4500: whole set of patches. You just have to backup files before you
4501: edit them to <code class="filename">filename.orig</code>, e.g. with
4502: <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
4503: using <span><strong class="command">pkgvi</strong></span> again from the same package. If
4504: you upgrade a package this way, you can easily compare the new
4505: set of patches with the previously existing one with
4506: <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
4507: or update from the <code class="filename">work/.newpatches</code>
4508: directory to <code class="filename">patches/</code>.</p>
4509: <p>When you have finished a package, remember to generate
4510: the checksums for the patch files by using the <span><strong class="command">make
1.90 rillig 4511: makepatchsum</strong></span> command, see <a href="#components.distinfo" title="10.2. distinfo">Section 10.2, “<code class="filename">distinfo</code>”</a>.</p>
1.87 wiz 4512: <p>When adding a patch that corrects a problem in the
4513: distfile (rather than e.g. enforcing pkgsrc's view of where
4514: man pages should go), send the patch as a bug report to the
4515: maintainer. This benefits non-pkgsrc users of the package,
4516: and usually makes it possible to remove the patch in future
4517: version.</p>
1.101 ! rillig 4518: <p>The file names of the patch files are usually of the form
! 4519: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93 rillig 4520: </div>
4521: <div class="sect2" lang="en">
4522: <div class="titlepage"><div><div><h3 class="title">
4523: <a name="components.patches.sources"></a>10.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4524: <p>If you want to share patches between multiple packages
4525: in pkgsrc, e.g. because they use the same distfiles, set
4526: <code class="varname">PATCHDIR</code> to the path where the patch files
4527: can be found, e.g.:</p>
4528: <pre class="programlisting">
1.100 rillig 4529: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4530: </pre>
1.75 rillig 4531: <p>Patch files that are distributed by the author or other
1.87 wiz 4532: maintainers can be listed in
4533: <code class="varname">PATCHFILES</code>.</p>
4534: <p>If it is desired to store any patches that should not be
4535: committed into pkgsrc, they can be kept outside the pkgsrc
4536: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4537: directory tree there is expected to have the same
4538: “<span class="quote">category/package</span>” structure as pkgsrc, and
4539: patches are expected to be stored inside these dirs (also
4540: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4541: example, if you want to keep a private patch for
4542: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4543: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4544: files in the named directory are expected to be patch files,
4545: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4546: applied</em></span>.</p>
1.93 rillig 4547: </div>
1.85 jmmv 4548: <div class="sect2" lang="en">
4549: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 4550: <a name="components.patches.guidelines"></a>10.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4551: <p>When fixing a portability issue in the code do not use
4552: preprocessor magic to check for the current operating system nor
4553: platform. Doing so hurts portability to other platforms because
4554: the OS-specific details are not abstracted appropriately.</p>
4555: <p>The general rule to follow is: instead of checking for the
4556: operating system the application is being built on, check for the
4557: specific <span class="emphasis"><em>features</em></span> you need. For example,
4558: instead of assuming that kqueue is available under NetBSD and
4559: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.89 rillig 4560: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4561: yes, this generally involves patching the
4562: <span><strong class="command">configure</strong></span> script. There is absolutely nothing
4563: that prevents some OSes from adopting interfaces from other OSes
4564: (e.g. Linux implementing kqueue), something that the above checks
4565: cannot take into account.</p>
4566: <p>Of course, checking for features generally involves more
4567: work on the developer's side, but the resulting changes are
1.87 wiz 4568: cleaner and there are chances they will work on many other
1.85 jmmv 4569: platforms. Not to mention that there are higher chances of being
4570: later integrated into the mainstream sources. Remember:
4571: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4572: <p>Some typical examples:</p>
4573: <div class="table">
1.90 rillig 4574: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91 rillig 4575: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4576: <colgroup>
4577: <col>
4578: <col>
4579: <col>
4580: </colgroup>
4581: <thead><tr>
4582: <th>Where</th>
4583: <th>Incorrect</th>
4584: <th>Correct</th>
4585: </tr></thead>
4586: <tbody>
4587: <tr>
4588: <td>configure script</td>
4589: <td>
1.100 rillig 4590: <pre class="programlisting">
4591: case ${target_os} in
4592: netbsd*) have_kvm=yes ;;
4593: *) have_kvm=no ;;
4594: esac
4595: </pre>
1.85 jmmv 4596: </td>
4597: <td>
1.100 rillig 4598: <pre class="programlisting">
4599: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4600: </pre>
1.85 jmmv 4601: </td>
4602: </tr>
4603: <tr>
4604: <td>C source file</td>
4605: <td>
1.100 rillig 4606: <pre class="programlisting">
4607: #if defined(__NetBSD__)
4608: # include <sys/event.h>
4609: #endif
4610: </pre>
1.85 jmmv 4611: </td>
4612: <td>
1.100 rillig 4613: <pre class="programlisting">
4614: #if defined(HAVE_SYS_EVENT_H)
4615: # include <sys/event.h>
4616: #endif
4617: </pre>
1.85 jmmv 4618: </td>
4619: </tr>
4620: <tr>
4621: <td>C source file</td>
4622: <td>
1.100 rillig 4623: <pre class="programlisting">
4624: int
4625: monitor_file(...)
4626: {
4627: #if defined(__NetBSD__)
4628: int fd = kqueue();
4629: ...
4630: #else
4631: ...
4632: #endif
4633: }
4634: </pre>
1.85 jmmv 4635: </td>
4636: <td>
1.100 rillig 4637: <pre class="programlisting">
4638: int
4639: monitor_file(...)
4640: {
4641: #if defined(HAVE_KQUEUE)
4642: int fd = kqueue();
4643: ...
4644: #else
4645: ...
4646: #endif
4647: }
4648: </pre>
1.85 jmmv 4649: </td>
4650: </tr>
4651: </tbody>
1.91 rillig 4652: </table></div>
1.85 jmmv 4653: </div>
1.91 rillig 4654: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85 jmmv 4655: packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4656: 1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4657: 2</a>). It summarizes multiple details on how to make
4658: software easier to package; all the suggestions in it were
4659: collected from our experience in pkgsrc work, so they are possibly
4660: helpful when creating patches too.</p>
4661: </div>
4662: <div class="sect2" lang="en">
4663: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 4664: <a name="components.patches.feedback"></a>10.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4665: <p>Always, always, <span class="strong"><strong>always</strong></span>
4666: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4667: improvements you do to a package to the mainstream developers.
4668: This is the only way to get their attention on portability issues
4669: and to ensure that future versions can be built out-of-the box on
4670: NetBSD. Furthermore, any user that gets newer distfiles will get
4671: the fixes straight from the packaged code.</p>
1.93 rillig 4672: <p>This generally involves cleaning up the patches
4673: (because sometimes the patches that are
1.85 jmmv 4674: added to pkgsrc are quick hacks), filling bug reports in the
4675: appropriate trackers for the projects and working with the
4676: mainstream authors to accept your changes. It is
4677: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4678: the packages in pkgsrc are kept simple and thus further changes
4679: can be done without much hassle.</p>
4680: <p>Support the idea of free software!</p>
4681: </div>
1.75 rillig 4682: </div>
4683: <div class="sect1" lang="en">
4684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4685: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4686: <div class="variablelist"><dl>
1.76 rillig 4687: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4688: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4689: any credits where they are due. Please bear in mind that others do not
4690: share your sense of humour (or spelling idiosyncrasies), and that others
4691: will read everything that you write here.</p></dd>
1.76 rillig 4692: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4693: <dd><p>This file governs the files that are installed on your
4694: system: all the binaries, manual pages, etc. There are other
4695: directives which may be entered in this file, to control the
4696: creation and deletion of directories, and the location of
1.90 rillig 4697: inserted files. See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87 wiz 4698: information.</p></dd>
1.75 rillig 4699: </dl></div>
4700: </div>
4701: <div class="sect1" lang="en">
4702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4703: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78 rillig 4704: <div class="sect2" lang="en">
4705: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4706: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4707: <div class="variablelist"><dl>
1.76 rillig 4708: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75 rillig 4709: <dd><p>This shell script is invoked twice by <a 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 4710: First time after package extraction and before files are
4711: moved in place, the second time after the files to install
4712: are moved in place. This can be used to do any custom
4713: procedures not possible with @exec commands in
4714: <code class="filename">PLIST</code>. See <a 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
1.90 rillig 4715: <a 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 href="#files-and-dirs-outside-prefix" title="14.1. Files and directories outside the installation prefix">Section 14.1, “Files and directories outside the installation prefix”</a>.</p></dd>
1.76 rillig 4716: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4717: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4718: this script's responsibility to clean up any additional messy details
4719: around the package's installation, since all pkg_delete knows is how to
4720: delete the files created in the original distribution.
4721: See <a 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>
4722: and <a 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 4723: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4724: <dd>
4725: <p>This file is displayed after installation of the package.
1.87 wiz 4726: Useful for things like legal notices on almost-free
4727: software and hints for updating config files after
4728: installing modules for apache, PHP etc.
4729: Please note that you can modify variables in it easily by using
4730: <code class="varname">MESSAGE_SUBST</code> in the package's
4731: <code class="filename">Makefile</code>:</p>
1.75 rillig 4732: <pre class="programlisting">
1.100 rillig 4733: MESSAGE_SUBST+= SOMEVAR="somevalue"
4734: </pre>
1.75 rillig 4735: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4736: <code class="filename">MESSAGE</code>. By default, substitution is
4737: performed for <code class="varname">PKGNAME</code>,
4738: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4739: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4740: <code class="varname">X11BASE</code>,
4741: <code class="varname">PKG_SYSCONFDIR</code>,
4742: <code class="varname">ROOT_GROUP</code>, and
4743: <code class="varname">ROOT_GROUP</code>.</p>
4744: <p>You can display a different or additional files by
4745: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4746: default is <code class="filename">MESSAGE</code>, if the file
4747: exists.</p>
1.75 rillig 4748: </dd>
1.78 rillig 4749: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4750: <dd><p>FIXME: There is no documentation on the
4751: alternatives framework.</p></dd>
4752: </dl></div>
4753: </div>
4754: <div class="sect2" lang="en">
4755: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4756: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4757: <div class="variablelist"><dl>
4758: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4759: <dd><p>This file contains arbitrary things that could
4760: also go into a <code class="filename">Makefile</code>, but its purpose is
4761: to be used by more than one package. This file should only be
4762: used when the packages that will use the file are known in
4763: advance. For other purposes it is often better to write a
4764: <code class="filename">*.mk</code> file and give it a good name that
4765: describes what it does.</p></dd>
4766: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4767: <dd><p>This file contains the dependency information
1.90 rillig 4768: for the buildlink3 framework (see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p></dd>
1.78 rillig 4769: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4770: <dd><p>This file contains workarounds for compiler bugs
4771: and similar things. It is included automatically by the pkgsrc
4772: infrastructure, so you don't need an extra
4773: <code class="literal">.include</code> line for
4774: it.</p></dd>
4775: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4776: <dd><p>This file contains the code for the
1.90 rillig 4777: package-specific options (see <a href="#options" title="Chapter 15. Options handling">Chapter 15, <i>Options handling</i></a>) that can be
1.78 rillig 4778: selected by the user. If a package has only one or two options,
4779: it is equally acceptable to put the code directly into the
4780: <code class="filename">Makefile</code>.</p></dd>
4781: </dl></div>
4782: </div>
4783: <div class="sect2" lang="en">
4784: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4785: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4786: <div class="variablelist"><dl>
4787: <dt><span class="term"><code class="filename">README*</code></span></dt>
4788: <dd><p>These files do not take place in the creation of
4789: a package and thus are purely informative to the package
4790: developer.</p></dd>
4791: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4792: <dd><p>This file contains things that need to be done
4793: to make the package even
4794: better.</p></dd>
1.75 rillig 4795: </dl></div>
4796: </div>
1.78 rillig 4797: </div>
1.75 rillig 4798: <div class="sect1" lang="en">
4799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4800: <a name="work-dir"></a>10.6. <code class="filename">work*</code>
4801: </h2></div></div></div>
1.75 rillig 4802: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87 wiz 4803: unpacked into the directory denoted by
4804: <code class="varname">WRKDIR</code>. It can be removed by running
4805: <span><strong class="command">make clean</strong></span>. Besides the sources, this
4806: directory is also used to keep various timestamp files.
4807: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4808: The default is <code class="filename">${.CURDIR}/work</code>
4809: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4810: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4811: </div>
4812: <div class="sect1" lang="en">
4813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4814: <a name="files-dir"></a>10.7. <code class="filename">files/*</code>
4815: </h2></div></div></div>
1.75 rillig 4816: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4817: to configuration or building, you could place these files here and use
4818: a <span><strong class="command">${CP}</strong></span> command in the
4819: “<span class="quote">pre-configure</span>” target to achieve
4820: this. Alternatively, you could simply diff the file against
4821: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4822: the creation of this file.</p>
4823: <p>If you want to share files in this way with other
4824: packages, set the <code class="varname">FILESDIR</code> variable to point
4825: to the other package's <code class="filename">files</code> directory,
4826: e.g.:</p>
4827: <pre class="programlisting">
1.100 rillig 4828: FILESDIR=${.CURDIR}/../xemacs/files
4829: </pre>
1.75 rillig 4830: </div>
4831: </div>
4832: <div class="chapter" lang="en">
4833: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4834: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4835: <div class="toc">
4836: <p><b>Table of Contents</b></p>
4837: <dl>
1.97 rillig 4838: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
4839: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
4840: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
4841: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
4842: <dd><dl>
4843: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
4844: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
4845: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
4846: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
4847: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75 rillig 4848: </dl></dd>
4849: </dl>
4850: </div>
1.76 rillig 4851: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4852: each of which forms a well-defined part of the pkgsrc system. Using
4853: the <a 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
4854: like pkgsrc requires some discipline to keep the code correct and
4855: understandable.</p>
1.76 rillig 4856: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4857: programming are variables (which are actually macros) and shell
4858: commands. Among these shell commands may even be more complex ones
4859: like <a 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
4860: as intended it is necessary to quote all variables correctly when they
4861: are used.</p>
4862: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4863: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4864: with them.</p>
4865: <div class="sect1" lang="en">
4866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97 rillig 4867: <a name="makefile.style"></a>11.1. Caveats</h2></div></div></div>
4868: <div class="itemizedlist"><ul type="disc"><li>
4869: <p>When you are creating a file as a
4870: target of a rule, always write the data to a temporary file first
4871: and finally rename that file. Otherwise there might occur an error
4872: in the middle of generating the file, and when the user runs
4873: <a 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
4874: regenerated properly. Example:</p>
4875: <pre class="programlisting">
1.100 rillig 4876: wrong:
4877: @echo "line 1" > ${.TARGET}
4878: @echo "line 2" >> ${.TARGET}
4879: @false
4880:
4881: correct:
4882: @echo "line 1" > ${.TARGET}.tmp
4883: @echo "line 2" >> ${.TARGET}.tmp
4884: @false
4885: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4886: </pre>
4887: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
4888: <code class="filename">wrong</code> will exist, although there was an error
4889: message in the first run. On the other hand, running <span><strong class="command">make
4890: correct</strong></span> gives an error message twice, as expected.</p>
4891: <p>You might remember that <a 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
4892: <code class="literal">${.TARGET}</code> in case of error, but this only
4893: happens when it is interrupted, for example by pressing
4894: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
4895: when one of the commands fails (like <a 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>
4896: </li></ul></div>
4897: </div>
4898: <div class="sect1" lang="en">
4899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4900: <a name="makefile.variables"></a>11.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4901: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4902: can be processed using the five operators ``='', ``+='', ``?='',
4903: ``:='', and ``!='', which are described in the <a 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
4904: page.</p>
4905: <p>When a variable's value is parsed from a
1.76 rillig 4906: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4907: backslash character ``\'' are handled specially. If a backslash is
4908: followed by a newline, any whitespace immediately in front of the
4909: backslash, the backslash, the newline, and any whitespace
4910: immediately behind the newline are replaced with a single space. A
4911: backslash character and an immediately following hash character are
4912: replaced with a single hash character. Otherwise, the backslash is
4913: passed as is. In a variable assignment, any hash character that is
4914: not preceded by a backslash starts a comment that continues upto the
4915: end of the logical line.</p>
4916: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4917: the only way to create a variable consisting of a single backslash
4918: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4919: <p>So far for defining variables. The other thing you can do with
4920: variables is evaluating them. A variable is evaluated when it is
4921: part of the right side of the ``:='' or the ``!='' operator, or
4922: directly before executing a shell command which the variable is part
4923: of. In all other cases, <a 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
4924: is, variables are not evaluated until there's no other way. The
4925: ``modifiers'' mentioned in the man page also evaluate the
4926: variable.</p>
4927: <p>Some of the modifiers split the string into words and then
4928: operate on the words, others operate on the string as a whole. When
4929: a string is split into words, it is split as you would expect
4930: it from <a 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.89 rillig 4931: <p>No rule without exception—the <span><strong class="command">.for</strong></span>
1.75 rillig 4932: loop does not follow the shell quoting rules but splits at sequences
4933: of whitespace.</p>
4934: <p>There are several types of variables that should be handled
4935: differently. Strings and two types of lists.</p>
4936: <div class="itemizedlist"><ul type="disc">
4937: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4938: characters. Nevertheless, you should restrict yourself to only
4939: using printable characters. Examples are
4940: <code class="varname">PREFIX</code> and
4941: <code class="varname">COMMENT</code>.</p></li>
4942: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4943: are never exported to any shell command. Their elements are
4944: separated by whitespace. Therefore, the elements themselves cannot
4945: have embedded whitespace. Any other characters are allowed.
4946: Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
4947: Examples are <code class="varname">DEPENDS</code> and
4948: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4949: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4950: may be exported to a shell command. Their elements can contain any
4951: characters, including whitespace. That's why they cannot be used
4952: in <span><strong class="command">.for</strong></span> loops. Examples are
4953: <code class="varname">DISTFILES</code> and
4954: <code class="varname">MASTER_SITES</code>.</p></li>
4955: </ul></div>
4956: <div class="sect2" lang="en">
4957: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4958: <a name="makefile.variables.names"></a>11.2.1. Naming conventions</h3></div></div></div>
1.75 rillig 4959: <div class="itemizedlist"><ul type="disc">
4960: <li><p>All variable names starting with an underscore
4961: are reserved for use by the pkgsrc infrastructure. They shall
4962: not be used by package
1.76 rillig 4963: <code class="filename">Makefile</code>s.</p></li>
1.75 rillig 4964: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
4965: lowercase variable names for the iteration
4966: variables.</p></li>
4967: <li><p>All list variables should have a ``plural''
4968: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4969: <code class="varname">DISTFILES</code>.</p></li>
4970: </ul></div>
4971: </div>
4972: </div>
4973: <div class="sect1" lang="en">
4974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97 rillig 4975: <a name="makefile.code"></a>11.3. Code snippets</h2></div></div></div>
1.75 rillig 4976: <p>This section presents you with some code snippets you should
4977: use in your own code. If you don't find anything appropriate here,
4978: you should test your code and add it here.</p>
4979: <div class="sect2" lang="en">
4980: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4981: <a name="adding-to-list"></a>11.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4982: <pre class="programlisting">
1.100 rillig 4983: STRING= foo * bar `date`
4984: INT_LIST= # empty
4985: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4986: EXT_LIST= # empty
4987: ANOTHER_EXT_LIST= a=b c=d
4988:
4989: INT_LIST+= ${STRING} # 1
4990: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4991: EXT_LIST+= ${STRING:Q} # 3
4992: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4993: </pre>
1.75 rillig 4994: <p>When you add a string to an external list (example 3), it
4995: must be quoted. In all other cases, you must not add a quoting
4996: level. You must not merge internal and external lists, unless you
4997: are sure that all entries are correctly interpreted in both
4998: lists.</p>
4999: </div>
5000: <div class="sect2" lang="en">
5001: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5002: <a name="converting-internal-to-external"></a>11.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75 rillig 5003: <pre class="programlisting">
1.100 rillig 5004: EXT_LIST= # empty
5005: .for i in ${INT_LIST}
5006: EXT_LIST+= ${i:Q}""
5007: .endfor
1.1 grant 5008: </pre>
1.75 rillig 5009: <p>This code converts the internal list
5010: <code class="varname">INT_LIST</code> into the external list
5011: <code class="varname">EXT_LIST</code>. As the elements of an internal list
5012: are unquoted they must be quoted here. The reason for appending
5013: <code class="varname">""</code> is explained below.</p>
5014: </div>
5015: <div class="sect2" lang="en">
5016: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5017: <a name="passing-variable-to-shell"></a>11.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 5018: <p>Sometimes you may want to print an arbitrary string. There
5019: are many ways to get it wrong and only few that can handle every
5020: nastiness.</p>
1.75 rillig 5021: <pre class="programlisting">
1.100 rillig 5022: STRING= foo bar < > * `date` $$HOME ' "
5023: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 5024:
1.100 rillig 5025: all:
5026: echo ${STRING} # 1
5027: echo "${STRING}" # 2
5028: echo "${STRING:Q}" # 3
5029: echo ${STRING:Q} # 4
5030: echo x${STRING:Q} | sed 1s,.,, # 5
5031: printf "%s\\n" ${STRING:Q}"" # 6
5032: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 5033: </pre>
1.75 rillig 5034: <p>Example 1 leads to a syntax error in the shell, as the
5035: characters are just copied.</p>
5036: <p>Example 2 leads to a syntax error too, and if you leave out
5037: the last " character from <code class="varname">${STRING}</code>,
5038: <a 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
5039: variable would be evaluated, too.</p>
5040: <p>Example 3 outputs each space character preceded by a
5041: backslash (or not), depending on the implementation of the
5042: <a 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>
5043: <p>Example 4 handles correctly every string that does not start
5044: with a dash. In that case, the result depends on the
5045: implementation of the <a 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
5046: guarantee that your input does not start with a dash, this form is
5047: appropriate.</p>
5048: <p>Example 5 handles even the case of a leading dash
5049: correctly.</p>
1.79 rillig 5050: <p>Example 6 also works with every string and is the
5051: light-weight solution, since it does not involve a pipe, which has
5052: its own problems.</p>
1.75 rillig 5053: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5054: because the quoting has already been done when adding elements to
5055: the list.</p>
5056: <p>As internal lists shall not be passed to the shell, there is
5057: no example for it.</p>
5058: </div>
5059: <div class="sect2" lang="en">
5060: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5061: <a name="quoting-guideline"></a>11.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 5062: <p>There are many possible sources of wrongly quoted variables.
5063: This section lists some of the commonly known ones.</p>
5064: <div class="itemizedlist"><ul type="disc">
5065: <li>
5066: <p>Whenever you use the value of a list, think
5067: about what happens to leading or trailing whitespace. If the
5068: list is a well-formed shell expression, you can apply the
5069: <code class="varname">:M*</code> modifier to strip leading and trailing
5070: whitespace from each word. The <code class="varname">:M</code> operator
5071: first splits its argument according to the rules of the shell,
5072: and then creates a new list consisting of all words that match
5073: the shell glob expression <code class="varname">*</code>, that is: all.
5074: One class of situations where this is needed is when adding a
5075: variable like <code class="varname">CPPFLAGS</code> to
5076: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5077: invokes other configure scripts, it strips the leading and
5078: trailing whitespace from the variable and then passes it to the
5079: other configure scripts. But these configure scripts expect the
5080: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5081: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5082: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5083: here is how we do it:</p>
5084: <pre class="programlisting">
1.100 rillig 5085: CPPFLAGS= # empty
5086: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5087: CPPFLAGS+= ${MY_CPPFLAGS}
5088:
5089: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5090:
5091: all:
5092: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5093: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5094: </pre>
1.75 rillig 5095: </li>
5096: <li><p>The example above contains one bug: The
5097: <code class="varname">${PREFIX}</code> is a properly quoted shell
5098: expression, but there is the C compiler after it, which also
5099: expects a properly quoted string (this time in C syntax). The
5100: version above is therefore only correct if
5101: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5102: or double quotes. If you want to allow these, you have to add
5103: another layer of quoting to each variable that is used as a C
5104: string literal. You cannot use the <code class="varname">:Q</code>
5105: operator for it, as this operator only works for the
5106: shell.</p></li>
5107: <li>
5108: <p>Whenever a variable can be empty, the
5109: <code class="varname">:Q</code> operator can have surprising results. Here
5110: are two completely different cases which can be solved with the
5111: same trick.</p>
5112: <pre class="programlisting">
1.100 rillig 5113: EMPTY= # empty
5114: empty_test:
5115: for i in a ${EMPTY:Q} c; do \
5116: echo "$$i"; \
5117: done
5118:
5119: for_test:
5120: .for i in a:\ a:\test.txt
5121: echo ${i:Q}
5122: echo "foo"
5123: .endfor
1.1 grant 5124: </pre>
1.75 rillig 5125: <p>The first example will only print two of the three lines
5126: we might have expected. This is because
5127: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5128: the shell cannot see. The workaround is to write
5129: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5130: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5131: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5132: <p>The second example will only print three lines instead of
5133: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5134: This is because the backslash of the value
5135: <code class="varname">a:\</code> is interpreted as a line-continuation by
5136: <a 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
5137: <a 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
5138: <code class="varname">${i:Q}""</code>.</p>
5139: </li>
5140: </ul></div>
5141: </div>
5142: <div class="sect2" lang="en">
5143: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5144: <a name="bsd-make-bug-workaround"></a>11.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5145: <p>The pkgsrc bmake program does not handle the following
5146: assignment correctly. In case <code class="varname">_othervar_</code>
5147: contains a ``-'' character, one of the closing braces is included
5148: in <code class="varname">${VAR}</code> after this code executes.</p>
5149: <pre class="programlisting">
1.100 rillig 5150: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5151: </pre>
1.75 rillig 5152: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5153: 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 5154: <code class="varname">bug1</code>.</p>
5155: </div>
5156: </div>
5157: </div>
5158: <div class="chapter" lang="en">
5159: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5160: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75 rillig 5161: <div class="toc">
5162: <p><b>Table of Contents</b></p>
5163: <dl>
1.90 rillig 5164: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
5165: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5166: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
5167: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
5168: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
5169: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5170: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
5171: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5172: </dl>
5173: </div>
1.87 wiz 5174: <p>The <code class="filename">PLIST</code> file contains a package's
5175: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5176: the package (relative to the <code class="filename">${PREFIX}</code>
5177: directory it's been installed in) plus some additional statements
5178: - see the <a 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.
5179: This chapter addresses some issues that need attention when
5180: dealing with the <code class="filename">PLIST</code> file (or files, see
5181: below!).</p>
1.75 rillig 5182: <div class="sect1" lang="en">
5183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5184: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87 wiz 5185: <p>Be sure to add a RCS ID line as the first thing in any
5186: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5187: <pre class="programlisting">
1.100 rillig 5188: @comment $NetBSD$
1.87 wiz 5189: </pre>
1.75 rillig 5190: </div>
5191: <div class="sect1" lang="en">
5192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5193: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75 rillig 5194: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87 wiz 5195: to output a PLIST that matches any new files since the package
1.90 rillig 5196: was extracted. See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, “Other helpful targets”</a> for
1.87 wiz 5197: more information on this target.</p>
1.75 rillig 5198: </div>
5199: <div class="sect1" lang="en">
5200: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 5201: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
5202: </h2></div></div></div>
1.87 wiz 5203: <p>If you have used any of the *-dirs packages, as explained in
1.90 rillig 5204: <a href="#faq.common-dirs" title="12.8. Sharing directories between packages">Section 12.8, “Sharing directories between packages”</a>, you may have noticed that
1.87 wiz 5205: <span><strong class="command">make print-PLIST</strong></span> outputs a set of
5206: <code class="varname">@comment</code>s instead of real
5207: <code class="varname">@dirrm</code> lines. You can also do this for
5208: specific directories and files, so that the results of that
5209: command are very close to reality. This helps <span class="emphasis"><em>a
5210: lot</em></span> during the update of packages.</p>
5211: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5212: of AWK patterns and actions that are used to filter the output of
5213: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5214: scripting you like to it, but be careful with quoting.</p>
5215: <p>For example, to get all files inside the
5216: <code class="filename">libdata/foo</code> directory removed from the
5217: resulting PLIST:</p>
5218: <pre class="programlisting">
1.100 rillig 5219: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5220: </pre>
5221: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5222: to a specific (shared) directory converted to
5223: <code class="varname">@comment</code>s:</p>
1.75 rillig 5224: <pre class="programlisting">
1.100 rillig 5225: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5226: </pre>
1.75 rillig 5227: </div>
5228: <div class="sect1" lang="en">
5229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5230: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5231: <p>A number of variables are substituted automatically in
5232: PLISTs when a package is installed on a system. This includes the
5233: following variables:</p>
1.75 rillig 5234: <div class="variablelist"><dl>
5235: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5236: <dd>
5237: <p>Some packages like emacs and perl embed information
1.87 wiz 5238: about which architecture they were built on into the
5239: pathnames where they install their files. To handle this
5240: case, PLIST will be preprocessed before actually used, and
5241: the symbol
5242: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
5243: replaced by what <span><strong class="command">uname -p</strong></span> gives. The
5244: same is done if the string
5245: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5246: PLIST somewhere - use this on packages that have GNU
5247: autoconf-created configure scripts.</p>
1.75 rillig 5248: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5249: <h3 class="title">Legacy note</h3>
5250: <p>There used to be a symbol
1.87 wiz 5251: “<span class="quote"><code class="varname">$ARCH</code></span>” that
5252: was replaced by the output of <span><strong class="command">uname
5253: -m</strong></span>, but that's no longer supported and has
5254: been removed.</p>
1.75 rillig 5255: </div>
5256: </dd>
5257: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5258: <dd>
5259: <p>Some packages want to embed the OS name and version
1.87 wiz 5260: into some paths. To do this, use these variables in the
5261: <code class="filename">PLIST</code>:
5262: </p>
1.75 rillig 5263: <div class="itemizedlist"><ul type="disc">
5264: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span><strong class="command">uname -s</strong></span></span>”</p></li>
5265: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
5266: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span><strong class="command">uname -r</strong></span></span>”</p></li>
5267: </ul></div>
5268: </dd>
5269: </dl></div>
1.87 wiz 5270: <p>For a complete list of values which are replaced by
5271: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5272: search for <code class="varname">PLIST_SUBST</code>).</p>
5273: <p>If you want to change other variables not listed above, you
5274: can add variables and their expansions to this variable in the
1.90 rillig 5275: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a href="#components.optional" title="10.5. Optional files">Section 10.5, “Optional files”</a>):</p>
1.75 rillig 5276: <pre class="programlisting">
1.100 rillig 5277: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5278: </pre>
1.75 rillig 5279: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5280: in the <code class="filename">PLIST</code> with
5281: “<span class="quote">somevalue</span>”.</p>
1.75 rillig 5282: </div>
5283: <div class="sect1" lang="en">
5284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5285: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75 rillig 5286: <p>Man pages should be installed in compressed form if
1.87 wiz 5287: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5288: and uncompressed otherwise. To handle this in the
5289: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5290: appended/removed automatically for man pages according to
5291: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5292: or not, see above for details. This modification of the
5293: <code class="filename">PLIST</code> file is done on a copy of it, not
5294: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5295: </div>
5296: <div class="sect1" lang="en">
5297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 5298: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
5299: </h2></div></div></div>
1.76 rillig 5300: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5301: in generating the binary package, set the variable
5302: <code class="varname">PLIST_SRC</code> to the names of that file(s).
5303: The files are later concatenated using <a 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
5304: important. The default for <code class="varname">PLIST_SRC</code> is
5305: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5306: </div>
5307: <div class="sect1" lang="en">
5308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5309: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5310: <p>Some packages decide to install a different set of files based on
1.87 wiz 5311: the operating system being used. These differences can be
5312: automatically handled by using the following files:</p>
1.75 rillig 5313: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5314: <li><p><code class="filename">PLIST.common</code></p></li>
5315: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5316: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5317: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5318: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5319: </ul></div>
5320: </div>
5321: <div class="sect1" lang="en">
5322: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5323: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5324: <p>A “<span class="quote">shared directory</span>” is a directory where
5325: multiple (and unrelated) packages install files. These
5326: directories are problematic because you have to add special tricks
5327: in the PLIST to conditionally remove them, or have some
5328: centralized package handle them.</p>
5329: <p>Within pkgsrc, you'll find both approaches. If a directory
5330: is shared by a few unrelated packages, it's often not worth to add
5331: an extra package to remove it. Therefore, one simply does:</p>
5332: <pre class="programlisting">
1.100 rillig 5333: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
1.87 wiz 5334: </pre>
5335: <p>in the PLISTs of all affected packages, instead of the
5336: regular "@dirrm" line.</p>
5337: <p>However, if the directory is shared across many packages, two
5338: different solutions are available:</p>
1.75 rillig 5339: <div class="orderedlist"><ol type="1">
1.87 wiz 5340: <li><p>If the packages have a common dependency, the directory
5341: can be removed in that. For example, see
1.91 rillig 5342: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
1.87 wiz 5343: removes the shared directory
5344: <code class="filename">share/omf</code>.</p></li>
5345: <li><p>If the packages using the directory are not related at
5346: all (they have no common dependencies), a *-dirs package is
5347: used.</p></li>
1.75 rillig 5348: </ol></div>
1.87 wiz 5349: <p>From now on, we'll discuss the second solution. To get an
5350: idea of the *-dirs packages available, issue:</p>
1.75 rillig 5351: <pre class="programlisting">
1.100 rillig 5352: <code class="prompt">%</code> cd .../pkgsrc
5353: <code class="prompt">%</code> ls -d */*-dirs
1.87 wiz 5354: </pre>
5355: <p>Their use from other packages is very simple. The
5356: <code class="varname">USE_DIRS</code> variable takes a list of package names
5357: (without the “<span class="quote">-dirs</span>” part) together with the required
5358: version number (always pick the latest one when writing new
5359: packages).</p>
5360: <p>For example, if a package installs files under
5361: <code class="filename">share/applications</code>, it should have the
5362: following line in it:</p>
5363: <pre class="programlisting">
1.100 rillig 5364: USE_DIRS+= xdg-1.1
1.87 wiz 5365: </pre>
5366: <p>After regenerating the PLIST using <span><strong class="command">make
5367: print-PLIST</strong></span>, you should get the right (commented out)
5368: lines.</p>
5369: <p>Note that even if your package is using
5370: <code class="filename">$X11BASE</code>, it must not depend on the
5371: *-x11-dirs packages. Just specify the name without that part and
5372: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5373: care of it.</p>
1.75 rillig 5374: </div>
5375: </div>
5376: <div class="chapter" lang="en">
5377: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5378: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75 rillig 5379: <div class="toc">
5380: <p><b>Table of Contents</b></p>
5381: <dl>
1.90 rillig 5382: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
5383: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5384: <dd><dl>
1.90 rillig 5385: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5386: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.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 5387: </dl></dd>
1.90 rillig 5388: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75 rillig 5389: <dd><dl>
1.90 rillig 5390: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
5391: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75 rillig 5392: </dl></dd>
5393: </dl>
5394: </div>
5395: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5396: are seen by a package's configure and build processes. This is implemented
5397: in a two step process:</p>
1.75 rillig 5398: <div class="orderedlist"><ol type="1">
5399: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5400: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5401: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5402: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5403: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5404: <code class="option">-L${LOCALBASE}/lib</code> into references to
5405: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5406: native compiler on some operating systems look like GCC, so that
5407: packages that expect GCC won't require modifications to build with
5408: those native compilers.</p></li>
1.75 rillig 5409: </ol></div>
5410: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5411: package may be built consistently despite what other software may be
5412: installed. Please note that the normal system header and library paths,
5413: e.g. <code class="filename">/usr/include</code>,
5414: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5415: designed to insulate the package build from non-system-supplied
5416: software.</p>
1.75 rillig 5417: <div class="sect1" lang="en">
5418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5419: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5420: <p>The process of converting packages to use the buildlink3
1.87 wiz 5421: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5422: The things to keep in mind are:</p>
1.75 rillig 5423: <div class="orderedlist"><ol type="1">
1.87 wiz 5424: <li><p>Ensure that the build always calls the wrapper scripts
5425: instead of the actual toolchain. Some packages are tricky,
5426: and the only way to know for sure is the check
5427: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5428: wrappers are being invoked.</p></li>
5429: <li><p>Don't override <code class="varname">PREFIX</code> from within
5430: the package Makefile, e.g. Java VMs, standalone shells,
5431: etc., because the code to symlink files into
5432: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5433: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5434: </p></li>
5435: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5436: <code class="filename">buildlink3.mk</code> files that you list in a
5437: package's Makefile are added as dependencies for that package.
5438: </p></li>
1.75 rillig 5439: </ol></div>
1.87 wiz 5440: <p>If a dependency on a particular package is required for its libraries and
5441: headers, then we replace:</p>
1.75 rillig 5442: <pre class="programlisting">
1.100 rillig 5443: DEPENDS+= foo>=1.1.0:../../category/foo
5444: </pre>
1.75 rillig 5445: <p>with</p>
5446: <pre class="programlisting">
1.100 rillig 5447: .include "../../category/foo/buildlink3.mk"
5448: </pre>
1.75 rillig 5449: <p>The buildlink3.mk files usually define the required dependencies.
5450: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5451: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5452: <pre class="programlisting">
1.100 rillig 5453: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5454: .include "../../category/foo/buildlink3.mk"
5455: </pre>
1.76 rillig 5456: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5457: files in <code class="filename">pkgsrc/mk</code>
5458: that handle special package issues:</p>
1.75 rillig 5459: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5460: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5461: the native or a pkgsrc Berkeley DB implementation based on
5462: the values of <code class="varname">BDB_ACCEPTED</code> and
5463: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5464: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5465: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5466: to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.76 rillig 5467: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5468: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5469: adding a dependency on Heimdal or MIT-krb5 for packages that
5470: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5471: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5472: system-provided Motif installation or adds a dependency on
1.91 rillig 5473: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>. The user can set
1.88 wiz 5474: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5475: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5476: which Motif version will be used.</p></li>
1.76 rillig 5477: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5478: variables that may be used by packages that use the
5479: Open Sound System (OSS) API.</p></li>
1.76 rillig 5480: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5481: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5482: the file for more information.</p></li>
1.76 rillig 5483: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5484: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5485: a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.76 rillig 5486: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5487: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5488: library.</p></li>
1.75 rillig 5489: </ul></div>
1.76 rillig 5490: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5491: files provide a more complete
5492: description of how to use them properly.</p>
1.75 rillig 5493: </div>
5494: <div class="sect1" lang="en">
5495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5496: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87 wiz 5497: <p>A package's <code class="filename">buildlink3.mk</code> file is
5498: included by Makefiles to indicate the need to compile and link
5499: against header files and libraries provided by the package. A
5500: <code class="filename">buildlink3.mk</code> file should always provide
5501: enough information to add the correct type of dependency
5502: relationship and include any other
5503: <code class="filename">buildlink3.mk</code> files that it needs to find
5504: headers and libraries that it needs in turn.</p>
5505: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5506: 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 5507: package is highly recommended. For most packages, the following
5508: command will generate a good starting point for
5509: <code class="filename">buildlink3.mk</code> files:</p>
5510: <pre class="screen">
5511: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5512: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5513: </pre>
1.75 rillig 5514: <div class="sect2" lang="en">
5515: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5516: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5517: <p>The following real-life example
1.87 wiz 5518: <code class="filename">buildlink3.mk</code> is taken
5519: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5520: <pre class="programlisting">
1.100 rillig 5521: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1 grant 5522:
1.100 rillig 5523: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5524: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
1.1 grant 5525:
1.100 rillig 5526: .if ${BUILDLINK_DEPTH} == "+"
5527: BUILDLINK_DEPENDS+= tiff
5528: .endif
1.87 wiz 5529:
1.100 rillig 5530: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5531: BUILDLINK_PACKAGES+= tiff
1.87 wiz 5532:
1.100 rillig 5533: .if ${TIFF_BUILDLINK3_MK} == "+"
5534: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5535: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5536: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5537:
1.100 rillig 5538: .include "../../devel/zlib/buildlink3.mk"
5539: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 5540:
1.100 rillig 5541: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5542: </pre>
1.87 wiz 5543: <p>The header and footer manipulate
5544: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5545: <code class="filename">buildlink3.mk</code> files and is used to track
5546: at what depth we are including
5547: <code class="filename">buildlink3.mk</code> files.</p>
5548: <p>The first section controls if the dependency on
5549: <em class="replaceable"><code>pkg</code></em> is added.
5550: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5551: packages for which dependencies are added by
5552: buildlink3.</p>
5553: <p>The second section advises pkgsrc that the
5554: <code class="filename">buildlink3.mk</code> file for
5555: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5556: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5557: packages for which <code class="filename">buildlink3.mk</code> files
5558: have been included. It must <span class="emphasis"><em>always</em></span> be
5559: appended to within a <code class="filename">buildlink3.mk</code>
5560: file.</p>
5561: <p>The third section is protected from multiple inclusion
5562: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5563: added. Several important variables are set in the section:</p>
5564: <div class="itemizedlist"><ul type="disc">
5565: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5566: is the actual dependency recorded in the installed
5567: package; this should always be set using
5568: <span><strong class="command">+=</strong></span> to ensure that
5569: we're appending to any pre-existing list of values. This
5570: variable should be set to the first version of the
5571: package that had an API change.
5572: </p></li>
5573: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5574: is the location of the <em class="replaceable"><code>pkg</code></em>
5575: pkgsrc directory.</p></li>
5576: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5577: (not shown above) controls whether we use
5578: <code class="varname">BUILD_DEPENDS</code> or
5579: <code class="varname">DEPENDS</code> to add the dependency on
5580: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5581: selected by setting
5582: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5583: to “<span class="quote">build</span>”. By default, the full dependency is
5584: used.</p></li>
5585: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5586: and
5587: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5588: (not shown above) are lists of subdirectories of
1.76 rillig 5589: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5590: to add to the header and library search paths. These
5591: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5592: respectively.</p></li>
5593: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5594: (not shown above) is the list of preprocessor flags to add
5595: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5596: configure and build phases. The “<span class="quote">-I</span>” option
5597: should be avoided and instead be handled using
5598: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5599: above.</p></li>
1.75 rillig 5600: </ul></div>
1.87 wiz 5601: <p>The following variables are all optionally defined within
5602: this second section (protected against multiple inclusion) and
5603: control which package files are symlinked into
5604: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5605: transformed during the symlinking:</p>
1.75 rillig 5606: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5607: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5608: (not shown above) is a shell glob pattern relative to
1.76 rillig 5609: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5610: to be symlinked into
1.76 rillig 5611: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5612: e.g. <code class="filename">include/*.h</code>.</p></li>
5613: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5614: (not shown above) is a shell pipeline that
5615: outputs to stdout a list of files relative to
5616: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5617: The resulting files are to be symlinked
5618: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5619: this takes the <code class="filename">+CONTENTS</code> of a
5620: <em class="replaceable"><code>pkg</code></em> and filters it through
5621: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5622: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5623: (not shown above) is a filter command that filters
1.76 rillig 5624: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5625: relative to
1.76 rillig 5626: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5627: on stdout. By default for overwrite packages,
5628: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5629: outputs the contents of the <code class="filename">include</code>
5630: and <code class="filename">lib</code> directories in the package
5631: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5632: it outputs any libtool archives in
1.87 wiz 5633: <code class="filename">lib</code> directories.</p></li>
1.95 tron 5634: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5635: (not shown above) is a list of sed arguments used to
5636: transform the name of the source filename into a
5637: destination filename, e.g. <span><strong class="command">-e
1.87 wiz 5638: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5639: </ul></div>
1.87 wiz 5640: <p>The last section includes any
5641: <code class="filename">buildlink3.mk</code> needed for
5642: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5643: Including these <code class="filename">buildlink3.mk</code> files
5644: means that the headers and libraries for these
5645: dependencies are also symlinked into
5646: <code class="filename">${BUILDLINK_DIR}</code>
5647: whenever the <em class="replaceable"><code>pkg</code></em>
5648: <code class="filename">buildlink3.mk</code>
5649: file is included.</p>
1.75 rillig 5650: </div>
5651: <div class="sect2" lang="en">
5652: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5653: <a name="updating-buildlink-depends"></a>13.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 5654: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5655: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5656: after a package update is when the API or interface to the
1.87 wiz 5657: header files change.</p>
5658: <p>In this case,
5659: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5660: should be adjusted to require at least the new package
5661: version. In some cases, the packages that depend on this new
5662: version may need their <code class="varname">PKGREVISION</code>s
5663: increased and, if they have <code class="filename">buildlink3.mk</code>
5664: files, their
5665: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5666: adjusted, too. This is needed so pkgsrc will require the
5667: correct package dependency and not settle for an older one
5668: when building the source.</p>
5669: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5670: should be increased when the binary interface or sonames
5671: (major number of the library version) of any installed
5672: shared libraries change. This is needed so that binary
5673: packages made using it will require the correct package
5674: dependency and not settle for an older one which will not
1.87 wiz 5675: contain the necessary shared libraries.</p>
1.90 rillig 5676: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, “Handling dependencies”</a> for
1.75 rillig 5677: more information about dependencies on other packages,
5678: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5679: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5680: <p>Please take careful consideration before adjusting
5681: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5682: or
5683: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5684: as we don't want to cause unneeded package deletions and
5685: rebuilds. In many cases, new versions of packages work just
5686: fine with older dependencies.</p>
5687: <p>Also it is not needed to set
1.75 rillig 5688: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5689: when it is identical to
1.87 wiz 5690: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5691: </div>
5692: </div>
5693: <div class="sect1" lang="en">
5694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5695: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5696: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5697: coincide with headers and libraries present in the base system.
1.76 rillig 5698: Aside from a <code class="filename">buildlink3.mk</code> file, these
5699: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5700: file that includes the necessary checks to decide whether using
5701: the built-in software or the pkgsrc software is
1.87 wiz 5702: appropriate.</p>
5703: <p>The only requirements of a builtin.mk file for
5704: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5705: <div class="orderedlist"><ol type="1">
1.87 wiz 5706: <li><p>It should set
5707: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5708: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5709: after it is included.</p></li>
5710: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5711: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5712: which is already set before the
5713: <code class="filename">builtin.mk</code> file is included.</p></li>
5714: <li><p>It should be written to allow multiple inclusion. This
5715: is <span class="emphasis"><em>very</em></span> important and takes careful
5716: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5717: </ol></div>
5718: <div class="sect2" lang="en">
5719: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5720: <a name="anatomy-of-builtin.mk"></a>13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75 rillig 5721: <p>The following is the recommended template for builtin.mk
1.87 wiz 5722: files:</p>
1.75 rillig 5723: <pre class="programlisting">
1.100 rillig 5724: .if !defined(IS_BUILTIN.foo)
5725: #
5726: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5727: # genuinely exists in the system or not.
5728: #
5729: IS_BUILTIN.foo?= no
5730:
5731: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5732: # version can be determined.
5733: #
5734: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5735: BUILTIN_PKG.foo?= foo-1.0
5736: . endif
5737: .endif # IS_BUILTIN.foo
5738:
5739: .if !defined(USE_BUILTIN.foo)
5740: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5741: . if defined(BUILTIN_PKG.foo)
5742: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5743: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5744: USE_BUILTIN.foo!= \
5745: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5746: && ${ECHO} "yes" || ${ECHO} "no"
5747: . endif
5748: . endfor
5749: . endif
5750: .endif # USE_BUILTIN.foo
5751:
5752: CHECK_BUILTIN.foo?= no
5753: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5754: #
5755: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5756: # "yes" or "no".
5757: #
5758: .endif # CHECK_BUILTIN.foo
5759: </pre>
1.87 wiz 5760: <p>The first section sets
5761: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5762: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5763: in the base system. This should not be a base system software
5764: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5765: it should only be “<span class="quote">yes</span>” if the actual package is
5766: included as part of the base system. This variable is only
5767: used internally within the <code class="filename">builtin.mk</code>
5768: file.</p>
5769: <p>The second section sets
5770: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5771: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5772: system if it exists (if
5773: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5774: is “<span class="quote">yes</span>”). This variable is only used internally
5775: within the <code class="filename">builtin.mk</code> file.</p>
5776: <p>The third section sets
5777: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5778: and is <span class="emphasis"><em>required</em></span> in all
5779: <code class="filename">builtin.mk</code> files. The code in this
5780: section must make the determination whether the built-in
5781: software is adequate to satisfy the dependencies listed in
5782: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5783: This is typically done by comparing
5784: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5785: against each of the dependencies in
5786: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5787: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5788: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5789: end of the <code class="filename">builtin.mk</code> file. Note that
5790: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5791: may be “<span class="quote">yes</span>” even if
5792: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5793: is “<span class="quote">no</span>” because we may make the determination
5794: that the built-in version of the software is similar enough to
5795: be used as a replacement.</p>
5796: <p>The last section is guarded by
5797: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5798: and includes code that uses the value of
5799: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5800: set in the previous section. This typically includes, e.g.,
5801: adding additional dependency restrictions and listing additional
5802: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5803: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5804: </div>
5805: <div class="sect2" lang="en">
5806: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5807: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5808: <p>When building packages, it's possible to choose whether to set
5809: a global preference for using either the built-in (native)
5810: version or the pkgsrc version of software to satisfy a
5811: dependency. This is controlled by setting
5812: <code class="varname">PREFER_PKGSRC</code> and
5813: <code class="varname">PREFER_NATIVE</code>. These variables take values
5814: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5815: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5816: use the pkgsrc versions of software, while
5817: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5818: built-in versions. Preferences are determined by the most
5819: specific instance of the package in either
5820: <code class="varname">PREFER_PKGSRC</code> or
5821: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5822: in neither or in both variables, then
5823: <code class="varname">PREFER_PKGSRC</code> has precedence over
5824: <code class="varname">PREFER_NATIVE</code>. For example, to require
5825: using pkgsrc versions of software for all but the most basic
5826: bits on a NetBSD system, you can set:</p>
5827: <pre class="programlisting">
1.100 rillig 5828: PREFER_PKGSRC= yes
5829: PREFER_NATIVE= getopt skey tcp_wrappers
5830: </pre>
1.87 wiz 5831: <p>A package <span class="emphasis"><em>must</em></span> have a
5832: <code class="filename">builtin.mk</code>
5833: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5834: otherwise it is simply ignored in that list.</p>
1.75 rillig 5835: </div>
5836: </div>
5837: </div>
5838: <div class="chapter" lang="en">
5839: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5840: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75 rillig 5841: <div class="toc">
5842: <p><b>Table of Contents</b></p>
5843: <dl>
1.90 rillig 5844: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
1.75 rillig 5845: <dd><dl>
1.90 rillig 5846: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
5847: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75 rillig 5848: </dl></dd>
1.90 rillig 5849: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75 rillig 5850: <dd><dl>
1.90 rillig 5851: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5852: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
5853: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
5854: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
5855: </dl></dd>
5856: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
5857: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
5858: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
5859: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
5860: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
5861: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
5862: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75 rillig 5863: </dl>
5864: </div>
5865: <p>This chapter describes the framework known as
5866: <code class="literal">pkginstall</code>, whose key features are:</p>
5867: <div class="itemizedlist"><ul type="disc">
5868: <li><p>Generic installation and manipulation of directories and files
5869: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5870: <li><p>Automatic handling of configuration files during installation,
5871: provided that packages are correctly designed.</p></li>
5872: <li><p>Generation and installation of system startup scripts.</p></li>
5873: <li><p>Registration of system users and groups.</p></li>
5874: <li><p>Registration of system shells.</p></li>
5875: <li><p>Automatic updating of fonts databases.</p></li>
5876: </ul></div>
5877: <p>The following sections inspect each of the above points in detail.</p>
5878: <p>You may be thinking that many of the things described here could be
5879: easily done with simple code in the package's post-installation target
5880: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5881: as the code in them is only executed when building from source. Machines
5882: using binary packages could not benefit from it at all (as the code itself
5883: could be unavailable). Therefore, the only way to achieve any of the items
5884: described above is by means of the installation scripts, which are
5885: automatically generated by pkginstall.</p>
5886: <div class="sect1" lang="en">
5887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5888: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5889: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5890: of files and directories that belong to a package. The names used in it
1.76 rillig 5891: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5892: which means that it cannot register files outside this directory (absolute
5893: path names are not allowed). Despite this restriction, some packages need
5894: to install files outside this location; e.g., under
1.76 rillig 5895: <code class="filename">${VARBASE}</code> or
1.87 wiz 5896: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5897: is to create such files during installation time by using
5898: installation scripts.</p>
5899: <p>The generic installation scripts are shell scripts that can
5900: contain arbitrary code. The list of scripts to execute is taken from
5901: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5902: <code class="filename">INSTALL</code>. A similar variable exists for package
5903: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5904: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5905: commands, so they have the potential to create and manage files
5906: anywhere in the file system.</p>
5907: <p>Using these general installation files is not recommended, but
5908: may be needed in some special cases. One reason for avoiding them is
5909: that the user has to trust the packager that there is no unwanted or
5910: simply erroneous code included in the installation script. Also,
5911: previously there were many similar scripts for the same functionality,
5912: and fixing a common error involved finding and changing all of
5913: them.</p>
5914: <p>The pkginstall framework offers another, standardized way. It
5915: provides generic scripts to abstract the manipulation of such files
5916: and directories based on variables set in the package's
5917: <code class="filename">Makefile</code>. The rest of this section describes
5918: these variables.</p>
1.75 rillig 5919: <div class="sect2" lang="en">
5920: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5921: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5922: <p>The following variables can be set to request the creation of
5923: directories anywhere in the file system:</p>
5924: <div class="itemizedlist"><ul type="disc">
5925: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5926: contain a list of directories that should be created and should attempt
5927: to be destroyed by the installation scripts. The difference between
5928: the two is that the latter prompts the administrator to remove any
5929: directories that may be left after deinstallation (because they were
5930: not empty), while the former does not.</p></li>
5931: <li>
5932: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5933: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5934: which directories should be created and should attempt to be destroyed
5935: by the installation scripts. Each tuple holds the following values,
5936: separated by spaces: the directory name, its owner, its group and its
5937: numerical mode. For example:</p>
5938: <pre class="programlisting">
1.100 rillig 5939: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5940: </pre>
1.75 rillig 5941: <p>The difference between the two is exactly the same as their
5942: non-<code class="varname">PERMS</code> counterparts.</p>
5943: </li>
5944: </ul></div>
5945: </div>
5946: <div class="sect2" lang="en">
5947: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5948: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5949: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5950: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5951: To overcome this problem, the only solution is to extract the file in the
5952: known place (i.e., inside the installation prefix) and copy it to the
5953: appropriate location during installation (done by the installation scripts
5954: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5955: file</em></span> in the following paragraphs, which describe the variables
5956: that can be used to automatically and consistently handle files outside the
5957: installation prefix:</p>
5958: <div class="itemizedlist"><ul type="disc">
5959: <li>
5960: <p><code class="varname">CONF_FILES</code> and
5961: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5962: During installation time, the master file is copied to the target one
5963: if and only if the latter does not exist. Upon deinstallation, the
5964: target file is removed provided that it was not modified by the
5965: installation.</p>
5966: <p>The difference between the two is that the latter prompts the
5967: administrator to remove any files that may be left after
5968: deinstallation (because they were not empty), while the former does
5969: not.</p>
5970: </li>
5971: <li>
5972: <p><code class="varname">CONF_FILES_PERMS</code> and
5973: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5974: files as well as their target locations. For each of them, it also
5975: specifies their owner, their group and their numeric permissions, in
5976: this order. For example:</p>
5977: <pre class="programlisting">
1.100 rillig 5978: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5979: </pre>
1.75 rillig 5980: <p>The difference between the two is exactly the same as their
5981: non-<code class="varname">PERMS</code> counterparts.</p>
5982: </li>
5983: </ul></div>
5984: </div>
5985: </div>
5986: <div class="sect1" lang="en">
5987: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5988: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75 rillig 5989: <p>Configuration files are special in the sense that they are installed
5990: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5991: need special treatment during installation (most of which is automated by
5992: pkginstall). The main concept you must bear in mind is that files marked
5993: as configuration files are automatically copied to the right place (somewhere
5994: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5995: and only if</em></span> they didn't exist before. Similarly, they will not
5996: be removed if they have local modifications. This ensures that
5997: administrators never lose any custom changes they may have made.</p>
5998: <div class="sect2" lang="en">
5999: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6000: <a name="conf-files-sysconfdir"></a>14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75 rillig 6001: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
6002: specifies where configuration files shall be installed. Its contents are
6003: set based upon the following variables:</p>
6004: <div class="itemizedlist"><ul type="disc">
6005: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 6006: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 6007: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 6008: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 6009: Packages must not use it directly.</p></li>
6010: <li>
6011: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
6012: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
6013: for the package being built shall be installed. The definition of this
6014: variable only makes sense in the package's
1.76 rillig 6015: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 6016: <p>As an example, consider the Apache package,
1.91 rillig 6017: <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 6018: configuration files under the
1.76 rillig 6019: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 6020: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
6021: Makefile.</p>
6022: </li>
6023: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
6024: variable that holds this package's configuration directory (if
6025: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
6026: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
6027: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
6028: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
6029: directory where the configuration files for the package identified by
6030: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
6031: </ul></div>
6032: <p>Based on the above variables, pkginstall determines the value of
6033: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6034: variable that can be used within a package to refer to its configuration
6035: directory. The algorithm used to set its value is basically the
6036: following:</p>
6037: <div class="orderedlist"><ol type="1">
6038: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
6039: its value is used.</p></li>
6040: <li><p>If the previous variable is not defined but
6041: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 6042: <code class="filename">Makefile</code>, the resulting value is
6043: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 6044: <li><p>Otherwise, it is set to
1.76 rillig 6045: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 6046: </ol></div>
1.76 rillig 6047: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90 rillig 6048: automatically added to <code class="filename">OWN_DIRS</code>. See <a href="#dirs-outside-prefix" title="14.1.1. Directory manipulation">Section 14.1.1, “Directory manipulation”</a> what this means.</p>
1.75 rillig 6049: </div>
6050: <div class="sect2" lang="en">
6051: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6052: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 6053: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6054: known place, you need to teach each package where it shall install its
6055: files. In some cases you will have to patch the package Makefiles to
6056: achieve it. If you are lucky, though, it may be as easy as passing an
6057: extra flag to the configuration script; this is the case of GNU Autoconf-
6058: generated files:</p>
6059: <pre class="programlisting">
1.100 rillig 6060: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 6061: </pre>
1.75 rillig 6062: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6063: for</em></span> its configuration files, not where they will be originally
6064: installed (although the difference is never explicit,
6065: unfortunately).</p>
6066: </div>
6067: <div class="sect2" lang="en">
6068: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6069: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6070: <p>As said before, pkginstall automatically handles configuration files.
6071: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6072: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6073: directly</strong></span>. Bad news is that many software installation scripts
6074: will, out of the box, mess with the contents of that directory. So what is
6075: the correct procedure to fix this issue?</p>
6076: <p>You must teach the package (usually by manually patching it) to
6077: install any configuration files under the examples hierarchy,
1.76 rillig 6078: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6079: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6080: has the original copies available.</p>
6081: <p>Once the required configuration files are in place (i.e., under the
6082: examples hierarchy), the pkginstall framework can use them as master copies
6083: during the package installation to update what is in
1.76 rillig 6084: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6085: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90 rillig 6086: used. Check out <a href="#files-outside-prefix" title="14.1.2. File manipulation">Section 14.1.2, “File manipulation”</a> for information
1.75 rillig 6087: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6088: <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 6089: <pre class="programlisting">
1.100 rillig 6090: EGDIR= ${PREFIX}/share/doc/mutt/samples
6091: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6092: </pre>
1.75 rillig 6093: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6094: package and has no meaning outside it.</p>
6095: </div>
6096: <div class="sect2" lang="en">
6097: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6098: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6099: <p>The automatic copying of config files can be toggled by setting the
6100: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6101: installation.</p>
6102: </div>
6103: </div>
6104: <div class="sect1" lang="en">
6105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6106: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75 rillig 6107: <p>System startup scripts are special files because they must be
6108: installed in a place known by the underlying OS, usually outside the
1.90 rillig 6109: installation prefix. Therefore, the same rules described in <a href="#files-and-dirs-outside-prefix" title="14.1. Files and directories outside the installation prefix">Section 14.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.75 rillig 6110: can be used. However, pkginstall provides a special mechanism to handle
6111: these files.</p>
6112: <p>In order to provide system startup scripts, the package has
6113: to:</p>
6114: <div class="orderedlist"><ol type="1">
1.76 rillig 6115: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6116: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6117: <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 6118: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6119: <li>
6120: <p>Tell pkginstall to handle it, appending the name of the script,
6121: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6122: Continuing the previous example:</p>
6123: <pre class="programlisting">
1.100 rillig 6124: RCD_SCRIPTS+= cupsd
1.1 grant 6125: </pre>
1.75 rillig 6126: </li>
6127: </ol></div>
6128: <p>Once this is done, pkginstall will do the following steps for each
6129: script in an automated fashion:</p>
6130: <div class="orderedlist"><ol type="1">
6131: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6132: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6133: variable.</p></li>
6134: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6135: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6136: that this master file must be explicitly registered in the
1.76 rillig 6137: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6138: <li><p>Add code to the installation scripts to copy the startup script
6139: from the examples hierarchy into the system-wide startup scripts
6140: directory.</p></li>
6141: </ol></div>
6142: <div class="sect2" lang="en">
6143: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6144: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6145: <p>The automatic copying of config files can be toggled by setting the
6146: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6147: installation. Note that the scripts will be always copied inside the
1.76 rillig 6148: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6149: matter what the value of this variable is.</p>
6150: </div>
6151: </div>
6152: <div class="sect1" lang="en">
6153: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6154: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75 rillig 6155: <p>If a package needs to create special users and/or groups during
6156: installation, it can do so by using the pkginstall framework.</p>
6157: <p>Users can be created by adding entries to the
6158: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6159: syntax:</p>
6160: <pre class="programlisting">
1.100 rillig 6161: user:group
1.1 grant 6162: </pre>
1.87 wiz 6163: <p>Further specification of user details may be done by setting
6164: per-user variables.
6165: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6166: numeric UID for the user.
6167: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6168: user's description or comment.
6169: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6170: user's home directory, and defaults to
6171: <code class="filename">/nonexistent</code> if not specified.
6172: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6173: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6174: not specified.</p>
1.75 rillig 6175: <p>Similarly, groups can be created by adding entries to the
6176: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6177: <pre class="programlisting">
1.100 rillig 6178: group
1.1 grant 6179: </pre>
1.93 rillig 6180: <p>The numeric GID of the group may be set by defining
1.75 rillig 6181: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6182: <p>If a package needs to create the users and groups at an earlier
6183: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6184: either <code class="literal">configure</code> or <code class="literal">build</code> to
6185: indicate the phase before which the users and groups are created. In
6186: this case, the numeric UIDs and GIDs of the created users and groups
6187: are automatically hardcoded into the final installation scripts.</p>
6188: </div>
6189: <div class="sect1" lang="en">
6190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6191: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75 rillig 6192: <p>Packages that install system shells should register them in the shell
1.76 rillig 6193: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6194: administrator. This must be done from the installation scripts to keep
6195: binary packages working on any system. pkginstall provides an easy way to
6196: accomplish this task.</p>
6197: <p>When a package provides a shell interpreter, it has to set the
6198: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6199: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6200: 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 6201: <pre class="programlisting">
1.100 rillig 6202: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6203: </pre>
1.75 rillig 6204: <div class="sect2" lang="en">
6205: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6206: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6207: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6208: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6209: environment variable to <code class="literal">NO</code>.</p>
6210: </div>
6211: </div>
6212: <div class="sect1" lang="en">
6213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6214: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75 rillig 6215: <p>Packages that install X11 fonts should update the database files
6216: that index the fonts within each fonts directory. This can easily be
6217: accomplished within the pkginstall framework.</p>
6218: <p>When a package installs X11 fonts, it must list the directories in
6219: which fonts are installed in the
6220: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6221: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6222: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6223: installation scripts to run the appropriate commands to update the fonts
6224: database files within each of those directories. For convenience, if the
6225: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6226: 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 6227: <pre class="programlisting">
1.100 rillig 6228: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6229: </pre>
1.75 rillig 6230: <div class="sect2" lang="en">
6231: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6232: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6233: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6234: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6235: environment variable to <code class="literal">NO</code>.</p>
6236: </div>
6237: </div>
6238: </div>
6239: <div class="chapter" lang="en">
6240: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6241: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75 rillig 6242: <div class="toc">
6243: <p><b>Table of Contents</b></p>
6244: <dl>
1.90 rillig 6245: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
6246: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
6247: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75 rillig 6248: </dl>
6249: </div>
6250: <p>Many packages have the ability to be built to support different
1.76 rillig 6251: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6252: in pkgsrc that provides generic handling of those options that
6253: determine different ways in which the packages can be built. It's
6254: possible for the user to specify exactly which sets of options will be
6255: built into a package or to allow a set of global default options
6256: apply.</p>
6257: <div class="sect1" lang="en">
6258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6259: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75 rillig 6260: <p>Global default options are listed in
6261: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6262: that should be built into every package if that option is supported.
1.76 rillig 6263: This variable should be set in <code class="filename">/etc/mk.conf</code>.</p>
1.75 rillig 6264: </div>
6265: <div class="sect1" lang="en">
6266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 6267: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code>
6268: </h2></div></div></div>
1.75 rillig 6269: <p>The following example shows how
1.76 rillig 6270: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6271: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6272: <code class="filename">Makefile</code>, or in a file,
6273: e.g. <code class="filename">options.mk</code>, that is included by the
6274: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6275: <pre class="programlisting">
1.100 rillig 6276: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6277: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6278: PKG_OPTIONS_OPTIONAL_GROUPS= database
6279: PKG_OPTIONS_GROUP.database= mysql pgsql
6280: PKG_SUGGESTED_OPTIONS= wibble-foo
6281: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6282: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6283:
6284: .include "../../mk/bsd.prefs.mk"
6285:
6286: # this package was previously named wibble2
6287: .if defined(PKG_OPTIONS.wibble2)
6288: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6289: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6290: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6291: .endif
6292:
6293: .include "../../mk/bsd.options.mk"
6294:
6295: # Package-specific option-handling
6296:
6297: ###
6298: ### FOO support
6299: ###
6300: .if !empty(PKG_OPTIONS:Mwibble-foo)
6301: CONFIGURE_ARGS+= --enable-foo
6302: .endif
6303:
6304: ###
6305: ### LDAP support
6306: ###
6307: .if !empty(PKG_OPTIONS:Mldap)
6308: . include "../../databases/openldap-client/buildlink3.mk"
6309: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6310: .endif
6311:
6312: ###
6313: ### database support
6314: ###
6315: .if !empty(PKG_OPTIONS:Mmysql)
6316: . include "../../mk/mysql.buildlink3.mk"
6317: .endif
6318: .if !empty(PKG_OPTIONS:Mpgsql)
6319: . include "../../mk/pgsql.buildlink3.mk"
6320: .endif
1.75 rillig 6321: </pre>
6322: <p>The first section contains the information about which build
6323: options are supported by the package, and any default options settings
6324: if needed.</p>
6325: <div class="orderedlist"><ol type="1">
6326: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6327: <a 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
6328: options. It should be set to
1.78 rillig 6329: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6330: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6331: at the point where the options are processed.</p></li>
1.75 rillig 6332: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6333: build options supported by the package.</p></li>
6334: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6335: list of names of groups of mutually exclusive options. The options in
6336: each group are listed in
6337: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6338: The most specific setting of any option from the group takes
6339: precedence over all other options in the group. Options from the
6340: groups will be automatically added to
6341: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6342: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6343: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6344: packages will fail if no option from the group is
6345: selected.</p></li>
6346: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6347: of names of sets of options. At least one option from each set must
6348: be selected. The options in each set are listed in
6349: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6350: Options from the sets will be automatically added to
6351: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6352: fail if no option from the set is selected.</p></li>
6353: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6354: build options which are enabled by default.</p></li>
6355: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6356: of
6357: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.76 rillig 6358: pairs that map legacy <code class="filename">/etc/mk.conf</code> variables to
1.75 rillig 6359: their option counterparts. Pairs should be added with
6360: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6361: warning will be issued if the user uses a legacy
6362: variable.</p></li>
6363: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6364: of
6365: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6366: pairs that map options that have been renamed to their new
6367: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6368: the listing of global legacy options. A warning will be issued if
6369: the user uses a legacy option.</p></li>
6370: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6371: options implied by deprecated variables used. This can be used for
6372: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6373: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6374: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6375: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6376: a list of warnings about deprecated variables or options used, and
6377: what to use instead.</p></li>
6378: </ol></div>
6379: <p>A package should never modify
6380: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6381: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6382: To suggest a default set of options, use
6383: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6384: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6385: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6386: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6387: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6388: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6389: happen with platform-specific options if none of them is supported on
6390: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6391: empty list and the package is otherwise treated as not using the
6392: options framework.</p>
1.76 rillig 6393: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6394: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6395: build options, properly filtered to remove unsupported and duplicate
6396: options.</p>
6397: <p>The remaining sections contain the logic that is specific to
6398: each option. The correct way to check for an option is to check
6399: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6400: <pre class="programlisting">
1.100 rillig 6401: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6402: </pre>
6403: </div>
6404: <div class="sect1" lang="en">
6405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6406: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75 rillig 6407: <p>Options that enable similar features in different packages (like
6408: optional support for a library) should use a common name in all
6409: packages that support it (like the name of the library). If another
6410: package already has an option with the same meaning, use the same
6411: name.</p>
6412: <p>Options that enable features specific to one package, where it's
6413: unlikely that another (unrelated) package has the same (or a similar)
6414: optional feature, should use a name prefixed with
6415: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6416: <p>If a group of related packages share an optional feature
6417: specific to that group, prefix it with the name of the
6418: “<span class="quote">main</span>” package
6419: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6420: <p>For new options, add a line to
1.76 rillig 6421: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6422: fields, separated by tab. The first field is the option name, the
6423: second its description. The description should be a whole sentence
6424: (starting with an uppercase letter and ending with a period) that
6425: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6426: support.</span>” The file is sorted by option names.</p>
6427: </div>
6428: </div>
6429: <div class="chapter" lang="en">
6430: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6431: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75 rillig 6432: <div class="toc">
6433: <p><b>Table of Contents</b></p>
6434: <dl>
1.90 rillig 6435: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
6436: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
6437: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
6438: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
6439: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6440: <dd><dl>
6441: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
6442: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
6443: </dl></dd>
6444: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6445: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6446: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6447: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6448: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6449: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6450: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6451: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6452: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6453: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6454: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
6455: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75 rillig 6456: </dl>
6457: </div>
6458: <div class="sect1" lang="en">
6459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6460: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75 rillig 6461: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6462: built. Building a package is separated into different
6463: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6464: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6465: described in the following sections. Each phase is splitted into
6466: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6467: containing phase, prefixed by one of <code class="varname">pre-</code>,
6468: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6469: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6470: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6471: <p>Never override the regular targets (like
6472: <code class="varname">fetch</code>), if you have to, override the
6473: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6474: <p>The basic steps for building a program are always the same. First
1.87 wiz 6475: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6476: the local system and then extracted. After any pkgsrc-specific patches
6477: to compile properly are applied, the software can be configured, then
6478: built (usually by compiling), and finally the generated binaries, etc.
6479: can be put into place on the system.</p>
1.97 rillig 6480: <p>To get more details about what is happening at each step,
6481: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6482: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6483: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6484: </div>
6485: <div class="sect1" lang="en">
6486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6487: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75 rillig 6488: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6489: the next section, here's a brief discussion on where programs are
6490: installed, and which variables influence this.</p>
1.75 rillig 6491: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6492: where all files of the final program shall be installed. It is
6493: usually set to <code class="varname">LOCALBASE</code>
6494: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6495: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6496: <code class="varname">PREFIX</code> needs to be put
6497: into the various places in the program's source where paths to
1.90 rillig 6498: these files are encoded. See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> and <a href="#fixes.libtool" title="18.3.1. Shared libraries - libtool">Section 18.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.75 rillig 6499: <p>When choosing which of these variables to use,
1.87 wiz 6500: follow the following rules:</p>
1.75 rillig 6501: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6502: <li><p><code class="varname">PREFIX</code> always points to the location
6503: where the current pkg will be installed. When referring to a
6504: pkg's own installation path, use
6505: “<span class="quote">${PREFIX}</span>”.</p></li>
6506: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6507: are installed. If you need to construct a -I or -L argument
6508: to the compiler to find includes and libraries installed by
6509: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6510: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6511: installed all packages in <code class="filename">/usr/local</code>. As
6512: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6513: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6514: <li><p><code class="varname">X11BASE</code> is where the actual X11
6515: distribution (from xsrc, etc.) is installed. When looking for
6516: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6517: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6518: <li>
6519: <p>X11-based packages are special in that they may be
6520: installed in either <code class="varname">X11BASE</code> or
6521: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6522: <p>Usually, X11 packages should be installed under
1.88 wiz 6523: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6524: will need to include
6525: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6526: request the presence of X11 and to get the right compilation
6527: flags.</p>
1.75 rillig 6528: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6529: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6530: files. These packages are special and they must be placed under
6531: <code class="varname">X11BASE</code>. To accomplish this, set either
6532: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6533: your package.</p>
1.75 rillig 6534: <p>Some notes: If you need
1.87 wiz 6535: to find includes or libraries installed by a pkg that has
6536: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6537: its pkg <code class="filename">Makefile</code>, you need to look in
6538: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6539: <code class="filename">${LOCALBASE}</code>. To force installation of
6540: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6541: <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 6542: is enabled by default.</p>
1.75 rillig 6543: </li>
1.88 wiz 6544: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6545: the installed location of an X11
6546: package. <code class="varname">X11PREFIX</code> will be set to
6547: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6548: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6549: installed.</p></li>
6550: <li>
6551: <p>If xpkgwedge is installed, it is possible to have some
6552: packages installed in <code class="varname">X11BASE</code> and some in
6553: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6554: installed package, the <code class="varname">EVAL_PREFIX</code>
6555: definition can be used. It takes pairs in the format
6556: “<span class="quote">DIRNAME=<package></span>”, and the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
6557: variable <code class="varname">DIRNAME</code> will be set to the prefix
6558: of the installed package <package>, or
6559: “<span class="quote">${X11PREFIX}</span>” if the package is not
6560: installed.</p>
1.75 rillig 6561: <p>This is best illustrated by example.</p>
6562: <p>The following lines are taken from
1.87 wiz 6563: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6564: <pre class="programlisting">
1.100 rillig 6565: EVAL_PREFIX+= GTKDIR=gtk+
6566: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6567: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6568: CONFIGURE_ARGS+= --enable-multibyte
6569: </pre>
1.88 wiz 6570: <p>Specific defaults can be defined for the packages
6571: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6572: definition of the form:</p>
1.75 rillig 6573: <pre class="programlisting">
1.100 rillig 6574: GTKDIR_DEFAULT= ${LOCALBASE}
6575: </pre>
1.75 rillig 6576: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6577: to the first definition in
6578: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6579: </li>
1.76 rillig 6580: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87 wiz 6581: install files according to <a 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
6582: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6583: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6584: </ul></div>
6585: </div>
6586: <div class="sect1" lang="en">
6587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6588: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75 rillig 6589: <p>When building a package, a number of directories is used to store
1.87 wiz 6590: source files, temporary files, pkgsrc-internal files, and so on. These
6591: directories are explained here.</p>
1.75 rillig 6592: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6593: are two common base directories for these relative directories:
6594: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6595: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6596: inside the package itself.</p>
1.75 rillig 6597: <div class="variablelist"><dl>
6598: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6599: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6600: root directory. Generally, you don't need
6601: it.</p></dd>
1.97 rillig 6602: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6603: <dd><p>This is an absolute pathname that points to the
6604: current package.</p></dd>
1.75 rillig 6605: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6606: <dd><p>This is a pathname relative to
1.87 wiz 6607: <code class="varname">PKGSRCDIR</code> that points to the current
6608: package.</p></dd>
1.75 rillig 6609: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6610: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6611: where all work takes place. The distfiles are extracted to this
1.87 wiz 6612: directory. It also contains temporary directories and log files used by
6613: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6614: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6615: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6616: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6617: where the distfiles are extracted. It is usually a direct subdirectory
6618: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6619: that isn't hidden. This variable may be changed by a package
6620: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6621: </dl></div>
6622: </div>
6623: <div class="sect1" lang="en">
6624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6625: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75 rillig 6626: <p>You can run a particular phase by typing <span><strong class="command">make
1.87 wiz 6627: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6628: phase. This will automatically run all phases that are required for this
6629: phase. The default phase is <code class="varname">build</code>, that is, when you
6630: run <span><strong class="command">make</strong></span> without parameters in a package directory,
6631: the package will be built, but not installed.</p>
1.75 rillig 6632: </div>
6633: <div class="sect1" lang="en">
6634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6635: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6636: <p>The first step in building a package is to fetch the
1.88 wiz 6637: distribution files (distfiles) from the sites that are providing
6638: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6639: phase.</p>
1.81 rillig 6640: <div class="sect2" lang="en">
6641: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6642: <a name="build.fetch.what"></a>16.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88 wiz 6643: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6644: defines all URLs from where the distfile, whose name is
6645: derived from the <code class="varname">DISTNAME</code> variable, is
6646: fetched. The more complicated cases are described
6647: below.</p>
6648: <p>The variable <code class="varname">DISTFILES</code> specifies
6649: the list of distfiles that have to be fetched. Its value
6650: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6651: so that most packages don't need to define it at all.
6652: <code class="varname">EXTRACT_SUFX</code> is
6653: <code class="literal">.tar.gz</code> by default, but can be changed
6654: freely. Note that if your package requires additional
6655: distfiles to the default one, you cannot just append the
6656: additional filenames using the <code class="literal">+=</code>
6657: operator, but you have write for example:</p>
1.81 rillig 6658: <pre class="programlisting">
1.100 rillig 6659: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6660: </pre>
1.88 wiz 6661: <p>Each distfile is fetched from a list of sites, usually
6662: <code class="varname">MASTER_SITES</code>. If the package has multiple
6663: <code class="varname">DISTFILES</code> or multiple
6664: <code class="varname">PATCHFILES</code> from different sites, you can
6665: set
6666: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6667: to the list of URLs where the file
6668: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6669: (including the suffix) can be found.</p>
6670: <pre class="programlisting">
1.100 rillig 6671: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6672: DISTFILES+= foo-file.tar.gz
6673: SITES.foo-file.tar.gz= \
6674: http://www.somewhere.com/somehow/ \
6675: http://www.somewhereelse.com/mirror/somehow/
6676: </pre>
1.81 rillig 6677: <p>When actually fetching the distfiles, each item from
1.88 wiz 6678: <code class="varname">MASTER_SITES</code> or
6679: <code class="varname">SITES.*</code> gets the name of each distfile
6680: appended to it, without an intermediate slash. Therefore,
6681: all site values have to end with a slash or other separator
6682: character. This allows for example to set
6683: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6684: that gets the name of the distfile as a parameter. In this
6685: case, the definition would look like:</p>
1.81 rillig 6686: <pre class="programlisting">
1.100 rillig 6687: MASTER_SITES= http://www.example.com/download.cgi?file=
6688: </pre>
1.81 rillig 6689: <p>There are some predefined values for
1.88 wiz 6690: <code class="varname">MASTER_SITES</code>, which can be used in
6691: packages. The names of the variables should speak for
6692: themselves.</p>
6693: <pre class="programlisting">
1.100 rillig 6694: ${MASTER_SITE_APACHE}
6695: ${MASTER_SITE_BACKUP}
6696: ${MASTER_SITE_CYGWIN}
6697: ${MASTER_SITE_DEBIAN}
6698: ${MASTER_SITE_FREEBSD}
6699: ${MASTER_SITE_FREEBSD_LOCAL}
6700: ${MASTER_SITE_GENTOO}
6701: ${MASTER_SITE_GNOME}
6702: ${MASTER_SITE_GNU}
6703: ${MASTER_SITE_GNUSTEP}
6704: ${MASTER_SITE_IFARCHIVE}
6705: ${MASTER_SITE_KDE}
6706: ${MASTER_SITE_MOZILLA}
6707: ${MASTER_SITE_MYSQL}
6708: ${MASTER_SITE_OPENOFFICE}
6709: ${MASTER_SITE_PERL_CPAN}
6710: ${MASTER_SITE_PGSQL}
6711: ${MASTER_SITE_R_CRAN}
6712: ${MASTER_SITE_SOURCEFORGE}
6713: ${MASTER_SITE_SOURCEFORGE_JP}
6714: ${MASTER_SITE_SUNSITE}
6715: ${MASTER_SITE_SUSE}
6716: ${MASTER_SITE_TEX_CTAN}
6717: ${MASTER_SITE_XCONTRIB}
6718: ${MASTER_SITE_XEMACS}
6719: </pre>
1.88 wiz 6720: <p>Some explanations for the less self-explaining ones:
6721: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.93 rillig 6722: for packages that are maintained in <a 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
6723: package source distributions that are maintained in <a 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 6724: <p>If you choose one of these predefined sites, you may
6725: want to specify a subdirectory of that site. Since these
6726: macros may expand to more than one actual site, you
6727: <span class="emphasis"><em>must</em></span> use the following construct to
6728: specify a subdirectory:</p>
1.81 rillig 6729: <pre class="programlisting">
1.100 rillig 6730: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6731: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6732: </pre>
1.81 rillig 6733: <p>Note the trailing slash after the subdirectory
1.88 wiz 6734: name.</p>
1.81 rillig 6735: </div>
6736: <div class="sect2" lang="en">
6737: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6738: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6739: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6740: all the distfiles exist in a local directory
1.93 rillig 6741: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6742: user). If the files do not exist, they are fetched using
6743: commands of the form</p>
1.75 rillig 6744: <pre class="programlisting">
1.100 rillig 6745: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6746: </pre>
1.88 wiz 6747: <p>where <code class="literal">${site}</code> varies through
6748: several possibilities in turn: first,
6749: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6750: sites specified in either <code class="varname">SITES.file</code> if
6751: defined, else <code class="varname">MASTER_SITES</code> or
6752: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6753: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6754: all except the first and the last can be optionally sorted
6755: by the user, via setting either
6756: <code class="varname">MASTER_SORT_RANDOM</code>, and
6757: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6758: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.97 rillig 6759: <p>The distfiles mirror run by the NetBSD Foundation uses the
6760: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6761: distfiles, if they are freely distributable. Packages setting
6762: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6763: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6764: mirrored.</p>
1.81 rillig 6765: </div>
1.75 rillig 6766: </div>
6767: <div class="sect1" lang="en">
6768: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6769: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6770: <p>After the distfile(s) are fetched, their checksum is
6771: generated and compared with the checksums stored in the
6772: distinfo file. If the checksums don't match, the build is
6773: aborted. This is to ensure the same distfile is used for
6774: building, and that the distfile wasn't changed, e.g. by some
6775: malign force, deliberately changed distfiles on the master
6776: distribution site or network lossage.</p>
1.75 rillig 6777: </div>
6778: <div class="sect1" lang="en">
6779: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6780: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6781: <p>When the distfiles are present on the local system, they
1.88 wiz 6782: need to be extracted, as they usually come in the form of some
6783: compressed archive format.</p>
1.75 rillig 6784: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6785: extracted. If you only need some of them, you can set the
6786: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6787: files.</p>
6788: <p>Extracting the files is usually done by a little
1.93 rillig 6789: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6790: already knows how to extract various archive formats, so most
6791: likely you will not need to change anything here. But if you
6792: need, the following variables may help you:</p>
1.75 rillig 6793: <div class="variablelist"><dl>
6794: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6795: <dd><p>Use these variables to override the default
1.88 wiz 6796: options for an extract command, which are defined in
1.93 rillig 6797: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6798: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6799: <dd><p>This variable can be set to
1.93 rillig 6800: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
6801: default value), <code class="literal">pax</code>, or an
1.88 wiz 6802: absolute pathname pointing to the command with which tar
6803: archives should be
6804: extracted.</p></dd>
1.75 rillig 6805: </dl></div>
1.88 wiz 6806: <p>If the <code class="filename">extract</code> program doesn't
6807: serve your needs, you can also override the
6808: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6809: command used for extracting the files. This command is
6810: executed in the <code class="filename">${WRKSRC}</code>
6811: directory. During execution of this command, the shell
6812: variable <code class="varname">extract_file</code> holds the absolute
6813: pathname of the file that is going to be extracted.</p>
1.75 rillig 6814: <p>And if that still does not suffice, you can override the
1.88 wiz 6815: <code class="varname">do-extract</code> target in the package
6816: Makefile.</p>
1.75 rillig 6817: </div>
6818: <div class="sect1" lang="en">
6819: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6820: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6821: <p>After extraction, all the patches named by the
1.88 wiz 6822: <code class="varname">PATCHFILES</code>, those present in the patches
6823: subdirectory of the package as well as in
6824: $LOCALPATCHES/$PKGPATH (e.g.
6825: <code class="filename">/usr/local/patches/graphics/png</code>) are
6826: applied. Patchfiles ending in <code class="filename">.Z</code> or
6827: <code class="filename">.gz</code> are uncompressed before they are
6828: applied, files ending in <code class="filename">.orig</code> or
6829: <code class="filename">.rej</code> are ignored. Any special options to
6830: <a 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
1.90 rillig 6831: <code class="varname">PATCH_DIST_ARGS</code>. See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more details.</p>
1.88 wiz 6832: <p>By default <a 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
6833: it fail if the patches apply with some lines of fuzz. Please
6834: fix (regen) the patches so that they apply cleanly. The
6835: rationale behind this is that patches that don't apply cleanly
6836: may end up being applied in the wrong place, and cause severe
6837: harm there.</p>
1.75 rillig 6838: </div>
6839: <div class="sect1" lang="en">
6840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6841: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6842: <p>This is covered in <a href="#tools" title="Chapter 17. Tools needed for building or running">Chapter 17, <i>Tools needed for building or running</i></a>.
1.88 wiz 6843: </p>
1.75 rillig 6844: </div>
6845: <div class="sect1" lang="en">
6846: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6847: <a name="build.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6848: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6849: linkers. The following variables can be used to tweak the
6850: wrappers.</p>
1.75 rillig 6851: <div class="variablelist"><dl>
6852: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6853: <dd><p>The command used to print progress
1.88 wiz 6854: messages. Does nothing by default. Set to
6855: <code class="literal">${ECHO}</code> to see the progress
6856: messages.</p></dd>
1.75 rillig 6857: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6858: <dd><p>This variable can be set to
1.88 wiz 6859: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6860: depending on whether you want additional information in the
6861: wrapper log file.</p></dd>
1.75 rillig 6862: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6863: <dd><p>This variable can be set to
1.88 wiz 6864: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6865: on whether the wrapper should use its cache, which will
6866: improve the speed. The default value is
6867: <code class="literal">yes</code>, but is forced to
6868: <code class="literal">no</code> if the platform does not support
6869: it.</p></dd>
1.75 rillig 6870: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6871: <dd><p>A list of reordering commands. A reordering
6872: command has the form
6873: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6874: It ensures that that
6875: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6876: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6877: </p></dd>
1.75 rillig 6878: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6879: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6880: investigate further]</p></dd>
1.75 rillig 6881: </dl></div>
6882: </div>
6883: <div class="sect1" lang="en">
6884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6885: <a name="build.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6886: <p>Most pieces of software need information on the header
6887: files, system calls, and library routines which are available
6888: on the platform they run on. The process of determining this
6889: information is known as configuration, and is usually
6890: automated. In most cases, a script is supplied with the
6891: distfiles, and its invocation results in generation of header
6892: files, Makefiles, etc.</p>
6893: <p>If the package contains a configure script, this can be
6894: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6895: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6896: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6897: “<span class="quote">yes</span>” instead. What happens in the
6898: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6899: <pre class="programlisting">
1.100 rillig 6900: .for d in ${CONFIGURE_DIRS}
6901: cd ${WRKSRC} \
6902: && cd ${d} \
6903: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6904: .endfor
6905: </pre>
1.88 wiz 6906: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6907: “<span class="quote">.</span>”) is a list of pathnames relative to
6908: <code class="varname">WRKSRC</code>. In each of these directories, the
6909: configure script is run with the environment
6910: <code class="varname">CONFIGURE_ENV</code> and arguments
6911: <code class="varname">CONFIGURE_ARGS</code>. The variables
6912: <code class="varname">CONFIGURE_ENV</code>,
6913: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6914: “<span class="quote">./configure</span>”) and
6915: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6916: package.</p>
6917: <p>If the program uses an <code class="filename">Imakefile</code>
6918: for configuration, the appropriate steps can be invoked by
6919: setting <code class="varname">USE_IMAKE</code> to
6920: “<span class="quote">yes</span>”. (If you only want the package installed in
6921: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6922: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6923: xmkmf's environment by adding them to the
6924: <code class="varname">SCRIPTS_ENV</code> variable.</p>
6925: <p>If there is no configure step at all, set
6926: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6927: </div>
6928: <div class="sect1" lang="en">
6929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6930: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6931: <p>For building a package, a rough equivalent of the
6932: following code is executed.</p>
1.75 rillig 6933: <pre class="programlisting">
1.100 rillig 6934: .for d in ${BUILD_DIRS}
6935: cd ${WRKSRC} \
6936: && cd ${d} \
6937: && env ${MAKE_ENV} \
6938: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6939: -f ${MAKE_FILE} \
6940: ${BUILD_TARGET}
6941: .endfor
6942: </pre>
1.88 wiz 6943: <p><code class="varname">BUILD_DIRS</code> (default:
6944: “<span class="quote">.</span>”) is a list of pathnames relative to
6945: <code class="varname">WRKSRC</code>. In each of these directories,
6946: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6947: <code class="varname">MAKE_ENV</code> and arguments
6948: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6949: <code class="varname">MAKE_ENV</code>,
6950: <code class="varname">BUILD_MAKE_FLAGS</code>,
6951: <code class="varname">MAKE_FILE</code> and
6952: <code class="varname">BUILD_TARGET</code> may all be changed by the
6953: package.</p>
1.75 rillig 6954: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6955: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6956: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6957: default value of <code class="varname">MAKE_FILE</code> is
6958: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6959: defaults to “<span class="quote">all</span>”.</p>
1.97 rillig 6960: <p>If there is no build step at all, set
6961: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6962: </div>
6963: <div class="sect1" lang="en">
6964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6965: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6966: <p>[TODO]</p>
6967: </div>
6968: <div class="sect1" lang="en">
6969: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6970: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6971: <p>Once the build stage has completed, the final step is to
1.88 wiz 6972: install the software in public directories, so users can
6973: access the programs and files.</p>
1.75 rillig 6974: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6975: equivalent of the following code is executed. Additionally,
6976: before and after this code, much magic is performed to do
6977: consistency checks, registering the package, and so on.</p>
6978: <pre class="programlisting">
1.100 rillig 6979: .for d in ${INSTALL_DIRS}
6980: cd ${WRKSRC} \
6981: && cd ${d} \
6982: && env ${MAKE_ENV} \
6983: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6984: -f ${MAKE_FILE} \
6985: ${INSTALL_TARGET}
6986: .endfor
6987: </pre>
1.75 rillig 6988: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6989: <span class="emphasis"><em>build</em></span> phase.
6990: <code class="varname">INSTALL_DIRS</code> defaults to
6991: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
6992: is “<span class="quote">install</span>” by default, plus
6993: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
6994: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6995: defined.</p>
1.75 rillig 6996: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6997: variables are useful. They are all variations of the
6998: <a 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
6999: permissions preset. <code class="varname">INSTALL</code> is the plain
7000: install command. The specialized variants, together with their
7001: intended use, are:</p>
1.75 rillig 7002: <div class="variablelist"><dl>
7003: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 7004: <dd><p>directories that contain
7005: binaries</p></dd>
1.75 rillig 7006: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 7007: <dd><p>directories that contain
7008: scripts</p></dd>
1.75 rillig 7009: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 7010: <dd><p>directories that contain shared and static
7011: libraries</p></dd>
1.75 rillig 7012: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 7013: <dd><p>directories that contain data
7014: files</p></dd>
1.75 rillig 7015: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 7016: <dd><p>directories that contain man
7017: pages</p></dd>
1.75 rillig 7018: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 7019: <dd><p>binaries that can be stripped from debugging
7020: symbols</p></dd>
1.75 rillig 7021: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 7022: <dd><p>binaries that cannot be
7023: stripped</p></dd>
1.75 rillig 7024: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 7025: <dd><p>game
7026: binaries</p></dd>
1.75 rillig 7027: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 7028: <dd><p>shared and static
7029: libraries</p></dd>
1.75 rillig 7030: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7031: <dd><p>data files</p></dd>
7032: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 7033: <dd><p>data files for
7034: games</p></dd>
1.75 rillig 7035: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7036: <dd><p>man pages</p></dd>
7037: </dl></div>
7038: <p>Some other variables are:</p>
7039: <div class="variablelist"><dl>
7040: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7041: <dd><p>A list of directories relative to
1.88 wiz 7042: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 7043: beginning of the <span class="emphasis"><em>install</em></span> phase.
7044: The package is supposed to create all needed directories itself
7045: before installing files to it and list all other directories here.
7046: </p></dd>
1.75 rillig 7047: </dl></div>
1.97 rillig 7048: <p>In the rare cases that a package shouldn't install anything,
7049: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
7050: mostly relevant for packages in the <code class="filename">regress</code>
7051: category.</p>
1.75 rillig 7052: </div>
7053: <div class="sect1" lang="en">
7054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7055: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7056: <p>Once the install stage has completed, a binary package of
7057: the installed files can be built. These binary packages can be
7058: used for quick installation without previous compilation, e.g. by
7059: the <span><strong class="command">make bin-install</strong></span> or by using
7060: <span><strong class="command">pkg_add</strong></span>.</p>
7061: <p>By default, the binary packages are created in
7062: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7063: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7064: one for each category in the <code class="varname">CATEGORIES</code>
7065: variable. <code class="varname">PACKAGES</code> defaults to
7066: <code class="filename">pkgsrc/packages</code>.</p>
1.97 rillig 7067: <p>If there should be no binary package, set
7068: <code class="varname">NO_PACKAGE</code> to “<span class="quote">yes</span>”.
7069: This should only be used in rare cases, like when a package
7070: definitely is only usable on the machine where it is built and even
7071: then, a binary package can be useful.</p>
1.88 wiz 7072: </div>
7073: <div class="sect1" lang="en">
7074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7075: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88 wiz 7076: <p>Once you're finished with a package, you can clean the work
7077: directory by running <span><strong class="command">make clean</strong></span>. If you want
7078: to clean the work directories of all dependencies too, use
7079: <span><strong class="command">make clean-depends</strong></span>.</p>
1.75 rillig 7080: </div>
7081: <div class="sect1" lang="en">
7082: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7083: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75 rillig 7084: <div class="variablelist"><dl>
7085: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7086: <dd><p>For any of the main targets described in the
7087: previous section, two auxiliary targets exist with
1.87 wiz 7088: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7089: prefix for the main target's name. These targets are
1.88 wiz 7090: invoked before and after the main target is called,
7091: allowing extra configuration or installation steps be
7092: performed from a package's Makefile, for example, which
7093: a program's configure script or install target
7094: omitted.</p></dd>
1.75 rillig 7095: <dt><span class="term">do-*</span></dt>
1.88 wiz 7096: <dd><p>Should one of the main targets do the wrong thing,
7097: and should there be no variable to fix this, you can
7098: redefine it with the do-* target. (Note that redefining
7099: the target itself instead of the do-* target is a bad
7100: idea, as the pre-* and post-* targets won't be called
7101: anymore, etc.) You will not usually need to do
7102: this.</p></dd>
1.75 rillig 7103: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7104: <dd>
7105: <p>If you did a <span><strong class="command">make install</strong></span> and
7106: you noticed some file was not installed properly, you
7107: can repeat the installation with this target, which will
7108: ignore the “<span class="quote">already installed</span>” flag.</p>
7109: <p>This is the default value of
7110: <code class="varname">DEPENDS_TARGET</code> except in the case of
7111: <span><strong class="command">make update</strong></span> and <span><strong class="command">make
7112: package</strong></span>, where the defaults are
7113: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7114: respectively.</p>
7115: </dd>
1.75 rillig 7116: <dt><span class="term">deinstall</span></dt>
7117: <dd>
1.88 wiz 7118: <p>This target does a <a 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
7119: current directory, effectively de-installing the
7120: package. The following variables can be used to tune the
7121: behaviour:</p>
1.75 rillig 7122: <div class="variablelist"><dl>
7123: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7124: <dd><p>Add a "-v" to the <a 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>
7125: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7126: <dd><p>Remove all packages that require (depend on)
7127: the given package. This can be used to remove any
7128: packages that may have been pulled in by a given
7129: package, e.g. if <span><strong class="command">make deinstall
1.87 wiz 7130: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7131: <code class="filename">pkgsrc/x11/kde</code>, this is
7132: likely to remove whole KDE. Works by adding
7133: “<span class="quote">-R</span>” to the <a 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>
7134: command line.</p></dd>
1.75 rillig 7135: </dl></div>
7136: </dd>
1.88 wiz 7137: <dt><span class="term">bin-install</span></dt>
7138: <dd><p>Install a binary package from local disk and via FTP
7139: from a list of sites (see the
7140: <code class="varname">BINPKG_SITES</code> variable), and do a
7141: <span><strong class="command">make package</strong></span> if no binary package is
7142: available anywhere. The arguments given to
7143: <span><strong class="command">pkg_add</strong></span> can be set via
7144: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7145: operation, etc.</p></dd>
1.75 rillig 7146: <dt><span class="term">update</span></dt>
7147: <dd>
1.88 wiz 7148: <p>This target causes the current package to be
7149: updated to the latest version. The package and all
7150: depending packages first get de-installed, then current
7151: versions of the corresponding packages get compiled and
7152: installed. This is similar to manually noting which
7153: packages are currently installed, then performing a
7154: series of <span><strong class="command">make deinstall</strong></span> and
7155: <span><strong class="command">make install</strong></span> (or whatever
7156: <code class="varname">UPDATE_TARGET</code> is set to) for these
7157: packages.</p>
7158: <p>You can use the “<span class="quote">update</span>” target to
7159: resume package updating in case a previous <span><strong class="command">make
7160: update</strong></span> was interrupted for some reason.
7161: However, in this case, make sure you don't call
7162: <span><strong class="command">make clean</strong></span> or otherwise remove the
7163: list of dependent packages in <code class="varname">WRKDIR</code>.
7164: Otherwise, you lose the ability to automatically update
7165: the current package along with the dependent packages
7166: you have installed.</p>
7167: <p>Resuming an interrupted <span><strong class="command">make
7168: update</strong></span> will only work as long as the package
7169: tree remains unchanged. If the source code for one of
7170: the packages to be updated has been changed, resuming
7171: <span><strong class="command">make update</strong></span> will most certainly
7172: fail!</p>
7173: <p>The following variables can be used either on the
7174: command line or in <code class="filename">/etc/mk.conf</code> to
7175: alter the behaviour of <span><strong class="command">make
7176: update</strong></span>:</p>
1.75 rillig 7177: <div class="variablelist"><dl>
7178: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7179: <dd><p>Install target to recursively use for the
7180: updated package and the dependent packages.
7181: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7182: set, “<span class="quote">install</span>” otherwise for
7183: <span><strong class="command">make update</strong></span>. Other good
7184: targets are “<span class="quote">package</span>” or
7185: “<span class="quote">bin-install</span>”. Do not set this to
7186: “<span class="quote">update</span>” or you will get stuck in an
7187: endless loop!</p></dd>
1.75 rillig 7188: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7189: <dd><p>Don't clean up after updating. Useful if
7190: you want to leave the work sources of the updated
7191: packages around for inspection or other purposes.
7192: Be sure you eventually clean up the source tree
7193: (see the “<span class="quote">clean-update</span>” target below)
7194: or you may run into troubles with old source code
7195: still lying around on your next
7196: <span><strong class="command">make</strong></span> or <span><strong class="command">make
7197: update</strong></span>.</p></dd>
1.75 rillig 7198: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7199: <dd><p>Deinstall each package before installing
7200: (making <code class="varname">DEPENDS_TARGET</code>). This
7201: may be necessary if the
7202: “<span class="quote">clean-update</span>” target (see below) was
7203: called after interrupting a running <span><strong class="command">make
7204: update</strong></span>.</p></dd>
1.75 rillig 7205: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7206: <dd><p>Allows you to disable recursion and hardcode
7207: the target for packages. The default is
7208: “<span class="quote">update</span>” for the update target,
7209: facilitating a recursive update of prerequisite
7210: packages. Only set
7211: <code class="varname">DEPENDS_TARGET</code> if you want to
7212: disable recursive updates. Use
7213: <code class="varname">UPDATE_TARGET</code> instead to just
7214: set a specific target for each package to be
7215: installed during <span><strong class="command">make update</strong></span>
7216: (see above).</p></dd>
1.75 rillig 7217: </dl></div>
7218: </dd>
7219: <dt><span class="term">clean-update</span></dt>
7220: <dd>
1.88 wiz 7221: <p>Clean the source tree for all packages that would
7222: get updated if <span><strong class="command">make update</strong></span> was called
7223: from the current directory. This target should not be
7224: used if the current package (or any of its depending
7225: packages) have already been de-installed (e.g., after
7226: calling <span><strong class="command">make update</strong></span>) or you may lose
7227: some packages you intended to update. As a rule of
7228: thumb: only use this target <span class="emphasis"><em>before</em></span>
7229: the first time you run <span><strong class="command">make update</strong></span>
7230: and only if you have a dirty package tree (e.g., if you
7231: used <code class="varname">NOCLEAN</code>).</p>
7232: <p>If you are unsure about whether your tree is
7233: clean, you can either perform a <span><strong class="command">make
7234: clean</strong></span> at the top of the tree, or use the
7235: following sequence of commands from the directory of the
7236: package you want to update (<span class="emphasis"><em>before</em></span>
7237: running <span><strong class="command">make update</strong></span> for the first
7238: time, otherwise you lose all the packages you wanted to
7239: update!):</p>
1.87 wiz 7240: <pre class="screen">
7241: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7242: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7243: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7244: </pre>
1.88 wiz 7245: <p>The following variables can be used either on the
7246: command line or in <code class="filename">/etc/mk.conf</code> to
7247: alter the behaviour of <span><strong class="command">make
7248: 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.88 wiz 7251: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
7252: reconstruct the list of directories to update for
7253: this package. Only use this if <span><strong class="command">make
7254: update</strong></span> successfully installed all
7255: packages you wanted to update. Normally, this is
7256: done automatically on <span><strong class="command">make
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
7271: certainly break if you <span><strong class="command">make replace</strong></span> a
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>
7278: <dd><p>This target invokes <a 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
7288: <span><strong class="command">make describe</strong></span> in the packages'
7289: directories. This index file is saved as
7290: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
7291: verbose format by running <span><strong class="command">make
7292: print-index</strong></span>. You can search in it with
7293: <span><strong class="command">make search
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
7296: one by running <span><strong class="command">make show-deps
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
7331: to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
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
7335: “<span class="quote">readme</span>” target (see above), but is to be
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.87 wiz 7365: “<span class="quote">show-host-specific-pkgs</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
7375: if <code class="varname">PKG_DEVELOPER</code> is set in
1.87 wiz 7376: <code class="filename">/etc/mk.conf</code>.</p></dd>
1.75 rillig 7377: <dt><span class="term">print-PLIST</span></dt>
7378: <dd>
7379: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7380: upgraded pkg, this prints out an attempt to generate a
7381: new <code class="filename">PLIST</code> from a <span><strong class="command">find
7382: -newer work/.extract_done</strong></span>. An attempt is made
7383: to care for shared libs etc., but it is
1.87 wiz 7384: <span class="emphasis"><em>strongly</em></span> recommended to review the
7385: result before putting it into
7386: <code class="filename">PLIST</code>. On upgrades, it's useful to
7387: diff the output of this command against an already
7388: existing <code class="filename">PLIST</code> file.</p>
1.88 wiz 7389: <p>If the package installs files via <a 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
7390: other methods that don't update file access times, be
7391: sure to add these files manually to your
1.87 wiz 7392: <code class="filename">PLIST</code>, as the “<span class="quote">find
7393: -newer</span>” command used by this target won't catch
7394: them!</p>
1.90 rillig 7395: <p>See <a href="#print-PLIST" title="12.3. Tweaking output of make print-PLIST">Section 12.3, “Tweaking output of <span><strong class="command">make print-PLIST</strong></span>”</a> for more
1.87 wiz 7396: information on this target.</p>
1.75 rillig 7397: </dd>
7398: <dt><span class="term">bulk-package</span></dt>
7399: <dd>
1.88 wiz 7400: <p>Used to do bulk builds. If an appropriate binary
7401: package already exists, no action is taken. If not, this
7402: target will compile, install and package it (and its
7403: depends, if <code class="varname">PKG_DEPENDS</code> is set
7404: properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, “Configuration”</a>).
7405: After creating the binary package, the sources, the
7406: just-installed package and its required packages are
7407: removed, preserving free disk space.</p>
7408: <p><span class="emphasis"><em>Beware that this target may deinstall
7409: all packages installed on a system!</em></span></p>
1.75 rillig 7410: </dd>
7411: <dt><span class="term">bulk-install</span></dt>
7412: <dd>
1.88 wiz 7413: <p>Used during bulk-installs to install required
7414: packages. If an up-to-date binary package is available,
7415: it will be installed via <a 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,
7416: <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87 wiz 7417: but the installed binary won't be removed.</p>
1.88 wiz 7418: <p>A binary package is considered
7419: “<span class="quote">up-to-date</span>” to be installed via
7420: <a 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>
7421: <div class="itemizedlist"><ul type="disc">
7422: <li><p>None of the package's files
7423: (<code class="filename">Makefile</code>, ...) were modified
7424: since it was built.</p></li>
7425: <li><p>None of the package's required (binary)
7426: packages were modified since it was built.</p></li>
1.75 rillig 7427: </ul></div>
1.88 wiz 7428: <p><span class="emphasis"><em>Beware that this target may deinstall
7429: all packages installed on a system!</em></span></p>
1.75 rillig 7430: </dd>
7431: </dl></div>
7432: </div>
7433: </div>
7434: <div class="chapter" lang="en">
7435: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7436: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7437: <div class="toc">
7438: <p><b>Table of Contents</b></p>
7439: <dl>
1.90 rillig 7440: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
7441: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
7442: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 7443: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7444: </dl>
7445: </div>
1.87 wiz 7446: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7447: by pkgsrc and also for individual packages to define what commands
7448: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7449: or for later run-time of an installed packaged (such as
7450: <code class="varname">DEPENDS</code>).
7451: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7452: package will not be used.</p>
7453: <p>When building a package, the replacement tools are
1.75 rillig 7454: made available in a directory (as symlinks or wrapper scripts)
7455: that is early in the executable search path. Just like the buildlink
1.87 wiz 7456: system, this helps with consistent builds.</p>
7457: <p>A tool may be needed to help build a specific package. For example,
7458: perl, GNU make (gmake) or yacc may be needed.</p>
7459: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7460: tool may be inefficient for building a package with pkgsrc.
7461: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7462: yacc) or a better sed.</p>
7463: <p>The tools used by a package can be listed by running
7464: <span><strong class="command">make show-tools</strong></span>.</p>
1.75 rillig 7465: <div class="sect1" lang="en">
7466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7467: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7468: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7469: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75 rillig 7470: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
7471: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
7472: These can be seen by running:
1.87 wiz 7473: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7474: <p>If a package needs a specific program to build
1.75 rillig 7475: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7476: to define the tools needed.</p>
1.75 rillig 7477: </div>
7478: <div class="sect1" lang="en">
7479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7480: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7481: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7482: and not the native version for a build dependency.
7483: And the :run means that it is used for a
7484: run-time dependencies also (and becomes a DEPENDS).
7485: The default is a build dependency which can be set with
7486: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7487: and pkg-config:build.)</p>
1.75 rillig 7488: <pre class="programlisting">
7489: USE_TOOLS+= mktemp:pkgsrc
7490: USE_TOOLS+= gmake perl:run pkg-config
7491: </pre>
1.87 wiz 7492: <p>When using the tools framework, a
1.75 rillig 7493: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7494: which contains the full path to the appropriate tool. For example,
7495: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7496: on Linux systems.</p>
7497: <p>If you always need a pkgsrc version of the
1.75 rillig 7498: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7499: </p>
7500: </div>
7501: <div class="sect1" lang="en">
7502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7503: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7504: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7505: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7506: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7507: the name of the common tools. For example:</p>
7508: <pre class="programlisting">
7509: .if exists(/usr/bin/bzcat)
7510: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7511: .elif exists(/usr/bin/bzip2)
7512: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7513: .endif
1.69 rillig 7514:
1.75 rillig 7515: TOOLS_PLATFORM.true?= true # shell builtin
7516: </pre>
7517: </div>
1.97 rillig 7518: <div class="sect1" lang="en">
7519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7520: <a name="tools.questions"></a>17.4. Questions regarding the tools</h2></div></div></div>
7521: <div class="qandaset">
7522: <dl>
7523: <dt>17.4.1. <a href="#tools.new">How do I add a new tool?</a>
7524: </dt>
7525: <dt>17.4.2. <a href="#tools.listall">How do I get a list of all available
7526: tools?</a>
7527: </dt>
7528: <dt>17.4.3. <a href="#tools.used">How can I get a list of all the tools that a
7529: package is using while being built? I want to know whether it
7530: uses sed or not.</a>
7531: </dt>
7532: </dl>
7533: <table border="0" summary="Q and A Set">
7534: <col align="left" width="1%">
7535: <tbody>
7536: <tr class="question">
7537: <td align="left" valign="top">
1.101 ! rillig 7538: <a name="tools.new"></a><a name="id2708068"></a><b>17.4.1.</b>
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>
7546: <tr class="question">
7547: <td align="left" valign="top">
1.101 ! rillig 7548: <a name="tools.listall"></a><a name="id2708077"></a><b>17.4.2.</b>
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>
7557: <tr class="question">
7558: <td align="left" valign="top">
1.101 ! rillig 7559: <a name="tools.used"></a><a name="id2708088"></a><b>17.4.3.</b>
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>
7575: <div class="chapter" lang="en">
7576: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7577: <a name="fixes"></a>Chapter 18. 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.90 rillig 7581: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75 rillig 7582: <dd><dl>
1.90 rillig 7583: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
7584: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
7585: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
7586: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
7587: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
7588: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
7589: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
7590: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
7591: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
7592: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
7593: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7594: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7595: </dl></dd>
7596: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7597: <dd><dl>
7598: <dt><span class="sect2"><a href="#no-plain-download">18.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">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
7600: </dl></dd>
7601: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7602: <dd><dl>
7603: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
7604: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7605: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
7606: </dl></dd>
7607: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
7608: <dd><dl>
7609: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
7610: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
7611: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
7612: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
7613: </dl></dd>
7614: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7615: <dd><dl>
7616: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
7617: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
7618: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7619: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
7620: </dl></dd>
7621: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7622: <dd><dl>
7623: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
7624: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100 rillig 7625: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.90 rillig 7626: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
7627: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
7628: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
7629: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
7630: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
7631: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
7632: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
7633: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
7634: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
7635: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
7636: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
7637: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
7638: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
7639: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 7640: emulation</a></span></dt>
1.90 rillig 7641: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
7642: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.75 rillig 7643: </dl></dd>
1.90 rillig 7644: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7645: </dl>
7646: </div>
7647: <div class="sect1" lang="en">
7648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7649: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75 rillig 7650: <div class="sect2" lang="en">
7651: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7652: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7653: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7654: different platforms. As a result, it is important to ensure,
7655: where possible, that packages in pkgsrc are portable. This
7656: chapter mentions some particular details you should pay
7657: attention to while working on pkgsrc.</p>
1.78 rillig 7658: </div>
7659: <div class="sect2" lang="en">
7660: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 7661: <a name="pulling-vars-from-etc-mk.conf"></a>18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code>
7662: </h3></div></div></div>
1.78 rillig 7663: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7664: variables in the file pointed to by <code class="varname">MAKECONF</code>,
7665: which is <code class="filename">/etc/mk.conf</code> by default. When you
7666: want to use those variables in the preprocessor directives of
7667: <a 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
7668: <code class="literal">.for</code>), you need to include the file
7669: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7670: loads the user preferences.</p>
1.78 rillig 7671: <p>But note that some variables may not be completely defined
1.87 wiz 7672: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7673: included, as they may contain references to variables that are
7674: not yet defined. In shell commands this is no problem, since
7675: variables are actually macros, which are only expanded when they
7676: are used. But in the preprocessor directives mentioned above and
7677: in dependency lines (of the form <code class="literal">target:
7678: dependencies</code>) the variables are expanded at load
7679: time.</p>
1.78 rillig 7680: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7681: <h3 class="title">Note</h3>
7682: <p>Currently there is no exhaustive list of all
1.87 wiz 7683: variables that tells you whether they can be used at load time
7684: or only at run time, but it is in preparation.</p>
1.78 rillig 7685: </div>
7686: </div>
7687: <div class="sect2" lang="en">
7688: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7689: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88 wiz 7690: <p>Occasionally, packages require interaction from the user,
7691: and this can be in a number of ways:</p>
1.78 rillig 7692: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7693: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7694: interaction such as entering username/password or accepting a
7695: license on a web page.</p></li>
1.88 wiz 7696: <li><p>When extracting the distfiles, some packages may ask for
7697: passwords.</p></li>
1.78 rillig 7698: <li><p>help to configure the package before it is built</p></li>
7699: <li><p>help during the build process</p></li>
7700: <li><p>help during the installation of a package</p></li>
7701: </ul></div>
1.88 wiz 7702: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7703: provided to notify the pkgsrc mechanism of an interactive stage
7704: which will be needed, and this should be set in the package's
7705: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7706: <pre class="programlisting">
1.100 rillig 7707: INTERACTIVE_STAGE= build
1.87 wiz 7708: </pre>
1.78 rillig 7709: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7710: <pre class="programlisting">
1.100 rillig 7711: INTERACTIVE_STAGE= configure install
1.87 wiz 7712: </pre>
1.88 wiz 7713: <p>The user can then decide to skip this package by setting the
7714: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7715: </div>
7716: <div class="sect2" lang="en">
7717: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7718: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7719: <p>Authors of software can choose the licence under which
7720: software can be copied. This is due to copyright law, and reasons
7721: for license choices are outside the scope of pkgsrc. The pkgsrc
7722: system recognizes that there are a number of licenses which some
7723: users may find objectionable or difficult or impossible to comply
7724: with. The Free Software Foundation has declared some licenses
7725: "Free", and the Open Source Initiative has a definition of "Open
7726: Source". The pkgsrc system, as a policy choice, does not label
7727: packages which have licenses that are Free or Open Source.
7728: However, packages without a license meeting either of those tests
7729: are labeled with a license tag denoting the license. Note that a
7730: package with no license to copy trivially does not meet either the
7731: Free or Open Source test.</p>
7732: <p>For packages which are not Free or Open Source, pkgsrc will
7733: not build the package unless the user has indicated to pkgsrc that
7734: packages with that particular license may be built. Note that
7735: this documentation avoids the term "accepted the license". The
7736: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7737: accidentally building a package with a non-free license;
1.98 wiz 7738: judgement and responsibility remain with the user. (Installation
7739: of binary packages are not currently subject to this mechanism;
7740: this is a bug.)</p>
7741: <p>One might want to only install packages with a BSD license,
7742: or the GPL, and not the other. The pkgsrc license tag mechanism
7743: does not provide a way to do this. It might be possible to put in
7744: tags for free licenses, and have a default
7745: <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
7746: widely viewed as having a very poor ratio of benefit to
7747: work.</p>
1.78 rillig 7748: <p>The license tag mechanism is intended to address
1.87 wiz 7749: copyright-related issues surrounding building, installing and
7750: using a package, and not to address redistribution issues (see
7751: <code class="varname">RESTRICTED</code> and
7752: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7753: definition of licenses for which tags are not needed implies
7754: that packages with redistribution restrictions should have
1.98 wiz 7755: tags, because Free or Open Source programs do not have
7756: redistribution restrictions.</p>
7757: <p>Denoting that a package may be copied according to a
7758: particular license is done by placing the license in
1.87 wiz 7759: <code class="filename">pkgsrc/licenses</code> and setting the
7760: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7761: 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 7762: <pre class="programlisting">
1.100 rillig 7763: LICENSE= xv-license
1.87 wiz 7764: </pre>
7765: <p>When trying to build, the user will get a notice that the
1.98 wiz 7766: package is covered by a license which has not been placed in the
7767: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7768: <pre class="programlisting">
1.100 rillig 7769: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7770: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7771: ===> To view the license, enter "/usr/bin/make show-license".
7772: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7773: ===> ACCEPTABLE_LICENSES+=xv-license
7774: *** Error code 1
1.87 wiz 7775: </pre>
1.78 rillig 7776: <p>The license can be viewed with <span><strong class="command">make
1.98 wiz 7777: show-license</strong></span>, and if the user so chooses, the line
7778: printed above can be added to <code class="filename">/etc/mk.conf</code> to
7779: convey to pkgsrc that it should not in the future fail because of
7780: that license:</p>
1.78 rillig 7781: <pre class="programlisting">
1.100 rillig 7782: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7783: </pre>
1.98 wiz 7784: <p>When adding a package with a new license, the license text
7785: should be added to <code class="filename">pkgsrc/licenses</code> for
7786: displaying. A list of known licenses can be seen in this
1.91 rillig 7787: directory.</p>
1.98 wiz 7788: <p>When the license changes (in a way other than formatting),
7789: please make sure that the new license has a different name (e.g.,
7790: append the version number if it exists, or the date). Just
7791: because a user told pkgsrc to build programs under a previous
7792: version of a license does not mean that pkgsrc should build
1.99 rillig 7793: programs under the new licenses. The higher-level point is that
1.98 wiz 7794: pkgsrc does not evaluate licenses for reasonableness; the only
7795: test is a mechanistic test of whether a particular text has been
7796: approved by either of two bodies.</p>
1.78 rillig 7797: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7798: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7799: is deprecated because it does not crisply refer to a particular
7800: license text. Another problem with such usage is that it does not
7801: enable a user to tell pkgsrc to proceed for a single package
7802: without also telling pkgsrc to proceed for all packages with that
7803: tag.</p>
1.75 rillig 7804: </div>
7805: <div class="sect2" lang="en">
7806: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7807: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7808: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7809: Because a license tag is required unless the package is Free or
7810: Open Source, all packages with restrictions should have license
7811: tags. By declaring the restrictions, package tools can
7812: automatically refrain from e.g. placing binary packages on FTP
7813: sites.</p>
7814: <p>There are four restrictions that may be encoded, which are
7815: the cross product of sources (distfiles) and binaries not being
7816: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7817: language in any license, and because non-Free licenses tend to be
7818: different from each other, pkgsrc adopts a definition of FTP and
7819: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7820: should not be made available over the Internet at no charge.
7821: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7822: made available on some kind of media, together with other source
7823: and binary packages, and which is sold for a distribution charge.
7824: </p>
7825: <p>In order to encode these restrictions, the package system
1.87 wiz 7826: defines five make variables that can be set to note these
7827: restrictions:</p>
1.75 rillig 7828: <div class="itemizedlist"><ul type="disc">
7829: <li>
7830: <p><code class="varname">RESTRICTED</code></p>
7831: <p>This variable should be set whenever a restriction
1.87 wiz 7832: exists (regardless of its kind). Set this variable to a
1.98 wiz 7833: string containing the reason for the restriction. It should
7834: be understood that those wanting to understand the restriction
7835: will have to read the license, and perhaps seek advice of
7836: counsel.</p>
1.75 rillig 7837: </li>
7838: <li>
7839: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7840: <p>Binaries may not be placed on CD-ROM containing other
7841: binary packages, for which a distribution charge may be made.
7842: In this case, set this variable to
7843: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7844: </li>
7845: <li>
7846: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7847: <p>Binaries may not made available on the Internet without
7848: charge. In this case, set this variable to
7849: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7850: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7851: </li>
7852: <li>
7853: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7854: <p>Distfiles may not be placed on CD-ROM, together with
7855: other distfiles, for which a fee may be charged. In this
7856: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7857: </p>
1.75 rillig 7858: </li>
7859: <li>
7860: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7861: <p>Distfiles may not made available via FTP at no charge.
7862: In this case, set this variable to
7863: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7864: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7865: </li>
7866: </ul></div>
7867: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87 wiz 7868: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7869: generic make variables to denote restrictions is deprecated,
7870: because they unconditionally prevent users from generating
7871: binary packages!</p>
1.75 rillig 7872: </div>
7873: <div class="sect2" lang="en">
7874: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7875: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7876: <p>Your package may depend on some other package being present
1.88 wiz 7877: - and there are various ways of expressing this dependency.
7878: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7879: <code class="varname">DEPENDS</code> definitions, the
7880: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7881: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7882: to handle dependencies, and which uses the variables named above.
1.90 rillig 7883: See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7884: <p>The basic difference between the two variables is as
1.87 wiz 7885: follows: The <code class="varname">DEPENDS</code> definition registers
7886: that pre-requisite in the binary package so it will be pulled in
7887: when the binary package is later installed, whilst the
7888: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7889: dependency that is only needed for building the package.</p>
1.75 rillig 7890: <p>This means that if you only need a package present whilst
1.87 wiz 7891: you are building, it should be noted as a
7892: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7893: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7894: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7895: <pre class="programlisting">
1.100 rillig 7896: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7897: </pre>
1.75 rillig 7898: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7899: may include any of the wildcard version numbers recognized by
7900: <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.75 rillig 7901: <div class="orderedlist"><ol type="1">
7902: <li>
7903: <p>If your package needs another package's binaries or
1.87 wiz 7904: libraries to build or run, and if that package has a
7905: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7906: <pre class="programlisting">
1.100 rillig 7907: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7908: </pre>
1.75 rillig 7909: </li>
7910: <li>
7911: <p>If your package needs to use another package to build
1.87 wiz 7912: itself and there is no <code class="filename">buildlink3.mk</code>
7913: file available, use the <code class="varname">BUILD_DEPENDS</code>
7914: definition:</p>
1.75 rillig 7915: <pre class="programlisting">
1.100 rillig 7916: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87 wiz 7917: </pre>
1.75 rillig 7918: </li>
7919: <li>
7920: <p>If your package needs a library with which to link and
1.76 rillig 7921: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7922: available, this is specified using the
7923: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7924: <pre class="programlisting">
1.100 rillig 7925: DEPENDS+= xpm-3.4j:../../graphics/xpm
1.87 wiz 7926: </pre>
1.75 rillig 7927: <p>You can also use wildcards in package dependences:</p>
7928: <pre class="programlisting">
1.100 rillig 7929: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
1.87 wiz 7930: </pre>
1.75 rillig 7931: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7932: creating binary packages. The dependency is checked when
7933: installing the binary package and any package which matches
7934: the pattern will be used. Wildcard dependencies should be
7935: used with care.</p>
1.75 rillig 7936: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7937: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7938: such as “<span class="quote">tk-postgresql</span>” matching a
7939: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7940: <p>Wildcards can also be used to specify that a package
1.87 wiz 7941: will only build against a certain minimum version of a
7942: pre-requisite:</p>
1.75 rillig 7943: <pre class="programlisting">
1.100 rillig 7944: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
1.87 wiz 7945: </pre>
1.75 rillig 7946: <p>This means that the package will build against version
1.87 wiz 7947: 3.5.4 of the tiff library or newer. Such a dependency may
7948: be warranted if, for example, the API of the library has
7949: changed with version 3.5.4 and a package would not compile
7950: against an earlier version of tiff.</p>
1.75 rillig 7951: <p>Please note that such dependencies should only be
1.87 wiz 7952: updated if a package requires a newer pre-requisite, but
1.93 rillig 7953: not to denote recommendations such as
1.87 wiz 7954: ABI changes that do not prevent a package from building
7955: correctly. Such recommendations can be expressed using
7956: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7957: <pre class="programlisting">
1.100 rillig 7958: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
1.87 wiz 7959: </pre>
1.75 rillig 7960: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7961: line, this denotes that while a package will build against
7962: tiff>=3.5.4, at least version 3.6.1 is recommended.
7963: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7964: dependencies unless explicitly ignored (in which case a
7965: warning will be printed).</p>
1.75 rillig 7966: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7967: use the required <code class="varname">DEPENDS</code>, set
7968: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7969: it easier and faster to update packages built using pkgsrc,
7970: since older compatible dependencies can continue to be
7971: used. This is useful for people who watch their rebuilds
7972: very carefully; it is not very good as a general-purpose
7973: hammer. If you use it, you need to be mindful of possible
7974: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7975: <p>Packages that are built with recommendations ignored
1.87 wiz 7976: may not be uploaded to ftp.NetBSD.org by developers and
7977: should not be used across different systems that may have
7978: different versions of binary packages installed.</p>
1.75 rillig 7979: <p>For security fixes, please update the package
1.90 rillig 7980: vulnerabilities file. See <a href="#security-handling" title="18.1.10. Handling packages with security problems">Section 18.1.10, “Handling packages with security problems”</a> for more
1.87 wiz 7981: information.</p>
1.75 rillig 7982: </li>
7983: <li>
7984: <p>If your package needs some executable to be able to run
1.87 wiz 7985: correctly and if there's no
7986: <code class="filename">buildlink3.mk</code> file, this is specified
7987: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 7988: <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 7989: be able to execute the latex binary from the teTeX package
7990: when it runs, and that is specified:</p>
1.75 rillig 7991: <pre class="programlisting">
1.100 rillig 7992: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7993: </pre>
1.75 rillig 7994: <p>The comment about wildcard dependencies from previous
1.87 wiz 7995: paragraph applies here, too.</p>
1.75 rillig 7996: </li>
7997: </ol></div>
7998: <p>If your package needs files from another package to build,
1.87 wiz 7999: add the relevant distribution files to
8000: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 8001: 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 8002: (It relies on the jpeg sources being present in source form
8003: during the build.)</p>
1.75 rillig 8004: </div>
8005: <div class="sect2" lang="en">
8006: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8007: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 8008: <p>Your package may conflict with other packages a user might
1.87 wiz 8009: already have installed on his system, e.g. if your package
1.88 wiz 8010: installs the same set of files as another package in the pkgsrc
8011: tree.</p>
1.75 rillig 8012: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 8013: space-separated list of packages (including version string) your
8014: package conflicts with.</p>
1.91 rillig 8015: <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>
8016: 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 8017: install the same shared library, thus you set in
8018: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8019: <pre class="programlisting">
1.100 rillig 8020: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 8021: </pre>
8022: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 8023: <pre class="programlisting">
1.100 rillig 8024: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 8025: </pre>
1.75 rillig 8026: <p>Packages will automatically conflict with other packages
1.87 wiz 8027: with the name prefix and a different version
8028: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
8029: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 8030: </div>
8031: <div class="sect2" lang="en">
8032: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8033: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 8034: <p>There are several reasons why a package might be
1.88 wiz 8035: instructed to not build under certain circumstances. If the
1.87 wiz 8036: package builds and runs on most platforms, the exceptions
8037: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8038: the package builds and runs on a small handful of platforms,
8039: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8040: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8041: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8042: (OS-version-platform) that can use glob-style
8043: wildcards.</p>
1.88 wiz 8044: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8045: 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 8046: backwards compatible with other versions of the OS, and should be
8047: uploaded to a version specific directory on the FTP server. Mark
8048: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8049: “<span class="quote">yes</span>”. This variable is not currently used by any of
8050: the package system internals, but may be used in the
8051: future.</p>
1.75 rillig 8052: <p>If the package should be skipped (for example, because it
1.87 wiz 8053: provides functionality already provided by the system), set
1.88 wiz 8054: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8055: the package should fail because some preconditions are not met,
8056: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8057: message.</p>
1.75 rillig 8058: </div>
8059: <div class="sect2" lang="en">
8060: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8061: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8062: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8063: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8064: be set in the package Makefile. This will be carried into any
8065: binary package that is made from this pkgsrc entry. A
8066: “<span class="quote">preserved</span>” package will
8067: not be deleted using <a 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
8068: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 8069: </div>
8070: <div class="sect2" lang="en">
8071: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8072: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8073: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8074: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
8075: and after committing that file, use <span><strong class="command">make upload</strong></span>
8076: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 8077: <p>After fixing the vulnerability by a patch, its
1.87 wiz 8078: <code class="varname">PKGREVISION</code> should be increased (this
8079: is of course not necessary if the problem is fixed by using
8080: a newer release of the software).</p>
1.75 rillig 8081: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8082: branch, be sure to submit a pullup request!</p>
1.75 rillig 8083: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8084: semi-automatically by a weekly cron job.</p>
1.75 rillig 8085: </div>
8086: <div class="sect2" lang="en">
8087: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8088: <a name="bumping-pkgrevision"></a>18.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 8089: <p>When making fixes to an existing package it can be useful
1.87 wiz 8090: to change the version number in <code class="varname">PKGNAME</code>. To
8091: avoid conflicting with future versions by the original author, a
8092: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8093: on package versions by setting <code class="varname">PKGREVISION=1</code>
8094: (2, ...). The “<span class="quote">nb</span>” is treated like a
8095: “<span class="quote">.</span>” by the package tools. e.g.</p>
8096: <pre class="programlisting">
1.100 rillig 8097: DISTNAME= foo-17.42
8098: PKGREVISION= 9
1.87 wiz 8099: </pre>
1.75 rillig 8100: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 8101: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8102: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8103: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8104: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8105: <p>When a new release of the package is released, the
1.87 wiz 8106: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8107: minor release of the above package, things should be like:</p>
1.75 rillig 8108: <pre class="programlisting">
1.100 rillig 8109: DISTNAME= foo-17.43
1.87 wiz 8110: </pre>
8111: <p><code class="varname">PKGREVISION</code> should be incremented for any
8112: non-trivial change in the resulting binary package. Without a
8113: <code class="varname">PKGREVISION</code> bump, someone with the previous
8114: version installed has no way of knowing that their package is out
8115: of date. Thus, changes without increasing
8116: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8117: trivial that no reasonable person would want to upgrade", and this
8118: is the rough test for when increasing
8119: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8120: changes that do not merit increasing
8121: <code class="varname">PKGREVISION</code> are:</p>
1.100 rillig 8122: <div class="itemizedlist"><ul type="disc">
8123: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
8124: or comments in Makefile.</p></li>
8125: <li><p>
8126: Changing build variables if the resulting binary package is the same.</p></li>
8127: <li><p>
8128: Changing <code class="filename">DESCR</code>.</p></li>
8129: <li><p>
8130: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8131: </ul></div>
1.87 wiz 8132: <p>Examples of changes that do merit an increase to
8133: <code class="varname">PKGREVISION</code> include:</p>
1.100 rillig 8134: <div class="itemizedlist"><ul type="disc">
8135: <li><p>
8136: Security fixes</p></li>
8137: <li><p>
8138: Changes or additions to a patch file</p></li>
8139: <li><p>
8140: Changes to the <code class="filename">PLIST</code></p></li>
8141: </ul></div>
1.78 rillig 8142: <p>PKGREVISION must also be incremented when dependencies have ABI
8143: changes.</p>
1.75 rillig 8144: </div>
1.79 rillig 8145: <div class="sect2" lang="en">
8146: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8147: <a name="fixes.subst"></a>18.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79 rillig 8148: <p>When you want to replace the same text in multiple files
1.87 wiz 8149: or when the replacement text varies, patches alone cannot help.
8150: This is where the SUBST framework comes in. It provides an
8151: easy-to-use interface for replacing text in files.
8152: Example:</p>
8153: <pre class="programlisting">
1.100 rillig 8154: SUBST_CLASSES+= fix-paths
8155: SUBST_STAGE.fix-paths= pre-configure
8156: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8157: SUBST_FILES.fix-paths= src/*.c
8158: SUBST_FILES.fix-paths+= scripts/*.sh
8159: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8160: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8161: </pre>
1.79 rillig 8162: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8163: that are used to identify the different SUBST blocks that are
8164: defined. The SUBST framework is heavily used by pkgsrc, so it is
8165: important to always use the <code class="literal">+=</code> operator with
8166: this variable. Otherwise some substitutions may be
8167: skipped.</p>
1.79 rillig 8168: <p>The remaining variables of each SUBST block are
1.87 wiz 8169: parameterized with the identifier from the first line
8170: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8171: parameters to a function call.</p>
1.79 rillig 8172: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8173: which the replacement will take place. All combinations of
8174: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8175: <code class="literal">post-</code> together with a phase name are
8176: possible, though only few are actually used. Most commonly used
8177: are <code class="literal">post-patch</code> and
8178: <code class="literal">pre-configure</code>. Of these two,
8179: <code class="literal">pre-configure</code> should be preferred because
8180: then it is possible to run <span><strong class="command">bmake patch</strong></span> and
8181: have the state after applying the patches but before making any
8182: other changes. This is especially useful when you are debugging
8183: a package in order to create new patches for it. Similarly,
8184: <code class="literal">post-build</code> is preferred over
8185: <code class="literal">pre-install</code>, because the install phase should
8186: generally be kept as simple as possible. When you use
8187: <code class="literal">post-build</code>, you have the same files in the
8188: working directory that will be installed later, so you can check
8189: if the substitution has succeeded.</p>
1.79 rillig 8190: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8191: that is printed just before the substitution is done.</p>
1.79 rillig 8192: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8193: globbing patterns that specifies the files in which the
8194: substitution will take place. The patterns are interpreted
8195: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8196: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87 wiz 8197: <a 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
8198: command should be prefixed with <code class="literal">-e</code>, so that
8199: all SUBST blocks look uniform.</p>
1.79 rillig 8200: <p>There are some more variables, but they are so seldomly
1.87 wiz 8201: used that they are only documented in the
8202: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8203: </div>
1.75 rillig 8204: </div>
8205: <div class="sect1" lang="en">
8206: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8207: <a name="fixes.fetch"></a>18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.75 rillig 8208: <div class="sect2" lang="en">
8209: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8210: <a name="no-plain-download"></a>18.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 8211: <p>If you need to download from a dynamic URL you can set
1.87 wiz 8212: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
8213: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8214: with the name of each file to download as an argument, expecting
8215: it to output the URL of the directory from which to download
1.91 rillig 8216: 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 8217: example of this usage.</p>
1.75 rillig 8218: <p>If the download can't be automated, because the user must
1.87 wiz 8219: submit personal information to apply for a password, or must pay
8220: for the source, or whatever, you can set
8221: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8222: displayed to the user before aborting the build. Example:</p>
8223: <pre class="programlisting">
1.100 rillig 8224: FETCH_MESSAGE= "Please download the files"
8225: FETCH_MESSAGE+= " "${DISTFILES:Q}
8226: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8227: </pre>
1.75 rillig 8228: </div>
8229: <div class="sect2" lang="en">
8230: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8231: <a name="modified-distfiles-same-name"></a>18.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 8232: <p>Sometimes authors of a software package make some
1.87 wiz 8233: modifications after the software was released, and they put up a
8234: new distfile without changing the package's version number. If a
8235: package is already in pkgsrc at that time, the checksum will
8236: no longer match. The contents of the new distfile should be
8237: compared against the old one before changing anything, to make
8238: sure the distfile was really updated on purpose, and that
8239: no trojan horse or so crept in.
1.97 rillig 8240: Please mention that the distfiles were compared and what was found
8241: in your commit message.
1.87 wiz 8242: Then, the correct way to work around this is to
8243: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8244: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8245: <code class="varname">DISTFILES</code> and
1.93 rillig 8246: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8247: subdirectory of the local distfiles directory.
8248: (See <a href="#bumping-pkgrevision" title="18.1.11. How to handle incrementing versions when fixing an existing package">Section 18.1.11, “How to handle incrementing versions when fixing an existing package”</a> for more details.)
8249: In case this
1.87 wiz 8250: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8251: including the <code class="filename">nbX</code> suffix) or a date stamp
8252: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8253: Do not forget regenerating the <code class="filename">distinfo</code> file
8254: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8255: path in the filenames.
1.97 rillig 8256: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8257: Furthermore, a mail to the package's authors seems appropriate
8258: telling them that changing distfiles after releases without
8259: changing the file names is not good practice.</p>
1.75 rillig 8260: </div>
8261: </div>
8262: <div class="sect1" lang="en">
8263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8264: <a name="fixes.configure"></a>18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.75 rillig 8265: <div class="sect2" lang="en">
8266: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8267: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8268: <p>pkgsrc supports many different machines, with different
1.87 wiz 8269: object formats like a.out and ELF, and varying abilities to do
8270: shared library and dynamic loading at all. To accompany this,
8271: varying commands and options have to be passed to the
8272: compiler, linker, etc. to get the Right Thing, which can be
8273: pretty annoying especially if you don't have all the machines
8274: at your hand to test things. The
1.91 rillig 8275: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.87 wiz 8276: can help here, as it just “<span class="quote">knows</span>” how to build
8277: both static and dynamic libraries from a set of source files,
8278: thus being platform-independent.</p>
8279: <p>Here's how to use libtool in a package in seven simple
8280: steps:</p>
1.75 rillig 8281: <div class="orderedlist"><ol type="1">
8282: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8283: Makefile.</p></li>
1.75 rillig 8284: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8285: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8286: add it to the definition of <code class="varname">CC</code>, if only
8287: libraries are being built in a given Makefile. This one command
8288: will build both PIC and non-PIC library objects, so you need not
8289: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8290: <li>
8291: <p>For the linking of the library, remove any
1.87 wiz 8292: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8293: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8294: <pre class="programlisting">
1.100 rillig 8295: ${LIBTOOL} --mode=link \
8296: ${CC} -o ${.TARGET:.a=.la} \
8297: ${OBJS:.o=.lo} \
8298: -rpath ${PREFIX}/lib \
8299: -version-info major:minor
1.87 wiz 8300: </pre>
1.75 rillig 8301: <p>Note that the library is changed to have a
1.87 wiz 8302: <code class="filename">.la</code> extension, and the objects are
8303: changed to have a <code class="filename">.lo</code>
8304: extension. Change <code class="varname">OBJS</code> as
8305: necessary. This automatically creates all of the
8306: <code class="filename">.a</code>,
8307: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8308: necessary) in the build directory. Be sure to include
8309: “<span class="quote">-version-info</span>”, especially when major and
8310: minor are zero, as libtool will otherwise strip off the
8311: shared library version.</p>
1.75 rillig 8312: <p>From the libtool manual:</p>
8313: <pre class="programlisting">
1.100 rillig 8314: So, libtool library versions are described by three integers:
1.69 rillig 8315:
1.100 rillig 8316: CURRENT
8317: The most recent interface number that this library implements.
1.69 rillig 8318:
1.100 rillig 8319: REVISION
8320: The implementation number of the CURRENT interface.
1.69 rillig 8321:
1.100 rillig 8322: AGE
8323: The difference between the newest and oldest interfaces that
8324: this library implements. In other words, the library implements
8325: all the interface numbers in the range from number `CURRENT -
8326: AGE' to `CURRENT'.
1.1 grant 8327:
1.100 rillig 8328: If two libraries have identical CURRENT and AGE numbers, then the
8329: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8330: </pre>
1.75 rillig 8331: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8332: different results for a.out and ELF (excluding symlinks)
8333: in only one case. An ELF library of the form
8334: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8335: will have a symlink of
8336: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8337: on an a.out platform. This is handled
8338: automatically.</p>
1.75 rillig 8339: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8340: directory of the library being built.</p>
1.76 rillig 8341: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8342: <code class="filename">.la</code> file, the other files will be
8343: added automatically.</p>
1.75 rillig 8344: </li>
8345: <li>
1.76 rillig 8346: <p>When linking shared object (<code class="filename">.so</code>)
1.87 wiz 8347: files, i.e. files that are loaded via <a 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
8348: shared libraries, use “<span class="quote">-module
8349: -avoid-version</span>” to prevent them getting version
8350: tacked on.</p>
1.76 rillig 8351: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8352: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8353: </li>
8354: <li>
8355: <p>When linking programs that depend on these libraries
1.87 wiz 8356: <span class="emphasis"><em>before</em></span> they are installed, preface
8357: the <a 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 href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with “<span class="quote">${LIBTOOL}
8358: --mode=link</span>”, and it will find the correct
8359: libraries (static or shared), but please be aware that
8360: libtool will not allow you to specify a relative path in
8361: -L (such as “<span class="quote">-L../somelib</span>”), because it
8362: expects you to change that argument to be the
8363: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8364: <pre class="programlisting">
1.100 rillig 8365: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8366: </pre>
1.75 rillig 8367: <p>should be changed to:</p>
8368: <pre class="programlisting">
1.100 rillig 8369: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8370: </pre>
1.75 rillig 8371: <p>and it will do the right thing with the libraries.</p>
8372: </li>
8373: <li>
8374: <p>When installing libraries, preface the <a 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.87 wiz 8375: or <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with “<span class="quote">${LIBTOOL}
8376: --mode=install</span>”, and change the library name to
8377: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8378: <pre class="programlisting">
1.100 rillig 8379: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8380: </pre>
1.76 rillig 8381: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8382: shared library, any needed symlinks, and run
8383: <a 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 8384: </li>
1.76 rillig 8385: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8386: the <code class="filename">.la</code>
8387: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8388: </ol></div>
8389: </div>
8390: <div class="sect2" lang="en">
8391: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8392: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8393: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8394: package Makefile. This will override the package's own libtool
8395: in most cases. For older libtool using packages, libtool is
8396: made by ltconfig script during the do-configure step; you can
8397: check the libtool script location by doing <span><strong class="command">make
8398: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8399: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8400: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8401: default, it is set to “<span class="quote">libtool */libtool
8402: */*/libtool</span>”. If this does not match the location of the
8403: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8404: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8405: libraries built and installed, then use
8406: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8407: <p>If your package makes use of the platform-independent library
1.87 wiz 8408: for loading dynamic shared objects, that comes with libtool
8409: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8410: <p>Some packages use libtool incorrectly so that the package
8411: may not work or build in some circumstances. Some of the more
8412: common errors are:</p>
1.75 rillig 8413: <div class="itemizedlist"><ul type="disc">
8414: <li>
8415: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8416: executable or library. This in itself isn't a problem if one of two things
8417: has been done:</p>
1.75 rillig 8418: <div class="orderedlist"><ol type="1">
8419: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8420: <code class="filename">libfoo.la</code>, not
8421: <code class="filename">foo.la</code></p></li>
1.75 rillig 8422: <li><p>The -dlopen option is used when linking an executable.</p></li>
8423: </ol></div>
8424: </li>
8425: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8426: The function lt_dlinit() should be called and the macro
8427: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8428: executables.</p></li>
1.75 rillig 8429: </ul></div>
8430: </div>
8431: <div class="sect2" lang="en">
8432: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8433: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8434: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8435: to regenerate the configure script and Makefile.in makefile
8436: templates, then they should be executed in a pre-configure
8437: target.</p>
1.75 rillig 8438: <p>For packages that need only autoconf:</p>
8439: <pre class="programlisting">
1.100 rillig 8440: AUTOCONF_REQD= 2.50 # if default version is not good enough
8441: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8442: ...
1.1 grant 8443:
1.100 rillig 8444: pre-configure:
8445: cd ${WRKSRC} && autoconf
1.1 grant 8446:
1.100 rillig 8447: ...
1.87 wiz 8448: </pre>
1.75 rillig 8449: <p>and for packages that need automake and autoconf:</p>
8450: <pre class="programlisting">
1.100 rillig 8451: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8452: USE_TOOLS+= automake # use "automake14" for automake-1.4
8453: ...
8454:
8455: pre-configure:
8456: set -e; cd ${WRKSRC}; \
8457: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8458:
1.100 rillig 8459: ...
1.87 wiz 8460: </pre>
1.75 rillig 8461: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8462: require GNU Make.</p>
1.75 rillig 8463: <p>There are times when the configure process makes
1.87 wiz 8464: additional changes to the generated files, which then causes
8465: the build process to try to re-execute the automake sequence.
8466: This is prevented by touching various files in the configure
8467: stage. If this causes problems with your package you can set
8468: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8469: Makefile.</p>
1.75 rillig 8470: </div>
8471: </div>
8472: <div class="sect1" lang="en">
8473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8474: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87 wiz 8475: <div class="sect2" lang="en">
8476: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8477: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8478: <p>Compilers for the C, C++, and Fortran languages comes with
8479: the NetBSD base system. By default, pkgsrc assumes that a package
8480: is written in C and will hide all other compilers (via the wrapper
1.90 rillig 8481: framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8482: <p>To declare which language's compiler a package needs, set
8483: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8484: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8485: “<span class="quote">fortran</span>” (and any combination). The default is
8486: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8487: written in C++, usually need a C compiler for the configure
8488: phase.</p>
8489: </div>
8490: <div class="sect2" lang="en">
8491: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8492: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87 wiz 8493: <p>If a program is written in Java, use the Java framework in
8494: pkgsrc. The package must include
8495: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8496: provides the following variables:</p>
8497: <div class="itemizedlist"><ul type="disc">
8498: <li><p><code class="varname">USE_JAVA</code> defines if a build
8499: dependency on the JDK is added. If
8500: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8501: there is only a runtime dependency on the JDK. The default is
8502: “<span class="quote">yes</span>”, which also adds a build dependency on the
8503: JDK.</p></li>
8504: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8505: a package needs a Java2 implementation. The supported values
8506: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8507: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8508: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8509: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8510: above. This variable is not set by default.</p></li>
8511: </ul></div>
8512: </div>
8513: <div class="sect2" lang="en">
8514: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8515: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8516: <p>If your package contains interpreted perl scripts, add
8517: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8518: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8519: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8520: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8521: that you want adjusted. Every occurrence of
8522: <code class="filename">*/bin/perl</code> will be replaced with the full
8523: path to the perl executable.</p>
8524: <p>If a particular version of perl is needed, set the
8525: <code class="varname">PERL5_REQD</code> variable to the version number. The
8526: default is “<span class="quote">5.0</span>”.</p>
1.90 rillig 8527: <p>See <a href="#perl-modules" title="18.6.5. Packages installing perl modules">Section 18.6.5, “Packages installing perl modules”</a> for information
1.87 wiz 8528: about handling perl modules.</p>
8529: </div>
8530: <div class="sect2" lang="en">
8531: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8532: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8533: <p>Currently, there is no special handling for other languages
8534: in pkgsrc. If a compiler package provides a
8535: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8536: just add a (build) dependency on the appropriate compiler
8537: package.</p>
8538: </div>
8539: </div>
8540: <div class="sect1" lang="en">
8541: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8542: <a name="fixes.build"></a>18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8543: <p>The most common failures when building a package are that
8544: some platforms do not provide certain header files, functions or
8545: libraries, or they provide the functions in a library that the
8546: original package author didn't know. To work around this, you
8547: can rewrite the source code in most cases so that it does not
8548: use the missing functions or provides a replacement function.</p>
8549: <div class="sect2" lang="en">
8550: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8551: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8552: <p>If a package already comes with a GNU configure script, the
8553: preferred way to fix the build failure is to change the
8554: configure script, not the code. In the other cases, you can
8555: utilize the C preprocessor, which defines certain macros
8556: depending on the operating system and hardware architecture it
8557: compiles for. These macros can be queried using for example
8558: <code class="varname">#if defined(__i386)</code>. Almost every operating
8559: system, hardware architecture and compiler has its own macro.
8560: For example, if the macros <code class="varname">__GNUC__</code>,
8561: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8562: are all defined, you know that you are using NetBSD on an i386
8563: compatible CPU, and your compiler is GCC.</p>
8564: <p>The list of the following macros for hardware and
8565: operating system depends on the compiler that is used. For
8566: example, if you want to conditionally compile code on Solaris,
8567: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8568: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8569: <div class="sect3" lang="en">
8570: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8571: <a name="fixes.build.cpp.os"></a>18.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 8572: <p>To distinguish between 4.4 BSD-derived systems and the
8573: rest of the world, you should use the following code.</p>
8574: <pre class="programlisting">
1.100 rillig 8575: #include <sys/param.h>
8576: #if (defined(BSD) && BSD >= 199306)
8577: /* BSD-specific code goes here */
8578: #else
8579: /* non-BSD-specific code goes here */
8580: #endif
1.75 rillig 8581: </pre>
1.77 rillig 8582: <p>If this distinction is not fine enough, you can also test
8583: for the following macros.</p>
1.75 rillig 8584: <pre class="programlisting">
1.100 rillig 8585: FreeBSD __FreeBSD__
8586: DragonFly __DragonFly__
8587: Interix __INTERIX
8588: IRIX __sgi (TODO: get a definite source for this)
8589: Linux linux, __linux, __linux__
8590: NetBSD __NetBSD__
8591: OpenBSD __OpenBSD__
8592: Solaris sun, __sun
1.75 rillig 8593: </pre>
8594: </div>
8595: <div class="sect3" lang="en">
8596: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8597: <a name="fixes.build.cpp.arch"></a>18.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 8598: <pre class="programlisting">
1.100 rillig 8599: i386 i386, __i386, __i386__
8600: MIPS __mips
8601: SPARC sparc, __sparc
1.75 rillig 8602: </pre>
8603: </div>
8604: <div class="sect3" lang="en">
8605: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8606: <a name="fixes.build.cpp.compiler"></a>18.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 8607: <pre class="programlisting">
1.100 rillig 8608: GCC __GNUC__ (major version), __GNUC_MINOR__
8609: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8610: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8611: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8612: </pre>
8613: </div>
8614: </div>
1.78 rillig 8615: <div class="sect2" lang="en">
8616: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8617: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8618: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8619: combinations of compiler version and architecture and almost
8620: always relation to optimisation being enabled. Common symptoms
8621: are gcc internal errors or never finishing compiling a
1.78 rillig 8622: file.</p>
8623: <p>Typically, a workaround involves testing the
8624: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8625: optimisation for that combination of file,
8626: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8627: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8628: number of examples.</p>
8629: </div>
8630: <div class="sect2" lang="en">
8631: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8632: <a name="undefined-reference"></a>18.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.92 rillig 8633: <p>This error message often means that a package did not
1.78 rillig 8634: link to a shared library it needs. The following functions are
8635: known to cause this error message over and over.</p>
8636: <div class="informaltable">
8637: <a name="undefined-reference-functions"></a><table border="1">
8638: <colgroup>
8639: <col>
8640: <col>
8641: <col>
8642: </colgroup>
8643: <thead><tr>
8644: <th>Function</th>
8645: <th>Library</th>
8646: <th>Affected platforms</th>
8647: </tr></thead>
8648: <tbody>
8649: <tr>
8650: <td>accept, bind, connect</td>
8651: <td>-lsocket</td>
8652: <td>Solaris</td>
8653: </tr>
8654: <tr>
8655: <td>crypt</td>
8656: <td>-lcrypt</td>
8657: <td>DragonFly, NetBSD</td>
8658: </tr>
8659: <tr>
8660: <td>dlopen, dlsym</td>
8661: <td>-ldl</td>
8662: <td>Linux</td>
8663: </tr>
8664: <tr>
8665: <td>gethost*</td>
8666: <td>-lnsl</td>
8667: <td>Solaris</td>
8668: </tr>
8669: <tr>
8670: <td>inet_aton</td>
8671: <td>-lresolv</td>
8672: <td>Solaris</td>
8673: </tr>
8674: <tr>
8675: <td>nanosleep, sem_*, timer_*</td>
8676: <td>-lrt</td>
8677: <td>Solaris</td>
8678: </tr>
8679: <tr>
8680: <td>openpty</td>
8681: <td>-lutil</td>
8682: <td>Linux</td>
8683: </tr>
8684: </tbody>
8685: </table>
8686: </div>
8687: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8688: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8689: -l<em class="replaceable"><code>foo</code></em></code> to the package
8690: <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
8691: bmake</strong></span>.</p>
1.92 rillig 8692: <div class="sect3" lang="en">
8693: <div class="titlepage"><div><div><h4 class="title">
8694: <a name="undefined-reference-sunpro"></a>18.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
8695: <p>When you are using the SunPro compiler, there is another
8696: possibility. That compiler cannot handle the following code:</p>
8697: <pre class="programlisting">
1.100 rillig 8698: extern int extern_func(int);
1.93 rillig 8699:
1.100 rillig 8700: static inline int
8701: inline_func(int x)
8702: {
1.92 rillig 8703: return extern_func(x);
1.100 rillig 8704: }
1.93 rillig 8705:
1.100 rillig 8706: int main(void)
8707: {
1.92 rillig 8708: return 0;
1.100 rillig 8709: }
1.92 rillig 8710: </pre>
8711: <p>It generates the code for <code class="function">inline_func</code> even if
8712: that function is never used. This code then refers to
8713: <code class="function">extern_func</code>, which can usually not be resolved. To
8714: solve this problem you can try to tell the package to disable inlining
8715: of functions.</p>
8716: </div>
1.87 wiz 8717: </div>
8718: <div class="sect2" lang="en">
8719: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8720: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8721: <p>Sometimes packages fail to build because the compiler runs
8722: into an operating system specific soft limit. With the
8723: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8724: to unlimit the resources. Currently, the allowed values are
8725: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8726: Setting this variable is similar to running the shell builtin
8727: <span><strong class="command">ulimit</strong></span> command to raise the maximum data
8728: segment size or maximum stack size of a process, respectively, to
8729: their hard limits.</p>
1.78 rillig 8730: </div>
1.75 rillig 8731: </div>
8732: <div class="sect1" lang="en">
8733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8734: <a name="fixes.install"></a>18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 8735: <div class="sect2" lang="en">
8736: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8737: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78 rillig 8738: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87 wiz 8739: with some operating systems cannot create more than one
8740: directory at a time. As such, you should call
8741: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8742: <pre class="programlisting">
1.100 rillig 8743: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8744: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8745: </pre>
1.78 rillig 8746: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8747: dir2</code></span>” to the
8748: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8749: automatically do the right thing.</p>
1.75 rillig 8750: </div>
8751: <div class="sect2" lang="en">
8752: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8753: <a name="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8754: <p>In general, documentation should be installed into
1.87 wiz 8755: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8756: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8757: includes the version number of the package).</p>
1.84 wiz 8758: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8759: directory where HTML documentation is installed with the
8760: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8761: is needed because otherwise the documentation ends up in
8762: <code class="filename">${PREFIX}/share/doc/html</code> or other
8763: places.</p>
8764: <p>An exception to the above is that library API documentation
1.91 rillig 8765: 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 8766: browsers (devhelp) should be left at their default location, which
8767: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8768: documentation can be recognized from files ending in
8769: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8770: (It is also acceptable to install such files in
8771: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8772: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8773: <code class="filename">.devhelp*</code> file must be directly in that
8774: directory then, no additional subdirectory level is allowed in
8775: this case. This is usually achieved by using
8776: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8777: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8778: though.)</p>
1.75 rillig 8779: </div>
8780: <div class="sect2" lang="en">
8781: <div class="titlepage"><div><div><h3 class="title">
1.100 rillig 8782: <a name="installing-score-files"></a>18.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8783: <p>Certain packages, most of them in the games category, install
1.87 wiz 8784: a score file that allows all users on the system to record their
8785: highscores. In order for this to work, the binaries need to be
8786: installed setgid and the score files owned by the appropriate
8787: group and/or owner (traditionally the "games" user/group). The
8788: following variables, documented in more detail in
8789: <code class="filename">mk/defaults/mk.conf</code>, control this
8790: behaviour: <code class="varname">SETGIDGAME</code>,
8791: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8792: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8793: <p>Note that per default, setgid installation of games is
1.87 wiz 8794: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8795: the other variables accordingly.</p>
1.75 rillig 8796: <p>A package should therefor never hard code file ownership or
1.87 wiz 8797: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8798: <code class="varname">INSTALL_GAME_DATA</code> to set these
8799: correctly.</p>
1.75 rillig 8800: </div>
8801: <div class="sect2" lang="en">
8802: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8803: <a name="hardcoded-paths"></a>18.6.4. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8804: <p>Your package may also contain scripts with hardcoded paths to
8805: other interpreters besides (or as well as) perl. To correct the
8806: full pathname to the script interpreter, you need to set the
8807: following definitions in your <code class="filename">Makefile</code> (we
8808: shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
8809: <pre class="programlisting">
1.100 rillig 8810: REPLACE_INTERPRETER+= tcl
8811: REPLACE.tcl.old= .*/bin/tclsh
8812: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8813: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8814: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8815: </pre>
1.75 rillig 8816: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8817: <h3 class="title">Note</h3>
8818: <p>Before March 2006, these variables were called
1.87 wiz 8819: <code class="varname">_REPLACE.*</code> and
8820: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8821: </div>
8822: </div>
8823: <div class="sect2" lang="en">
8824: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8825: <a name="perl-modules"></a>18.6.5. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8826: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8827: the Makefile fragment
8828: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
8829: <span><strong class="command">do-configure</strong></span> target for the standard perl
8830: configuration for such modules as well as various hooks to tune
8831: this configuration. See comments in this file for
8832: details.</p>
1.75 rillig 8833: <p>Perl5 modules will install into different places depending
1.87 wiz 8834: on the version of perl used during the build process. To
8835: address this, pkgsrc will append lines to the
8836: <code class="filename">PLIST</code> corresponding to the files listed in
8837: the installed <code class="filename">.packlist</code> file generated by
8838: most perl5 modules. This is invoked by defining
8839: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8840: paths to packlist files, e.g.:</p>
1.75 rillig 8841: <pre class="programlisting">
1.100 rillig 8842: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87 wiz 8843: </pre>
1.75 rillig 8844: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8845: <code class="varname">PERL5_SITEARCH</code>, and
8846: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8847: in which perl5 modules may be installed, and may be used by
8848: perl5 packages that don't have a packlist. These three
8849: variables are also substituted for in the
8850: <code class="filename">PLIST</code>.</p>
1.75 rillig 8851: </div>
8852: <div class="sect2" lang="en">
8853: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8854: <a name="faq.info-files"></a>18.6.6. Packages installing info files</h3></div></div></div>
1.75 rillig 8855: <p>Some packages install info files or use the
1.87 wiz 8856: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8857: commands. <code class="varname">INFO_FILES</code> should be defined in
8858: the package Makefile so that <code class="filename">INSTALL</code> and
8859: <code class="filename">DEINSTALL</code> scripts will be generated to
8860: handle registration of the info files in the Info directory
8861: file. The “<span class="quote">install-info</span>” command used for the info
8862: files registration is either provided by the system, or by a
8863: special purpose package automatically added as dependency if
8864: needed.</p>
1.75 rillig 8865: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8866: <code class="filename">${PREFIX}</code> where info files are primarily
8867: located. <code class="varname">PKGINFODIR</code> defaults to
8868: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8869: <p>The info files for the package should be listed in the
1.87 wiz 8870: package <code class="filename">PLIST</code>; however any split info files
8871: need not be listed.</p>
1.75 rillig 8872: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8873: at build time must add “<span class="quote">makeinfo</span>” to
8874: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8875: version of the “<span class="quote">makeinfo</span>” command is needed it
8876: should be noted with the <code class="varname">TEXINFO_REQD</code>
8877: variable in the package <code class="filename">Makefile</code>. By
8878: default, a minimum version of 3.12 is required. If the system
8879: does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
8880: does not match the required minimum, a build dependency on the
1.91 rillig 8881: <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 8882: be added automatically.</p>
1.75 rillig 8883: <p>The build and installation process of the software provided
1.87 wiz 8884: by the package should not use the
8885: <span><strong class="command">install-info</strong></span> command as the registration of
8886: info files is the task of the package
8887: <code class="filename">INSTALL</code> script, and it must use the
8888: appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75 rillig 8889: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87 wiz 8890: overriding scripts for the <span><strong class="command">install-info</strong></span> and
8891: <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
8892: in <code class="varname">PATH</code>.</p>
1.75 rillig 8893: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87 wiz 8894: no effect except the logging of a message. The script overriding
8895: <span><strong class="command">makeinfo</strong></span> logs a message and according to the
8896: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
8897: <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8898: </div>
8899: <div class="sect2" lang="en">
8900: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8901: <a name="manpages"></a>18.6.7. Packages installing man pages</h3></div></div></div>
1.81 rillig 8902: <p>All packages that install manual pages should install them
1.87 wiz 8903: into the same directory, so that there is one common place to look
8904: for them. In pkgsrc, this place is
8905: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8906: should be used in packages. The default for
8907: <code class="varname">PKGMANDIR</code> is
8908: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8909: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8910: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8911: <h3 class="title">Note</h3>
1.87 wiz 8912: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8913: is far from complete.</p>
1.75 rillig 8914: </div>
1.81 rillig 8915: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8916: <code class="filename">man/</code> as the top level directory for the man
8917: page file entries, and the pkgsrc framework will convert as
8918: needed. In all other places, the correct
8919: <code class="varname">PKGMANDIR</code> must be used.</p>
8920: <p>Packages that are
8921: configured with <code class="varname">GNU_CONFIGURE</code> set as
8922: “<span class="quote">yes</span>”, by default will use the
8923: <code class="filename">./configure</code>
8924: --mandir switch to set where the man pages should be installed.
8925: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8926: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8927: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8928: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8929: to “<span class="quote">no</span>”.
8930: Or if the <code class="filename">./configure</code> script uses
8931: a non-standard use of --mandir, you can set
8932: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90 rillig 8933: <p>See <a href="#manpage-compression" title="12.5. Man page compression">Section 12.5, “Man page compression”</a> for
1.87 wiz 8934: information on installation of compressed manual pages.</p>
1.75 rillig 8935: </div>
8936: <div class="sect2" lang="en">
8937: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8938: <a name="gconf2-data-files"></a>18.6.8. Packages installing GConf2 data files</h3></div></div></div>
1.87 wiz 8939: <p>If a package installs <code class="filename">.schemas</code> or
8940: <code class="filename">.entries</code> files, used by GConf2,
8941: you need to take some extra steps to make sure they get registered
8942: in the database:</p>
1.75 rillig 8943: <div class="orderedlist"><ol type="1">
1.76 rillig 8944: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87 wiz 8945: instead of its <code class="filename">buildlink3.mk</code> file. This
8946: takes care of rebuilding the GConf2 database at installation and
8947: deinstallation time, and tells the package where to install
8948: GConf2 data files using some standard configure arguments. It
8949: also disallows any access to the database directly from the
8950: package.</p></li>
1.75 rillig 8951: <li><p>Ensure that the package installs its
1.87 wiz 8952: <code class="filename">.schemas</code> files under
8953: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8954: installed under <code class="filename">${PREFIX}/etc</code>, you will
8955: need to manually patch the package.</p></li>
1.75 rillig 8956: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8957: directory, as they will be handled automatically. See
1.90 rillig 8958: <a href="#faq.conf" title="8.14. How do I change the location of configuration files?">Section 8.14, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.75 rillig 8959: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87 wiz 8960: your <code class="filename">Makefile</code> with a list of all
8961: <code class="filename">.schemas</code> files installed by the package, if
8962: any. Names must not contain any directories in them.</p></li>
1.75 rillig 8963: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87 wiz 8964: your <code class="filename">Makefile</code> with a
8965: list of all <code class="filename">.entries</code> files installed by the
8966: package, if any. Names must not contain any directories in
8967: them.</p></li>
1.75 rillig 8968: </ol></div>
8969: </div>
8970: <div class="sect2" lang="en">
8971: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8972: <a name="scrollkeeper-data-files"></a>18.6.9. Packages installing scrollkeeper data files</h3></div></div></div>
1.87 wiz 8973: <p>If a package installs <code class="filename">.omf</code> files, used by
8974: scrollkeeper, you need to take some extra steps to make sure they
8975: get registered in the database:</p>
1.75 rillig 8976: <div class="orderedlist"><ol type="1">
8977: <li><p>Include
1.87 wiz 8978: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
8979: instead of its <code class="filename">buildlink3.mk</code> file. This
8980: takes care of rebuilding the scrollkeeper database at
8981: installation and deinstallation time, and disallows any access
8982: to it directly from the package.</p></li>
1.75 rillig 8983: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 8984: <code class="filename">libdata/scrollkeeper</code> directory, as they
8985: will be handled automatically.</p></li>
1.76 rillig 8986: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87 wiz 8987: the PLIST. It will be handled by scrollkeeper.</p></li>
1.75 rillig 8988: </ol></div>
8989: </div>
8990: <div class="sect2" lang="en">
8991: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8992: <a name="x11-fonts"></a>18.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8993: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8994: the fonts database in the directory where they get installed at
8995: installation and deinstallation time. This can be automatically
8996: done by using the pkginstall framework.</p>
1.75 rillig 8997: <p>You can list the directories where fonts are installed in the
1.87 wiz 8998: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8999: variables, where <em class="replaceable"><code>type</code></em> can be one of
9000: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
9001: Also make sure that the database file
9002: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9003: <p>Note that you should not create new directories for fonts;
1.87 wiz 9004: instead use the standard ones to avoid that the user needs to
9005: manually configure his X server to find them.</p>
1.75 rillig 9006: </div>
9007: <div class="sect2" lang="en">
9008: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9009: <a name="gtk2-modules"></a>18.6.11. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9010: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9011: take some extra steps to get them registered in the GTK2 database
9012: properly:</p>
1.75 rillig 9013: <div class="orderedlist"><ol type="1">
9014: <li><p>Include
1.87 wiz 9015: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9016: <code class="filename">buildlink3.mk</code> file. This takes care of
9017: rebuilding the database at installation and deinstallation time.</p></li>
9018: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9019: your package installs GTK2 immodules.</p></li>
9020: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9021: GTK2 loaders.</p></li>
1.75 rillig 9022: <li>
1.87 wiz 9023: <p>Patch the package to not touch any of the GTK2
9024: databases directly. These are:</p>
1.75 rillig 9025: <div class="itemizedlist"><ul type="disc">
1.76 rillig 9026: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9027: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9028: </ul></div>
9029: </li>
1.87 wiz 9030: <li><p>Check the <code class="filename">PLIST</code> and remove
9031: any entries under the <code class="filename">libdata/gtk-2.0</code>
9032: directory, as they will be handled automatically.</p></li>
1.75 rillig 9033: </ol></div>
9034: </div>
9035: <div class="sect2" lang="en">
9036: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9037: <a name="sgml-xml-data"></a>18.6.12. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9038: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9039: registered in system-wide catalogs (like DTDs, sub-catalogs,
9040: etc.), you need to take some extra steps:</p>
1.75 rillig 9041: <div class="orderedlist"><ol type="1">
9042: <li><p>Include
1.87 wiz 9043: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9044: your <code class="filename">Makefile</code>, which takes care of
9045: registering those files in system-wide catalogs at
9046: installation and deinstallation time.</p></li>
1.75 rillig 9047: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9048: any SGML catalogs installed by the package.</p></li>
1.75 rillig 9049: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9050: any XML catalogs installed by the package.</p></li>
1.75 rillig 9051: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9052: to be added to the SGML catalog. These come in groups of
9053: three strings; see xmlcatmgr(1) for more information
9054: (specifically, arguments recognized by the 'add' action).
9055: Note that you will normally not use this variable.</p></li>
1.75 rillig 9056: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9057: to be added to the XML catalog. These come in groups of three
9058: strings; see xmlcatmgr(1) for more information (specifically,
9059: arguments recognized by the 'add' action). Note that you will
9060: normally not use this variable.</p></li>
1.75 rillig 9061: </ol></div>
9062: </div>
9063: <div class="sect2" lang="en">
9064: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9065: <a name="mime-database"></a>18.6.13. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9066: <p>If a package provides extensions to the MIME database by
1.87 wiz 9067: installing <code class="filename">.xml</code> files inside
9068: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9069: need to take some extra steps to ensure that the database is kept
9070: consistent with respect to these new files:</p>
1.75 rillig 9071: <div class="orderedlist"><ol type="1">
9072: <li><p>Include
1.87 wiz 9073: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9074: (avoid using the <code class="filename">buildlink3.mk</code> file from
9075: this same directory, which is reserved for inclusion from
9076: other <code class="filename">buildlink3.mk</code> files). It takes
9077: care of rebuilding the MIME database at installation and
9078: deinstallation time, and disallows any access to it directly
9079: from the package.</p></li>
1.75 rillig 9080: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9081: <code class="filename">share/mime</code> directory,
9082: <span class="emphasis"><em>except</em></span> for files saved under
9083: <code class="filename">share/mime/packages</code>. The former are
9084: handled automatically by
9085: the update-mime-database program, but the latter are
9086: package-dependent and must be removed by the package that
9087: installed them in the first place.</p></li>
1.76 rillig 9088: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9089: from the PLIST. They will be handled by the shared-mime-info
9090: package.</p></li>
1.75 rillig 9091: </ol></div>
9092: </div>
9093: <div class="sect2" lang="en">
9094: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9095: <a name="intltool"></a>18.6.14. Packages using intltool</h3></div></div></div>
1.93 rillig 9096: <p>If a package uses intltool during its build, add
9097: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9098: which forces it to use the intltool package provided by pkgsrc,
9099: instead of the one bundled with the distribution file.</p>
1.75 rillig 9100: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9101: latest available version; this way, the package benefits of any
9102: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9103: </div>
9104: <div class="sect2" lang="en">
9105: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9106: <a name="startup-scripts"></a>18.6.15. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9107: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9108: the startup directory by default, but you can enable it, by adding
9109: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
9110: <code class="filename">/etc/mk.conf</code>. This option will copy the scripts
9111: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9112: it will automatically remove the scripts when the package is
9113: deinstalled.</p>
1.75 rillig 9114: </div>
9115: <div class="sect2" lang="en">
9116: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9117: <a name="tex-packages"></a>18.6.16. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9118: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9119: the <code class="filename">ls-R</code> database of the tree needs to be
9120: updated.</p>
1.75 rillig 9121: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9122: <h3 class="title">Note</h3>
9123: <p>Except the main TeX packages such as teTeX-texmf,
1.87 wiz 9124: packages should install files
9125: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9126: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75 rillig 9127: </div>
9128: <div class="orderedlist"><ol type="1">
9129: <li><p>Include
1.87 wiz 9130: <code class="filename">../../print/teTeX/module.mk</code> instead
9131: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
9132: takes care of rebuilding the <code class="filename">ls-R</code>
9133: database at installation and deinstallation time.</p></li>
1.75 rillig 9134: <li>
9135: <p>If your package installs files into a texmf
1.87 wiz 9136: tree other than the one
9137: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9138: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
9139: trees that need database update.</p>
1.75 rillig 9140: <p>If your package also installs font map files that need
1.87 wiz 9141: to be registered using <span><strong class="command">updmap</strong></span>,
9142: set <code class="varname">TEX_FONTMAPS</code> to the list of all
9143: such font map files. Then <span><strong class="command">updmap</strong></span> will
9144: be run automatically at installation/deinstallation to
9145: enable/disable font map files for TeX output
9146: drivers.</p>
1.75 rillig 9147: </li>
1.76 rillig 9148: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9149: databases are included in <code class="filename">PLIST</code>, as
9150: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 9151: </ol></div>
9152: </div>
1.85 jmmv 9153: <div class="sect2" lang="en">
9154: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9155: <a name="emulation-packages"></a>18.6.17. Packages supporting running binaries in
1.87 wiz 9156: emulation</h3></div></div></div>
9157: <p>There are some packages that provide libraries and
9158: executables for running binaries from a one operating system
9159: on a different one (if the latter supports it). One example
9160: is running Linux binaries on NetBSD.</p>
1.91 rillig 9161: <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 9162: helps in extracting and packaging Linux rpm packages.</p>
9163: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
9164: avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
9165: if all libraries for each installed executable can be found by
9166: the dynamic linker. Since the standard dynamic linker is run,
9167: this fails for emulation packages, because the libraries used
9168: by the emulation are not in the standard directories.</p>
9169: </div>
9170: <div class="sect2" lang="en">
9171: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9172: <a name="hicolor-theme"></a>18.6.18. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9173: <p>If a package installs images under the
1.87 wiz 9174: <code class="filename">share/icons/hicolor</code> and/or updates the
9175: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9176: database, you need to take some extra steps to make sure that the
9177: shared theme directory is handled appropriately and that the cache
9178: database is rebuilt:</p>
1.85 jmmv 9179: <div class="orderedlist"><ol type="1">
9180: <li><p>Include
1.87 wiz 9181: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9182: <li><p>Check the <code class="filename">PLIST</code> and remove the
9183: entry that refers to the theme cache.</p></li>
1.85 jmmv 9184: <li><p>Ensure that the PLIST does not remove the shared icon
9185: directories from the <code class="filename">share/icons/hicolor</code>
9186: hierarchy because they will be handled automatically.</p></li>
9187: </ol></div>
9188: <p>The best way to verify that the PLIST is correct with
9189: respect to the last two points is to regenerate it using
9190: <span><strong class="command">make print-PLIST</strong></span>.</p>
9191: </div>
9192: <div class="sect2" lang="en">
9193: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9194: <a name="desktop-files"></a>18.6.19. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9195: <p>If a package installs <code class="filename">.desktop</code> files
9196: under <code class="filename">share/applications</code> and these include
9197: MIME information, you need to take extra steps to ensure that they
9198: are registered into the MIME database:</p>
9199: <div class="orderedlist"><ol type="1">
9200: <li><p>Include
9201: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9202: <li><p>Check the PLIST and remove the entry that refers to the
9203: <code class="filename">share/applications/mimeinfo.cache</code> file.
9204: It will be handled automatically.</p></li>
9205: </ol></div>
9206: <p>The best way to verify that the PLIST is correct with
9207: respect to the last point is to regenerate it using <span><strong class="command">make
9208: print-PLIST</strong></span>.</p>
1.75 rillig 9209: </div>
9210: </div>
1.87 wiz 9211: <div class="sect1" lang="en">
9212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9213: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9214: <p>In some cases one does not have the time to solve a problem
9215: immediately. There are currently two ways to declare that one knows
9216: that a package has problems.</p>
9217: <div class="itemizedlist"><ul type="disc">
9218: <li><p>The first way is to plainly mark it as broken. For
9219: this, one just sets the variable <code class="varname">BROKEN</code> to the
9220: reason why the package is broken (similar to the
9221: <code class="varname">RESTRICTED</code> variable). A user trying to build
9222: the package will immediately be shown this message, and the build
9223: will not be even tried.</p></li>
9224: <li><p>After each pkgsrc freeze period (a time when the
9225: tree is stabilized and a new pkgsrc branch is cut), the packages
9226: that were not building in the official branch build on the latest
9227: NetBSD release will be marked as broken on that branch. This is
9228: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9229: branch name (or appending the branch name to it). If a user tries
9230: to build such a package and the build fails, the user gets a
9231: message that says that the package was broken on the respective
9232: branch(es).</p></li>
9233: </ul></div>
9234: <p>Both types of packages are removed from pkgsrc in irregular
9235: intervals.</p>
9236: </div>
1.75 rillig 9237: </div>
9238: <div class="chapter" lang="en">
9239: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9240: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88 wiz 9241: <p>To check out all the gotchas when building a package, here are
9242: the steps that I do in order to get a package working. Please note
9243: this is basically the same as what was explained in the previous
9244: sections, only with some debugging aids.</p>
1.75 rillig 9245: <div class="itemizedlist"><ul type="disc">
1.88 wiz 9246: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=1</code> in
9247: <code class="filename">/etc/mk.conf</code></p></li>
1.75 rillig 9248: <li>
1.91 rillig 9249: <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 9250: create a directory for a new package, change into it, then run
9251: <span><strong class="command">url2pkg</strong></span>:</p>
1.75 rillig 9252: <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>
9253: <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>
9254: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9255: </li>
1.76 rillig 9256: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9257: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87 wiz 9258: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75 rillig 9259: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9260: configure step to the package's
9261: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 9262: <li>
9263: <p>Make the package compile, doing multiple rounds of</p>
9264: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9265: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9266: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9267: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9268: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9269: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9270: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9271: <p>Doing this step as non-root user will ensure that no files
9272: are modified that shouldn't be, especially during the build
9273: phase. <span><strong class="command">mkpatches</strong></span>,
9274: <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91 rillig 9275: 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 9276: package.</p>
1.75 rillig 9277: </li>
1.88 wiz 9278: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90 rillig 9279: necessary; see <a href="#components.Makefile" title="10.1. Makefile">Section 10.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.75 rillig 9280: <li>
1.76 rillig 9281: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9282: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9283: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9284: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9285: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9286: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9287: <p>You usually need to be <code class="username">root</code> to do
9288: this. Look if there are any files left:</p>
1.75 rillig 9289: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9290: <p>If this reveals any files that are missing in
1.88 wiz 9291: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9292: </li>
9293: <li>
1.88 wiz 9294: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9295: package again and make a binary package:</p>
1.75 rillig 9296: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9297: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9298: </li>
9299: <li>
9300: <p>Delete the installed package:</p>
1.88 wiz 9301: <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 9302: </li>
9303: <li>
1.88 wiz 9304: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
9305: command, which shouldn't find anything now:</p>
1.75 rillig 9306: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9307: </li>
9308: <li>
9309: <p>Reinstall the binary package:</p>
1.93 rillig 9310: <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 9311: </li>
1.88 wiz 9312: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9313: <li>
1.91 rillig 9314: <p>Run <span><strong class="command">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 9315: reports:</p>
1.75 rillig 9316: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9317: </li>
1.90 rillig 9318: <li><p>Submit (or commit, if you have cvs access); see <a href="#submit" title="Chapter 20. Submitting and Committing">Chapter 20, <i>Submitting and Committing</i></a>.</p></li>
1.75 rillig 9319: </ul></div>
9320: </div>
9321: <div class="chapter" lang="en">
9322: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9323: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75 rillig 9324: <div class="toc">
9325: <p><b>Table of Contents</b></p>
9326: <dl>
1.90 rillig 9327: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
9328: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9329: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
9330: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
9331: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
9332: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9333: </dl>
9334: </div>
9335: <div class="sect1" lang="en">
9336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9337: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9338: <p>Our policy is that we accept binaries only from pkgsrc
9339: developers to guarantee that the packages don't contain any
9340: trojan horses etc. This is not to annoy anyone but rather to
9341: protect our users! You're still free to put up your home-made
9342: binary packages and tell the world where to get them. NetBSD
9343: developers doing bulk builds and wanting to upload them please
9344: see <a href="#bulk-upload" title="6.3.8. Uploading results of a bulk build">Section 6.3.8, “Uploading results of a bulk build”</a>.</p>
9345: </div>
9346: <div class="sect1" lang="en">
9347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9348: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9349: <p>First, check that your package is complete, compiles and
1.90 rillig 9350: runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75 rillig 9351: document. Next, generate an uuencoded gzipped <a 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 9352: archive that contains all files that make up the package.
1.87 wiz 9353: Finally, send this package to the pkgsrc bug tracking system,
9354: either with the <a 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
9355: that, go to the web page
9356: <a href="http://www.NetBSD.org/Misc/send-pr.html" target="_top">http://www.NetBSD.org/Misc/send-pr.html</a>,
9357: which contains some instructions and a link to a form, where you
9358: can submit packages.</p>
9359: <p>In the form of the problem report, the category should be
9360: “<span class="quote">pkg</span>”, the synopsis should include the package name
9361: and version number, and the description field should contain a
9362: short description of your package (contents of the COMMENT
9363: variable or DESCR file are OK). The uuencoded package data should
9364: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9365: <p>If you want to submit several packages, please send a
9366: separate PR for each one, it's easier for us to track things
9367: that way.</p>
9368: <p>Alternatively, you can also import new packages into
9369: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
9370: homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9371: for details.</p>
9372: </div>
9373: <div class="sect1" lang="en">
9374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9375: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9376: <p>Please note all package additions, updates, moves, and
1.93 rillig 9377: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9378: important to keep this file up to date and conforming to the
9379: existing format, because it will be used by scripts to
9380: automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9381: sites. Additionally, check the
1.76 rillig 9382: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9383: for the package you updated or removed, in case it was mentioned
9384: there.</p>
9385: <p>When the <code class="varname">PKGREVISION</code> of a package is
9386: bumped, the change should appear in
1.93 rillig 9387: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9388: related or otherwise relevant. Mass bumps that result from a
9389: dependency being updated should not be mentioned. In all other
9390: cases it's the developer's decision.</p>
9391: <p>There is a make target that helps in creating proper
1.93 rillig 9392: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span><strong class="command">make
1.75 rillig 9393: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9394: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9395: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9396: file is up-to-date (to avoid having to resolve conflicts later-on)
9397: and then to <span><strong class="command">cd</strong></span> to the package directory. For
9398: package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
9399: For new packages, or package moves or removals, set the
9400: <code class="varname">CTYPE</code> variable on the command line to "Added",
9401: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.76 rillig 9402: in <code class="filename">/etc/mk.conf</code> if your local login name is
1.75 rillig 9403: not the same as your NetBSD login name. Don't forget to commit
1.93 rillig 9404: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75 rillig 9405: </div>
9406: <div class="sect1" lang="en">
9407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9408: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9409: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9410: access to the pkgsrc repository. Please remember that cvs
9411: imports files relative to the current working directory, and that
9412: the pathname that you
9413: give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
9414: to place the files in the repository. Newly created packages should be
9415: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9416: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9417: <pre class="programlisting">
1.100 rillig 9418: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9419: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75 rillig 9420: </pre>
1.87 wiz 9421: <p>Remember to move the directory from which you imported out of
1.75 rillig 9422: the way, or cvs will complain the next time you “<span class="quote">cvs
9423: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9424: package to the category's <code class="filename">Makefile</code>.</p>
9425: <p>The commit message of the initial import should include part of the
1.76 rillig 9426: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9427: what the package is/does.</p>
9428: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9429: add</span>” because the former gets everything with a single command,
1.87 wiz 9430: and provides a consistent tag.</p>
1.75 rillig 9431: </div>
9432: <div class="sect1" lang="en">
9433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9434: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9435: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9436: changes between old and new versions into the commit log when updating
1.87 wiz 9437: a package. There are various reasons for this:</p>
1.75 rillig 9438: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9439: <li><p>A URL is volatile, and can change over time. It may go away completely
9440: or its information may be overwritten by newer information.</p></li>
9441: <li><p>Having the change information between old and new versions in our CVS
9442: repository is very useful for people who use either cvs or anoncvs.</p></li>
9443: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9444: repository is very useful for people who read the pkgsrc-changes mailing
9445: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9446: the package.</p></li>
1.75 rillig 9447: </ul></div>
1.87 wiz 9448: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9449: has been released, it should not automatically be upgraded in the CVS
9450: repository. We prefer to be conservative in the packages that are
9451: included in pkgsrc - development or beta packages are not really the
9452: best thing for most places in which pkgsrc is used. Please use your
9453: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9454: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9455: </div>
9456: <div class="sect1" lang="en">
9457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9458: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75 rillig 9459: <div class="orderedlist"><ol type="1">
9460: <li><p>Make a copy of the directory somewhere else.</p></li>
9461: <li>
9462: <p>Remove all CVS dirs.</p>
1.87 wiz 9463: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9464: <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 9465: <p>and use that for further work.</p>
1.75 rillig 9466: </li>
9467: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9468: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9469: instead of “<span class="quote">../../category/package</span>”.</p></li>
9470: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
9471: place.</p></li>
9472: <li>
9473: <p>Check if any package depends on it:
9474: </p>
9475: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9476: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9477: </li>
9478: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
9479: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9480: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9481: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9482: <li>
9483: <p>Commit the changed and removed files:</p>
9484: <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 9485: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9486: </li>
9487: </ol></div>
9488: </div>
9489: </div>
9490: <div class="chapter" lang="en">
9491: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9492: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9493: <p>This section contains the answers to questions that may
9494: arise when you are writing a package. If you don't find your
9495: question answered here, first have a look in the other chapters,
9496: and if you still don't have the answer, ask on the
9497: <code class="literal">pkgsrc-users</code> mailing list.</p>
9498: <div class="qandaset">
9499: <dl>
1.93 rillig 9500: <dt>21.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9501: MAKEFLAGS, .MAKEFLAGS and
9502: MAKE_FLAGS?</a>
9503: </dt>
1.93 rillig 9504: <dt>21.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9505: MAKE, GMAKE and
9506: MAKE_PROGRAM?</a>
9507: </dt>
1.93 rillig 9508: <dt>21.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9509: CC, PKG_CC and
9510: PKGSRC_COMPILER?</a>
9511: </dt>
1.93 rillig 9512: <dt>21.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9513: BUILDLINK_LDFLAGS,
9514: BUILDLINK_LDADD and
9515: BUILDLINK_LIBS?</a>
9516: </dt>
1.93 rillig 9517: <dt>21.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9518: VARNAME=BUILDLINK_PREFIX.foo
9519: say it's empty?</a>
9520: </dt>
1.93 rillig 9521: <dt>21.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9522: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9523: don't understand the := inside
9524: it.</a>
9525: </dt>
1.93 rillig 9526: <dt>21.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9527: developers?</a>
9528: </dt>
1.93 rillig 9529: <dt>21.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9530: documentation?</a>
9531: </dt>
1.92 rillig 9532: <dt>21.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
9533: do?</a>
9534: </dt>
1.75 rillig 9535: </dl>
9536: <table border="0" summary="Q and A Set">
9537: <col align="left" width="1%">
9538: <tbody>
9539: <tr class="question">
9540: <td align="left" valign="top">
1.101 ! rillig 9541: <a name="devfaq.makeflags"></a><a name="id2713629"></a><b>21.1.</b>
1.75 rillig 9542: </td>
9543: <td align="left" valign="top"><p>What is the difference between
9544: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9545: <code class="varname">MAKE_FLAGS</code>?</p></td>
9546: </tr>
9547: <tr class="answer">
1.91 rillig 9548: <td align="left" valign="top"></td>
1.75 rillig 9549: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9550: to the pkgsrc-internal invocations of <a 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
9551: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9552: the <code class="varname">MAKE_PROGRAM</code> when building the
9553: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9554: </tr>
9555: <tr class="question">
9556: <td align="left" valign="top">
1.101 ! rillig 9557: <a name="devfaq.make"></a><a name="id2713804"></a><b>21.2.</b>
1.75 rillig 9558: </td>
9559: <td align="left" valign="top"><p>What is the difference between
9560: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9561: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9562: </tr>
9563: <tr class="answer">
1.91 rillig 9564: <td align="left" valign="top"></td>
1.75 rillig 9565: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9566: <a 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
9567: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9568: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9569: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9570: Make program that is used for building the
9571: package.</p></td>
9572: </tr>
9573: <tr class="question">
9574: <td align="left" valign="top">
1.101 ! rillig 9575: <a name="devfaq.cc"></a><a name="id2713845"></a><b>21.3.</b>
1.75 rillig 9576: </td>
9577: <td align="left" valign="top"><p>What is the difference between
9578: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9579: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9580: </tr>
9581: <tr class="answer">
1.91 rillig 9582: <td align="left" valign="top"></td>
1.75 rillig 9583: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9584: compiler, which can be configured by the pkgsrc user.
9585: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9586: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9587: path to a compiler, but the type of compiler that should be
1.76 rillig 9588: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9589: information about the latter variable.</p></td>
9590: </tr>
9591: <tr class="question">
9592: <td align="left" valign="top">
1.101 ! rillig 9593: <a name="devfaq.bl3flags"></a><a name="id2713884"></a><b>21.4.</b>
1.75 rillig 9594: </td>
9595: <td align="left" valign="top"><p>What is the difference between
9596: <code class="varname">BUILDLINK_LDFLAGS</code>,
9597: <code class="varname">BUILDLINK_LDADD</code> and
9598: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9599: </tr>
9600: <tr class="answer">
1.91 rillig 9601: <td align="left" valign="top"></td>
1.75 rillig 9602: <td align="left" valign="top"><p>[FIXME]</p></td>
9603: </tr>
9604: <tr class="question">
9605: <td align="left" valign="top">
1.101 ! rillig 9606: <a name="devfaq.bl3prefix"></a><a name="id2713905"></a><b>21.5.</b>
1.75 rillig 9607: </td>
9608: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
9609: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9610: say it's empty?</p></td>
9611: </tr>
9612: <tr class="answer">
1.91 rillig 9613: <td align="left" valign="top"></td>
1.75 rillig 9614: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9615: available in the “<span class="quote">wrapper</span>” phase and later. To
9616: “<span class="quote">simulate</span>” the wrapper phase, append
9617: <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
9618: command.</p></td>
9619: </tr>
1.78 rillig 9620: <tr class="question">
9621: <td align="left" valign="top">
1.101 ! rillig 9622: <a name="devfaq.master_sites"></a><a name="id2713934"></a><b>21.6.</b>
1.78 rillig 9623: </td>
9624: <td align="left" valign="top"><p>What does
9625: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9626: don't understand the <code class="literal">:=</code> inside
9627: it.</p></td>
9628: </tr>
9629: <tr class="answer">
1.91 rillig 9630: <td align="left" valign="top"></td>
1.78 rillig 9631: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9632: assignment operator, like you might expect at first sight.
9633: Instead, it is a degenerate form of
9634: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9635: which is documented in the <a 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
9636: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9637: case of <code class="varname">MASTER_SITE_*</code>,
9638: <em class="replaceable"><code>old_string</code></em> is the empty string and
9639: <em class="replaceable"><code>new_string</code></em> is
9640: <code class="literal">package/</code>. That's where the
9641: <code class="literal">:</code> and the <code class="literal">=</code> fall
9642: together.</p></td>
9643: </tr>
9644: <tr class="question">
9645: <td align="left" valign="top">
1.101 ! rillig 9646: <a name="devfaq.mailinglists"></a><a name="id2714011"></a><b>21.7.</b>
1.78 rillig 9647: </td>
9648: <td align="left" valign="top"><p>Which mailing lists are there for package
9649: developers?</p></td>
9650: </tr>
9651: <tr class="answer">
1.91 rillig 9652: <td align="left" valign="top"></td>
1.78 rillig 9653: <td align="left" valign="top"><div class="variablelist"><dl>
9654: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
9655: <dd><p>This is a list for technical discussions related
9656: to pkgsrc development, e.g. soliciting feedback for changes to
9657: pkgsrc infrastructure, proposed new features, questions related
9658: to porting pkgsrc to a new platform, advice for maintaining a
9659: package, patches that affect many packages, help requests moved
9660: from pkgsrc-users when an infrastructure bug is found,
9661: etc.</p></dd>
9662: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
9663: <dd><p>All bug reports in category "pkg" sent with
9664: <a 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
9665: directly; use one of the other mailing
9666: lists.</p></dd>
9667: </dl></div></td>
9668: </tr>
1.80 rillig 9669: <tr class="question">
9670: <td align="left" valign="top">
1.101 ! rillig 9671: <a name="devfaq.documentation"></a><a name="id2714050"></a><b>21.8.</b>
1.80 rillig 9672: </td>
9673: <td align="left" valign="top"><p>Where is the pkgsrc
9674: documentation?</p></td>
9675: </tr>
9676: <tr class="answer">
1.91 rillig 9677: <td align="left" valign="top"></td>
1.80 rillig 9678: <td align="left" valign="top">
9679: <p>There are many places where you can find
9680: documentation about pkgsrc:</p>
9681: <div class="itemizedlist"><ul type="disc">
9682: <li><p>The pkgsrc guide (this document) is a collection
9683: of chapters that explain large parts of pkgsrc, but some
9684: chapters tend to be outdated. Which ones they are is hard to
9685: say.</p></li>
9686: <li><p>On the mailing list archives (see <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
9687: about certain features, announcements of new parts of the pkgsrc
9688: infrastructure and sometimes even announcements that a certain
9689: feature has been marked as obsolete. The benefit here is that
9690: each message has a date appended to it.</p></li>
9691: <li><p>Many of the files in the
9692: <code class="filename">mk/</code> directory start with a comment that
9693: describes the purpose of the file and how it can be used by the
1.92 rillig 9694: pkgsrc user and package authors. An easy way to find this
9695: documentation is to run <span><strong class="command">bmake
9696: help</strong></span>.</p></li>
1.80 rillig 9697: <li><p>The CVS log messages are a rich source of
9698: information, but they tend to be highly abbreviated, especially
9699: for actions that occur often. Some contain a detailed
9700: description of what has changed, but they are geared towards the
9701: other pkgsrc developers, not towards an average pkgsrc user.
9702: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9703: don't know what has been before, these messages may not be worth
9704: too much to you.</p></li>
9705: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9706: documented</span>”, that is the documentation exists only in the
9707: mind of the developer who wrote the code. To get this
1.93 rillig 9708: information, use the <span><strong class="command">cvs annotate</strong></span> command
1.80 rillig 9709: to see who has written it and ask on the
9710: <code class="literal">tech-pkg</code> mailing list, so that others can
9711: find your questions later (see above). To be sure that the
9712: developer in charge reads the mail, you may CC him or
9713: her.</p></li>
9714: </ul></div>
9715: </td>
9716: </tr>
1.92 rillig 9717: <tr class="question">
9718: <td align="left" valign="top">
1.101 ! rillig 9719: <a name="devfaq.too-much-time"></a><a name="id2714180"></a><b>21.9.</b>
1.92 rillig 9720: </td>
9721: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9722: do?</p></td>
9723: </tr>
9724: <tr class="answer">
9725: <td align="left" valign="top"></td>
9726: <td align="left" valign="top">
1.93 rillig 9727: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9728: anyway.</p>
9729: <div class="itemizedlist"><ul type="disc">
9730: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
9731: <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
9732: will tell you about newer versions of installed packages that are
9733: available, but not yet updated in pkgsrc.</p></li>
9734: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
9735: — it contains a list of suggested new packages and a list of
9736: cleanups and enhancements for pkgsrc that would be nice to
9737: have.</p></li>
9738: <li><p>Review packages for which review was requested on
9739: the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9740: mailing list.</p></li>
9741: </ul></div>
9742: </td>
9743: </tr>
1.75 rillig 9744: </tbody>
9745: </table>
9746: </div>
9747: </div>
1.85 jmmv 9748: <div class="chapter" lang="en">
9749: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9750: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9751: <div class="toc">
9752: <p><b>Table of Contents</b></p>
9753: <dl>
1.90 rillig 9754: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9755: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9756: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9757: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 9758: </dl>
9759: </div>
9760: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
9761: site</a>:</p>
9762: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9763: environment, an intuitive and attractive desktop for users, and the
9764: GNOME development platform, an extensive framework for building
9765: applications that integrate into the rest of the desktop.</p></blockquote></div>
9766: <p>pkgsrc provides a seamless way to automatically build and install
9767: a complete GNOME environment <span class="emphasis"><em>under many different
9768: platforms</em></span>. We can say with confidence that pkgsrc is one of
9769: the most advanced build and packaging systems for GNOME due to its
9770: included technologies buildlink3, the wrappers and tools framework and
9771: automatic configuration file management. Lots of efforts are put into
9772: achieving a completely clean deinstallation of installed software
9773: components.</p>
9774: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9775: the above also means that great efforts are put into making GNOME work
9776: under this operating system. Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9777: pkgsrc as its preferred packaging system, contributing lots of
9778: portability fixes to make GNOME build and install under it.</p>
9779: <p>This chapter is aimed at pkgsrc developers and other people
9780: interested in helping our GNOME porting and packaging efforts. It
9781: provides instructions on how to manage the existing packages and some
9782: important information regarding their internals.</p>
9783: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9784: <h3 class="title">We need your help!</h3>
9785: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9786: and GNOME and are willing to learn new exciting stuff, please jump
9787: straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9788: work</a> list! There is still a long way to go to get a
9789: fully-functional GNOME desktop under NetBSD and we need your help to
9790: achieve it!</p>
9791: </div>
9792: <div class="sect1" lang="en">
9793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9794: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85 jmmv 9795: <p>pkgsrc includes three GNOME-related meta packages:</p>
9796: <div class="itemizedlist"><ul type="disc">
1.91 rillig 9797: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.85 jmmv 9798: the core GNOME desktop environment. It only includes the necessary
9799: bits to get it to boot correctly, although it may lack important
9800: functionality for daily operation. The idea behind this package is
9801: to let end users build their own configurations on top of this one,
9802: first installing this meta package to achieve a functional setup and
9803: then adding individual applications.</p></li>
1.91 rillig 9804: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.85 jmmv 9805: complete installation of the GNOME platform and desktop as defined
9806: by the GNOME project; this is based on the components distributed in
9807: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9808: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9809: official FTP server. Developer-only tools found in those
9810: directories are not installed unless required by some other
9811: component to work properly. Similarly, packages from the bindings
9812: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9813: in unless required as a dependency for an end-user component. This
1.91 rillig 9814: 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>
9815: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.85 jmmv 9816: Installs all the tools required to build a GNOME component when
9817: fetched from the CVS repository. These are required to let the
9818: <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
9819: </ul></div>
9820: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9821: sorted in a way that eases updates: a package may depend on other
9822: packages listed before it but not on any listed after it. It is very
9823: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9824: change it to alphabetical sorting!</em></span></p>
9825: </div>
9826: <div class="sect1" lang="en">
9827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9828: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9829: <p>Almost all GNOME applications are written in C and use a common
9830: set of tools as their build system. Things get different with the new
9831: bindings to other languages (such as Python), but the following will
9832: give you a general idea on the minimum required tools:</p>
9833: <div class="itemizedlist"><ul type="disc">
9834: <li>
9835: <p>Almost all GNOME applications use the GNU Autotools as their
9836: build system. As a general rule you will need to tell this to your
9837: package:</p>
1.100 rillig 9838: <pre class="programlisting">
9839: GNU_CONFIGURE=yes
1.85 jmmv 9840: USE_LIBTOOL=yes
1.100 rillig 9841: USE_TOOLS+=gmake
9842: </pre>
1.85 jmmv 9843: </li>
9844: <li>
9845: <p>If the package uses pkg-config to detect dependencies, add this
9846: tool to the list of required utilities:</p>
9847: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9848: <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 9849: the end of the build process to ensure that you did not miss to
9850: specify any dependency in your package and that the version
9851: requirements are all correct.</p>
9852: </li>
1.93 rillig 9853: <li><p>If the package uses intltool, be sure to add
9854: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9855: to handle dependencies and to force the package to use the latest
9856: available version.</p></li>
9857: <li>
9858: <p>If the package uses gtk-doc (a documentation generation
9859: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9860: tool is rather big and the distfile should come with pregenerated
9861: documentation anyway; if it does not, it is a bug that you ought to
9862: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9863: the default):</p>
9864: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9865: <p>The default location of installed HTML files
9866: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9867: and should not be changed unless the package insists on installing
9868: them somewhere else. Otherwise programs as
9869: <span><strong class="command">devhelp</strong></span> will not be able to open them. You can
9870: do that with an entry similar to:</p>
9871: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9872: </li>
9873: </ul></div>
9874: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9875: files under the installation prefix to maintain databases. In this
9876: context, shared means that those exact same directories and files are
9877: used among several different packages, leading to conflicts in the
9878: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9879: handle the most common cases, so you have to forget about using
9880: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9881: omitting shared files from them. If you find yourself doing those,
9882: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9883: <p>The following table lists the common situations that result in
9884: using shared directories or files. For each of them, the appropriate
9885: solution is given. After applying the solution be sure to
9886: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9887: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
9888: <div class="table">
1.90 rillig 9889: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9890: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9891: <colgroup>
9892: <col>
9893: <col>
9894: </colgroup>
9895: <thead><tr>
9896: <th>If the package...</th>
9897: <th>Then...</th>
9898: </tr></thead>
9899: <tbody>
9900: <tr>
9901: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.90 rillig 9902: <td>See <a href="#scrollkeeper-data-files" title="18.6.9. Packages installing scrollkeeper data files">Section 18.6.9, “Packages installing scrollkeeper data files”</a>.</td>
1.85 jmmv 9903: </tr>
9904: <tr>
9905: <td>Installs icons under the
9906: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9907: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.90 rillig 9908: <td>See <a href="#hicolor-theme" title="18.6.18. Packages installing hicolor theme icons">Section 18.6.18, “Packages installing hicolor theme icons”</a>.</td>
1.85 jmmv 9909: </tr>
9910: <tr>
9911: <td>Installs files under
9912: <code class="filename">share/mime/packages</code>.</td>
1.90 rillig 9913: <td>See <a href="#mime-database" title="18.6.13. Packages installing extensions to the MIME database">Section 18.6.13, “Packages installing extensions to the MIME database”</a>.</td>
1.85 jmmv 9914: </tr>
9915: <tr>
9916: <td>Installs <code class="filename">.desktop</code> files under
9917: <code class="filename">share/applications</code> and these include MIME
9918: information.</td>
1.90 rillig 9919: <td>See <a href="#desktop-files" title="18.6.19. Packages installing desktop files">Section 18.6.19, “Packages installing desktop files”</a>.</td>
1.85 jmmv 9920: </tr>
9921: </tbody>
1.91 rillig 9922: </table></div>
1.85 jmmv 9923: </div>
1.91 rillig 9924: <br class="table-break">
1.85 jmmv 9925: </div>
9926: <div class="sect1" lang="en">
9927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9928: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9929: <p>When seeing GNOME as a whole, there are two kinds of
9930: updates:</p>
9931: <div class="variablelist"><dl>
9932: <dt><span class="term">Major update</span></dt>
9933: <dd>
9934: <p>Given that there is still a very long way for GNOME 3 (if it
9935: ever appears), we consider a major update one that goes from a
9936: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9937: where <code class="literal">Y</code> is even and greater than
9938: <code class="literal">X</code>. These are hard to achieve because they
9939: introduce lots of changes in the components' code and almost all
9940: GNOME distfiles are updated to newer versions. Some of them can
9941: even break API and ABI compatibility with the previous major
9942: version series. As a result, the update needs to be done all at
9943: once to minimize breakage.</p>
9944: <p>A major update typically consists of around 80 package
9945: updates and the addition of some new ones.</p>
9946: </dd>
9947: <dt><span class="term">Minor update</span></dt>
9948: <dd>
9949: <p>We consider a minor update one that goes from a
9950: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9951: one where <code class="literal">Y</code> is greater than
9952: <code class="literal">X</code>. These are easy to achieve because they do
9953: not update all GNOME components, can be done in an incremental way
9954: and do not break API nor ABI compatibility.</p>
9955: <p>A minor update typically consists of around 50 package
9956: updates, although the numbers here may vary a lot.</p>
9957: </dd>
9958: </dl></div>
9959: <p>In order to update the GNOME components in pkgsrc to a new stable
9960: release (either major or minor), the following steps should be
9961: followed:</p>
9962: <div class="orderedlist"><ol type="1">
9963: <li>
9964: <p>Get a list of all the tarballs that form the new release by
9965: using the following commands. These will leave the full list of the
9966: components's distfiles into the <code class="filename">list.txt</code>
9967: file:</p>
1.88 wiz 9968: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9969: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9970: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9971: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9972: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9973: awk '{ print $9 }' >>list.txt</code></strong></pre>
9974: </li>
9975: <li><p>Open each meta package's <code class="filename">Makefile</code> and
9976: bump their version to the release you are updating them to. The
9977: three meta packages should be always consistent with versioning.
9978: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9979: in them.</p></li>
9980: <li>
9981: <p>For each meta package, update all its
9982: <code class="varname">DEPENDS</code> lines to match the latest versions as
9983: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9984: newer version (even if found in the FTP) because the meta packages
9985: are supposed to list the exact versions that form a specific GNOME
9986: release. Exceptions are permitted here if a newer version solves a
9987: serious issue in the overall desktop experience; these typically
9988: come in the form of a revision bump in pkgsrc, not in newer versions
9989: from the developers.</p>
9990: <p>Packages not listed in the <code class="filename">list.txt</code> file
9991: should be updated to the latest version available (if found in
9992: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 9993: 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 9994: </li>
9995: <li>
9996: <p>Generate a patch from the modified meta packages and extract the
9997: list of "new" lines. This will provide you an outline on what
9998: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9999: <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 10000: </li>
10001: <li><p>For major desktop updates it is recommended to zap all your
10002: installed packages and start over from scratch at this point.</p></li>
10003: <li><p>Now comes the longest step by far: iterate over the contents
10004: of <code class="filename">todo.txt</code> and update the packages listed in
10005: it in order. For major desktop updates none of these should be
1.93 rillig 10006: committed until the entire set is completed because there are chances
1.85 jmmv 10007: of breaking not-yet-updated packages.</p></li>
10008: <li><p>Once the packages are up to date and working, commit them to
10009: the tree one by one with appropriate log messages. At the end,
10010: commit the three meta package updates and all the corresponding
10011: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10012: <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>
10013: </ol></div>
10014: </div>
10015: <div class="sect1" lang="en">
10016: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10017: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10018: <p>GNOME is a very big component in pkgsrc which approaches 100
10019: packages. Please, it is very important that you always, always,
10020: <span class="strong"><strong>always</strong></span> feed back any portability
1.93 rillig 10021: fixes you do to a GNOME package to the mainstream developers (see <a href="#components.patches.feedback" title="10.3.5. Feedback to the author">Section 10.3.5, “Feedback to the author”</a>). This is the only way to get
1.85 jmmv 10022: their attention on portability issues and to ensure that future versions
10023: can be built out-of-the box on NetBSD. The less custom patches in
10024: pkgsrc, the easier further updates are. Those developers in charge of
10025: issuing major GNOME updates will be grateful if you do that.</p>
10026: <p>The most common places to report bugs are the <a href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
10027: Bugzilla</a>. Not all components use these to track bugs, but most
10028: of them do. Do not be short on your reports: always provide detailed
10029: explanations of the current failure, how it can be improved to achieve
10030: maximum portability and, if at all possible, provide a patch against CVS
10031: head. The more verbose you are, the higher chances of your patch being
10032: accepted.</p>
10033: <p>Also, please avoid using preprocessor magic to fix portability
10034: issues. While the FreeBSD GNOME people are doing a great job in porting
10035: GNOME to their operating system, the official GNOME sources are now
10036: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10037: and similar macros. This hurts portability. Please see our patching
1.93 rillig 10038: guidelines (<a href="#components.patches.guidelines" title="10.3.4. Patching guidelines">Section 10.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 10039: details.</p>
10040: </div>
10041: </div>
1.75 rillig 10042: </div>
10043: <div class="part" lang="en">
10044: <div class="titlepage"><div><div><h1 class="title">
10045: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10046: <div class="partintro" lang="en">
10047: <div></div>
10048: <p>This part of the guide deals with everything
10049: from the infrastructure that is behind the interfaces described
10050: in the developer's guide. A casual package maintainer should not
10051: need anything from this part.</p>
10052: <div class="toc">
10053: <p><b>Table of Contents</b></p>
10054: <dl>
1.90 rillig 10055: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10056: <dd><dl>
1.90 rillig 10057: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
10058: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
10059: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75 rillig 10060: <dd><dl>
1.90 rillig 10061: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
10062: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75 rillig 10063: </dl></dd>
1.90 rillig 10064: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
10065: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10066: <dd><dl>
1.90 rillig 10067: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
10068: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 10069: </dl></dd>
1.90 rillig 10070: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10071: <dd><dl>
1.90 rillig 10072: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10073: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10074: </dl></dd>
10075: </dl></dd>
1.90 rillig 10076: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 10077: <dd><dl>
1.90 rillig 10078: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10079: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10080: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10081: <dd><dl>
1.90 rillig 10082: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10083: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10084: </dl></dd>
10085: </dl></dd>
1.90 rillig 10086: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 10087: <dd><dl>
1.90 rillig 10088: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10089: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10090: </dl></dd>
10091: </dl>
10092: </div>
10093: </div>
10094: <div class="chapter" lang="en">
10095: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10096: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10097: <div class="toc">
10098: <p><b>Table of Contents</b></p>
10099: <dl>
1.90 rillig 10100: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
10101: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
10102: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 10103: <dd><dl>
1.90 rillig 10104: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
10105: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 10106: </dl></dd>
1.90 rillig 10107: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
10108: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10109: <dd><dl>
1.90 rillig 10110: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
10111: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 10112: </dl></dd>
1.90 rillig 10113: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10114: <dd><dl>
1.90 rillig 10115: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10116: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10117: </dl></dd>
10118: </dl>
10119: </div>
10120: <p>The pkgsrc infrastructure consists of many small Makefile
10121: fragments. Each such fragment needs a properly specified
10122: interface. This chapter explains how such an interface looks
10123: like.</p>
10124: <div class="sect1" lang="en">
10125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10126: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10127: <p>Whenever a variable is defined in the pkgsrc
10128: infrastructure, the location and the way of definition provide
10129: much information about the intended use of that variable.
10130: Additionally, more documentation may be found in a header
10131: comment or in this pkgsrc guide.</p>
10132: <p>A special file is
10133: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10134: variables that are intended to be user-defined. They are either
10135: defined using the <code class="literal">?=</code> operator or they are
10136: left undefined because defining them to anything would
10137: effectively mean “<span class="quote">yes</span>”. All these variables may be
10138: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10139: file.</p>
10140: <p>Outside this file, the following conventions apply:
10141: Variables that are defined using the <code class="literal">?=</code>
10142: operator may be overridden by a package.</p>
10143: <p>Variables that are defined using the <code class="literal">=</code>
10144: operator may be used read-only at run-time.</p>
10145: <p>Variables whose name starts with an underscore must not be
10146: accessed outside the pkgsrc infrastructure at all. They may
10147: change without further notice.</p>
10148: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10149: <h3 class="title">Note</h3>
10150: <p>These conventions are currently not applied
10151: consistently to the complete pkgsrc
10152: infrastructure.</p>
10153: </div>
10154: </div>
10155: <div class="sect1" lang="en">
10156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10157: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10158: <p>All variables that contain lists of things should default
10159: to being empty. Two examples that do not follow this rule are
10160: <code class="varname">USE_LANGUAGES</code> and
10161: <code class="varname">DISTFILES</code>. These variables cannot simply be
10162: modified using the <code class="literal">+=</code> operator in package
10163: <code class="filename">Makefile</code>s (or other files included by
10164: them), since there is no guarantee whether the variable is
10165: already set or not, and what its value is. In the case of
10166: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10167: the default value and just define it as in the following
10168: example.</p>
10169: <pre class="programlisting">
1.100 rillig 10170: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10171: </pre>
10172: <p>Because of the selection of this default value, the same
10173: value appears in many package Makefiles. Similarly for
10174: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10175: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10176: doesn't stand out. Nevertheless it is mentioned in many
10177: files.</p>
10178: </div>
10179: <div class="sect1" lang="en">
10180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10181: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75 rillig 10182: <div class="sect2" lang="en">
10183: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10184: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75 rillig 10185: <p>Variable evaluation takes place either at load time or at
10186: runtime, depending on the context in which they occur. The
10187: contexts where variables are evaluated at load time are:</p>
10188: <div class="itemizedlist"><ul type="disc">
10189: <li><p>The right hand side of the <code class="literal">:=</code>
10190: and <code class="literal">!=</code> operators,</p></li>
10191: <li><p>Make directives like <code class="literal">.if</code> or
10192: <code class="literal">.for</code>,</p></li>
10193: <li><p>Dependency lines.</p></li>
10194: </ul></div>
10195: <p>A special exception are references to the iteration
10196: variables of <code class="literal">.for</code> loops, which are expanded
10197: inline, no matter in which context they appear.</p>
10198: <p>As the values of variables may change during load time,
10199: care must be taken not to evaluate them by accident. Typical
10200: examples for variables that should not be evaluated at load time
10201: are <code class="varname">DEPENDS</code> and
10202: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10203: clear, here is an example:</p>
10204: <pre class="programlisting">
1.100 rillig 10205: CONFIGURE_ARGS= # none
10206: CFLAGS= -O
10207: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10208:
1.100 rillig 10209: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10210:
1.100 rillig 10211: CFLAGS+= -Wall
1.75 rillig 10212: </pre>
10213: <p>This code shows how the use of the <code class="literal">:=</code>
10214: operator can quickly lead to unexpected results. The first
10215: paragraph is fairly common code. The second paragraph evaluates
10216: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10217: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10218: <code class="literal">-Wall</code> is appended to the
10219: <code class="varname">CFLAGS</code>, but this addition will not appear in
10220: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10221: paragraphs from above typically occur in completely unrelated
10222: files.</p>
10223: </div>
10224: <div class="sect2" lang="en">
10225: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10226: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75 rillig 10227: <p>After all the files have been loaded, the values of the
10228: variables cannot be changed anymore. Variables that are used in
10229: the shell commands are expanded at this point.</p>
10230: </div>
10231: </div>
10232: <div class="sect1" lang="en">
10233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10234: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10235: <p>There are many ways in which the definition and use of a
10236: variable can be restricted in order to detect bugs and
10237: violations of the (mostly unwritten) policies. See the
10238: <code class="literal">pkglint</code> developer's documentation for further
10239: details.</p>
10240: </div>
10241: <div class="sect1" lang="en">
10242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10243: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10244: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10245: of the following classes. Cases where a file falls into more
10246: than one class should be avoided as it often leads to subtle
10247: bugs.</p>
10248: <div class="sect2" lang="en">
10249: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10250: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10251: <p>In a traditional imperative programming language some of
1.76 rillig 10252: the <code class="filename">.mk</code> files could be described as
1.89 rillig 10253: procedures. They take some input parameters and—after
10254: inclusion—provide a result in output parameters. Since all
1.76 rillig 10255: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10256: care must be taken not to use parameter names that have already
10257: another meaning. For example, <code class="varname">PKGNAME</code> is a
10258: bad choice for a parameter name.</p>
10259: <p>Procedures are completely evaluated at preprocessing time.
10260: That is, when calling a procedure all input parameters must be
10261: completely resolvable. For example,
10262: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10263: parameter since it is very likely that further text will be
10264: added after calling the procedure, which would effectively apply
10265: the procedure to only a part of the variable. Also, references
10266: to other variables wit will be modified after calling the
10267: procedure.</p>
10268: <p>A procedure can declare its output parameters either as
10269: suitable for use in preprocessing directives or as only
10270: available at runtime. The latter alternative is for variables
10271: that contain references to other runtime variables.</p>
10272: <p>Procedures shall be written such that it is possible to
10273: call the procedure more than once. That is, the file must not
10274: contain multiple-inclusion guards.</p>
10275: <p>Examples for procedures are
1.76 rillig 10276: <code class="filename">mk/bsd.options.mk</code> and
10277: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10278: that the parameters are evaluated at load time, they should be
10279: assigned using the <code class="literal">:=</code> operator, which should
10280: be used only for this purpose.</p>
10281: </div>
10282: <div class="sect2" lang="en">
10283: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10284: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10285: <p>Action files take some input parameters and may define
10286: runtime variables. They shall not define loadtime variables.
10287: There are action files that are included implicitly by the
10288: pkgsrc infrastructure, while other must be included
10289: explicitly.</p>
10290: <p>An example for action files is
1.76 rillig 10291: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10292: </div>
10293: </div>
1.81 rillig 10294: <div class="sect1" lang="en">
10295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10296: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10297: <p>Package <code class="filename">Makefile</code>s usually consist of
10298: a set of variable definitions, and include the file
10299: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10300: Before that, they may also include various other
10301: <code class="filename">*.mk</code> files if they need to query the
10302: availability of certain features like the type of compiler or
10303: the X11 implementation. Due to the heavy use of preprocessor
10304: directives like <code class="literal">.if</code> and
10305: <code class="literal">.for</code>, the order in which the files are loaded
10306: matters.</p>
10307: <p>This section describes at which point the various files
10308: are loaded and gives reasons for that order.</p>
10309: <div class="sect2" lang="en">
10310: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10311: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code>
10312: </h3></div></div></div>
10313: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10314: is to define some essential variables like
10315: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10316: <code class="varname">MACHINE_ARCH</code>.</p>
10317: <p>Then, the user settings are loaded from the file specified
10318: in <code class="varname">MAKECONF</code>. If the bmake command from pkgsrc
10319: is used, <code class="varname">MAKECONF</code> defaults to
10320: <code class="filename"><em class="replaceable"><code>${prefix}</code></em>/etc/mk.conf</code>.
10321: With the native <a 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 on NetBSD, it defaults to
10322: <code class="filename">/etc/mk.conf</code>. After that, those variables
10323: that have not been overridden by the user are loaded from
10324: <code class="filename">mk/defaults/mk.conf</code>.</p>
10325: <p>After the user settings, the system settings and platform
10326: settings are loaded, which may override the user
10327: settings.</p>
10328: <p>Then, the tool definitions are loaded. The tool wrappers
10329: are not yet in effect. This only happens when building a
10330: package, so the proper variables must be used instead of the
10331: direct tool names.</p>
10332: <p>As the last steps, some essential variables from the
10333: wrapper and the package system flavor are loaded, as well as the
10334: variables that have been cached in earlier phases of a package
10335: build.</p>
10336: </div>
10337: <div class="sect2" lang="en">
10338: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10339: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code>
10340: </h3></div></div></div>
1.81 rillig 10341: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10342: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10343: loaded, which fill default values for those variables that have
1.93 rillig 10344: not been defined by the package. These variables may later
1.81 rillig 10345: be used even in unrelated files.</p>
10346: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10347: provides the target <code class="literal">error-check</code> that is added
10348: as a special dependency to all other targets that use
10349: <code class="varname">DELAYED_ERROR_MSG</code> or
10350: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10351: <p>Then, the package-specific hacks from
10352: <code class="filename">hacks.mk</code> are included.</p>
10353: <p>Then, various other files follow. Most of them don't have
10354: any dependencies on what they need to have included before or
10355: after them, though some do.</p>
10356: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10357: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10358: restricts the use of these variables to all the files that have
10359: been included before. Appearances in later files will be
10360: silently ignored.</p>
10361: <p>Then, the files for the main targets are included, in the
10362: order of later execution, though the actual order should not
10363: matter.</p>
10364: <p>At last, some more files are included that don't set any
10365: interesting variables but rather just define make targets to be
10366: executed.</p>
10367: </div>
10368: </div>
1.75 rillig 10369: </div>
10370: <div class="chapter" lang="en">
10371: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10372: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75 rillig 10373: <div class="toc">
10374: <p><b>Table of Contents</b></p>
10375: <dl>
1.90 rillig 10376: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10377: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10378: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10379: <dd><dl>
1.90 rillig 10380: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10381: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10382: </dl></dd>
10383: </dl>
10384: </div>
10385: <p>The pkgsrc infrastructure consists of a large codebase,
10386: and there are many corners where every little bit of a file is
10387: well thought out, making pkgsrc likely to fail as soon as
10388: anything is changed near those parts. To prevent most changes
10389: from breaking anything, a suite of regression tests should go
10390: along with every important part of the pkgsrc infrastructure.
10391: This chapter describes how regression tests work in pkgsrc and
10392: how you can add new tests.</p>
10393: <div class="sect1" lang="en">
10394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10395: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10396: <p></p>
10397: </div>
10398: <div class="sect1" lang="en">
10399: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10400: <a name="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10401: <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.75 rillig 10402: provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
10403: can simply run that command, which will run all tests in the
1.76 rillig 10404: <code class="filename">regress</code> category.</p>
1.75 rillig 10405: </div>
10406: <div class="sect1" lang="en">
10407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10408: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10409: <p>Every directory in the <code class="filename">regress</code>
10410: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10411: is considered a regression test. This file is a shell program
10412: that is included by the <span><strong class="command">pkg_regress</strong></span> command.
10413: The following functions can be overridden to suit your
10414: needs.</p>
10415: <div class="sect2" lang="en">
10416: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10417: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10418: <p>These functions do not take any parameters. They are all
10419: called in “<span class="quote">set -e</span>” mode, so you should be careful
10420: to check the exitcodes of any commands you run in the
10421: test.</p>
10422: <div class="variablelist"><dl>
10423: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10424: <dd><p>This function prepares the environment for the
10425: test. By default it does nothing.</p></dd>
10426: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10427: <dd><p>This function runs the actual test. By default,
10428: it calls <code class="varname">TEST_MAKE</code> with the arguments
10429: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10430: error messages into the file
10431: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10432: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10433: <dd><p>This function is run after the test and is
10434: typically used to compare the actual output from the one that is
10435: expected. It can make use of the various helper functions from
10436: the next section.</p></dd>
10437: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10438: <dd><p>This function cleans everything up after the
10439: test has been run. By default it does nothing.</p></dd>
10440: </dl></div>
10441: </div>
10442: <div class="sect2" lang="en">
10443: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10444: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10445: <div class="variablelist"><dl>
10446: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10447: <dd><p>This function compares the exitcode of the
10448: <span><strong class="command">do_test()</strong></span> function with its first parameter.
10449: If they differ, the test will fail.</p></dd>
10450: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10451: <dd><p>This function checks for each of its parameters
10452: if the output from <span><strong class="command">do_test()</strong></span> matches the
10453: extended regular expression. If it does not, the test will
10454: fail.</p></dd>
10455: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10456: <dd><p>This function checks for each of its parameters
10457: if the output from <span><strong class="command">do_test()</strong></span> does
10458: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10459: If any of the regular expressions matches, the test will
10460: fail.</p></dd>
10461: </dl></div>
10462: </div>
10463: </div>
10464: </div>
10465: <div class="chapter" lang="en">
10466: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10467: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10468: <div class="toc">
10469: <p><b>Table of Contents</b></p>
10470: <dl>
1.90 rillig 10471: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10472: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10473: </dl>
10474: </div>
10475: <p>The pkgsrc system has already been ported to many
10476: operating systems, hardware architectures and compilers. This
10477: chapter explains the necessary steps to make pkgsrc even more
10478: portable.</p>
10479: <div class="sect1" lang="en">
10480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10481: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10482: <p>To port pkgsrc to a new operating system (called
10483: <code class="literal">MyOS</code> in this example), you need to touch the
10484: following files:</p>
10485: <div class="variablelist"><dl>
1.93 rillig 10486: <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 10487: <dd><p>This file contains some basic definitions, for
10488: example the name of the C
10489: compiler.</p></dd>
1.76 rillig 10490: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10491: <dd><p>Insert code that defines the variables
10492: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10493: <code class="varname">LOWER_OS_VERSION</code>,
10494: <code class="varname">LOWER_VENDOR</code>,
10495: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10496: <code class="varname">APPEND_ELF</code>, and the other variables that
10497: appear in this file.</p></dd>
1.93 rillig 10498: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10499: <dd><p>This file contains the platform-specific
10500: definitions that are used by pkgsrc. Start by copying one of the
10501: other files and edit it to your
10502: needs.</p></dd>
1.93 rillig 10503: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10504: <dd><p>This file contains a list of directories,
10505: together with their permission bits and ownership. These
10506: directories will be created automatically with every package
1.98 wiz 10507: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10508: be removed.</p></dd>
1.93 rillig 10509: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10510: <dd><p>Just copy one of the pre-existing x11.dist files
10511: to your
1.76 rillig 10512: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10513: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10514: <dd><p>On some operating systems, the tools that are
10515: provided with the base system are not good enough for pkgsrc.
10516: For example, there are many versions of <a 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
10517: narrow limit on the line length they can process. Therefore
10518: pkgsrc brings its own tools, which can be enabled
10519: here.</p></dd>
1.93 rillig 10520: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10521: <dd><p>This file defines the paths to all the tools
10522: that are needed by one or the other package in pkgsrc, as well
10523: as by pkgsrc itself. Find out where these tools are on your
10524: platform and add them.</p></dd>
10525: </dl></div>
10526: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10527: <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 10528: </div>
10529: <div class="sect1" lang="en">
10530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10531: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10532: <p>TODO</p>
10533: </div>
10534: </div>
10535: </div>
10536: <div class="appendix" lang="en">
10537: <div class="titlepage"><div><div><h2 class="title">
10538: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10539: <div class="toc">
10540: <p><b>Table of Contents</b></p>
10541: <dl>
10542: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10543: <dd><dl>
10544: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10545: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10546: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10547: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
10548: </dl></dd>
10549: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10550: </dl>
10551: </div>
10552: <p>We checked to find a piece of software that wasn't in the packages
10553: collection, and picked GNU bison. Quite why someone would want to have
10554: <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
10555: present in the tree is beyond us, but it's useful for the purposes of
10556: this exercise.</p>
10557: <div class="sect1" lang="en">
10558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10559: <a name="example-files"></a>A.1. files</h2></div></div></div>
10560: <div class="sect2" lang="en">
10561: <div class="titlepage"><div><div><h3 class="title">
10562: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10563: <pre class="programlisting">
1.100 rillig 10564: # $NetBSD$
10565: #
1.1 grant 10566:
1.100 rillig 10567: DISTNAME= bison-1.25
10568: CATEGORIES= devel
10569: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10570:
1.100 rillig 10571: MAINTAINER= thorpej@NetBSD.org
10572: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10573: COMMENT= GNU yacc clone
1.1 grant 10574:
1.100 rillig 10575: GNU_CONFIGURE= yes
10576: INFO_FILES= bison.info
1.1 grant 10577:
1.100 rillig 10578: .include "../../mk/bsd.pkg.mk"
1.1 grant 10579: </pre>
1.75 rillig 10580: </div>
10581: <div class="sect2" lang="en">
10582: <div class="titlepage"><div><div><h3 class="title">
10583: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10584: <pre class="programlisting">
1.100 rillig 10585: GNU version of yacc. Can make re-entrant parsers, and numerous other
10586: improvements. Why you would want this when Berkeley <a 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
10587: of the NetBSD source tree is beyond me.
1.1 grant 10588: </pre>
1.75 rillig 10589: </div>
10590: <div class="sect2" lang="en">
10591: <div class="titlepage"><div><div><h3 class="title">
10592: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10593: <pre class="programlisting">
1.100 rillig 10594: @comment $NetBSD$
10595: bin/bison
10596: man/man1/bison.1.gz
10597: share/bison.simple
10598: share/bison.hairy
1.1 grant 10599: </pre>
1.75 rillig 10600: </div>
10601: <div class="sect2" lang="en">
10602: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10603: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
10604: </h3></div></div></div>
1.75 rillig 10605: <p>The NetBSD package system comes with
1.91 rillig 10606: <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 10607: which helps to check the contents of these
10608: files. After installation it is quite easy to use, just change to the
10609: directory of the package you wish to examine and execute
10610: <span><strong class="command">pkglint</strong></span>:</p>
10611: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10612: looks fine.</pre>
10613: <p>Depending on the supplied command line arguments (see pkglint(1)),
10614: more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
10615: -Wall</strong></span> for a very thorough check.</p>
10616: </div>
10617: </div>
10618: <div class="sect1" lang="en">
10619: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10620: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10621: <p>Create the directory where the package lives,
10622: plus any auxiliary directories:</p>
10623: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10624: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10625: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10626: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10627: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90 rillig 10628: <code class="filename">PLIST</code> (see <a href="#components" title="Chapter 10. Package components - files, directories and contents">Chapter 10, <i>Package components - files, directories and contents</i></a>)
1.75 rillig 10629: then continue with fetching the distfile:</p>
10630: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10631: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10632: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10633: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10634: ftp: Error retrieving file: 500 Internal error
10635:
10636: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10637: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10638: ftp: Error retrieving file: 500 Internal error
10639:
10640: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10641: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10642: Successfully retrieved file.</pre>
10643: <p>Generate the checksum of the distfile into
1.76 rillig 10644: <code class="filename">distinfo</code>:</p>
1.88 wiz 10645: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10646: <p>Now compile:</p>
10647: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10648: >> Checksum OK for bison-1.25.tar.gz.
10649: ===> Extracting for bison-1.25
10650: ===> Patching for bison-1.25
10651: ===> Ignoring empty patch directory
10652: ===> Configuring for bison-1.25
10653: creating cache ./config.cache
10654: checking for gcc... cc
10655: checking whether we are using GNU C... yes
10656: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10657: checking how to run the C preprocessor... cc -E
10658: checking for minix/config.h... no
10659: checking for POSIXized ISC... no
10660: checking whether cross-compiling... no
10661: checking for ANSI C header files... yes
10662: checking for string.h... yes
10663: checking for stdlib.h... yes
10664: checking for memory.h... yes
10665: checking for working const... yes
10666: checking for working alloca.h... no
10667: checking for alloca... yes
10668: checking for strerror... yes
10669: updating cache ./config.cache
10670: creating ./config.status
10671: creating Makefile
10672: ===> Building for bison-1.25
10673: 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
10674: 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
10675: 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
10676: 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
10677: 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 10678: 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 10679: 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
10680: 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
10681: 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
10682: 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
10683: 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
10684: 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
10685: 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
10686: 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
10687: 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
10688: 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
10689: 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
10690: 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
10691: 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
10692: 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
10693: 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
10694: 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
10695: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10696: rm -f bison.s1
1.75 rillig 10697: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10698: <p>Everything seems OK, so install the files:</p>
10699: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10700: >> Checksum OK for bison-1.25.tar.gz.
10701: ===> Installing for bison-1.25
10702: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10703: rm -f /usr/pkg/bin/bison
10704: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10705: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10706: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10707: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10708: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10709: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10710: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10711: ===> Registering installation for bison-1.25</pre>
10712: <p>You can now use bison, and also - if you decide so - remove it with
10713: <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
10714: binary package, do this now:</p>
10715: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10716: >> Checksum OK for bison-1.25.tar.gz.
10717: ===> Building package for bison-1.25
10718: Creating package bison-1.25.tgz
10719: Registering depends:.
1.75 rillig 10720: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10721: <p>Now that you don't need the source and object files
10722: any more, clean up:</p>
10723: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10724: ===> Cleaning for bison-1.25</pre>
10725: </div>
10726: </div>
10727: <div class="appendix" lang="en">
10728: <div class="titlepage"><div><div><h2 class="title">
10729: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10730: <div class="toc">
10731: <p><b>Table of Contents</b></p>
10732: <dl>
10733: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10734: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10735: </dl>
10736: </div>
10737: <div class="sect1" lang="en">
10738: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10739: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10740: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10741: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10742: => figlet221.tar.gz doesn't seem to exist on this system.
10743: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10744: => [172219 bytes]
10745: Connected to ftp.plig.net.
10746: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10747: 331 Guest login ok, send your complete e-mail address as password.
10748: 230-You are user #5 of 500 simultaneous users allowed.
10749: 230-
1.68 rillig 10750: 230- ___ _ _ _
10751: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10752: 230- | _| _| . |_| . | | | . |_| . | _| . |
10753: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10754: 230- |_| |_| |___| |___|
10755: 230-
10756: 230-** Welcome to ftp.plig.org **
10757: 230-
10758: 230-Please note that all transfers from this FTP site are logged. If you
10759: 230-do not like this, please disconnect now.
10760: 230-
10761: 230-This arhive is available via
10762: 230-
10763: 230-HTTP: http://ftp.plig.org/
10764: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10765: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10766: 230-
10767: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10768: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10769: 230-
10770: 230-
10771: 230 Logged in anonymously.
10772: Remote system type is UNIX.
10773: Using binary mode to transfer files.
10774: 200 Type okay.
10775: 250 "/pub" is new cwd.
10776: 250-"/pub/figlet" is new cwd.
10777: 250-
10778: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10779: 250-
1.75 rillig 10780: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10781: 250-
10782: 250-The official FIGlet web page is:
1.75 rillig 10783: 250- http://www.figlet.org/
1.1 grant 10784: 250-
10785: 250-If you have questions, please mailto:info@figlet.org. If you want to
10786: 250-contribute a font or something else, you can email us.
1.68 rillig 10787: 250
1.1 grant 10788: 250 "/pub/figlet/program" is new cwd.
10789: 250 "/pub/figlet/program/unix" is new cwd.
10790: local: figlet221.tar.gz remote: figlet221.tar.gz
10791: 502 Unimplemented command.
10792: 227 Entering Passive Mode (195,40,6,41,246,104)
10793: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10794: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10795: 226 Transfer completed.
10796: 172219 bytes received in 00:02 (75.99 KB/s)
10797: 221 Goodbye.
10798: => Checksum OK for figlet221.tar.gz.
10799: ===> Extracting for figlet-2.2.1nb2
10800: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10801: ===> Patching for figlet-2.2.1nb2
10802: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10803: ===> Overriding tools for figlet-2.2.1nb2
10804: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10805: ===> Configuring for figlet-2.2.1nb2
10806: ===> Building for figlet-2.2.1nb2
10807: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10808: chmod a+x figlet
10809: gcc -O2 -o chkfont chkfont.c
10810: => Unwrapping files-to-be-installed.
1.14 xtraeme 10811: <code class="prompt">#</code>
1.75 rillig 10812: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10813: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10814: ===> Installing for figlet-2.2.1nb2
10815: install -d -o root -g wheel -m 755 /usr/pkg/bin
10816: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10817: mkdir -p /usr/pkg/share/figlet
10818: cp figlet /usr/pkg/bin
10819: cp chkfont /usr/pkg/bin
10820: chmod 555 figlist showfigfonts
10821: cp figlist /usr/pkg/bin
10822: cp showfigfonts /usr/pkg/bin
10823: cp fonts/*.flf /usr/pkg/share/figlet
10824: cp fonts/*.flc /usr/pkg/share/figlet
10825: cp figlet.6 /usr/pkg/man/man6
10826: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10827: <code class="prompt">#</code></pre>
10828: </div>
10829: <div class="sect1" lang="en">
10830: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10831: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10832: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10833: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10834: ===> Packaging figlet-2.2.1nb2
10835: ===> Building binary package for figlet-2.2.1nb2
10836: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10837: Using SrcDir value of /usr/pkg
1.68 rillig 10838: Registering depends:.
1.75 rillig 10839: <code class="prompt">#</code></pre>
10840: </div>
10841: </div>
10842: <div class="appendix" lang="en">
10843: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10844: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10845: <div class="toc">
10846: <p><b>Table of Contents</b></p>
10847: <dl>
10848: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10849: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10850: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10851: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10852: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
10853: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 rillig 10854: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10855: source packages</a></span></dt>
10856: </dl>
10857: </div>
10858: <p>As in other big projects, the directory layout of pkgsrc
10859: is quite complex for newbies. This chapter explains where you
10860: find things on the FTP server. The base directory on
1.89 rillig 10861: <code class="filename">ftp.NetBSD.org</code> is <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
10862: On other servers it may be different, but inside this directory,
10863: everything should look the same, no matter on which server you
10864: are. This directory contains some subdirectories, which are
10865: explained below.</p>
1.76 rillig 10866: <div class="sect1" lang="en">
10867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10868: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
10869: <p>For those who only want to manage binary packages on
10870: systems other than NetBSD, we provide the package management
10871: tools in a separate, small tar file.</p>
10872: </div>
10873: <div class="sect1" lang="en">
10874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10875: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10876: <p>The directory <code class="filename">distfiles</code> contains lots
10877: of archive files from all pkgsrc packages, which are mirrored
10878: here. The subdirectories are called after their package names
10879: and are used when the distributed files have names that don't
10880: explicitly contain a version number or are otherwise too generic
10881: (for example <code class="filename">release.tar.gz</code>).</p>
10882: </div>
10883: <div class="sect1" lang="en">
10884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10885: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10886: <p>This directory is currently not in use.</p>
10887: </div>
10888: <div class="sect1" lang="en">
10889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10890: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10891: <p>This directory contains things that individual pkgsrc
10892: developers find worth publishing.</p>
10893: </div>
10894: <div class="sect1" lang="en">
10895: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10896: <a name="ftp-packages"></a>C.5. <code class="filename">packages*</code>: Binary packages</h2></div></div></div>
10897: <p>These directories contain binary packages. Those
10898: directories that have a branch name
10899: (200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>)
10900: contain packages from that particular branch. The directory
10901: <code class="filename">packages</code> contains binary packages from
10902: pkgsrc-current. (However, this does not necessarily mean that
10903: the packages are still current anymore.)</p>
10904: <p>Below the <code class="filename">packages*</code> directories are
10905: directories that distinguish the packages by operating system
10906: and version, the next directory level specifies the hardware
10907: architecture.</p>
10908: <p>In each of the platform-specific directories, there is a
10909: whole binary packages collection. It has a directory called
10910: <code class="filename">All</code> which contains all binary packages.
10911: Besides that, there are various category directories that
10912: contain symbolic links to the real binary packages.</p>
10913: </div>
10914: <div class="sect1" lang="en">
10915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10916: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
1.93 rillig 10917: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10918: source packages</h2></div></div></div>
10919: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
10920: that is the files that define how to create binary packages from
10921: source archives.</p>
10922: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10923: snapshot of the CVS repository, which is updated regularly. The
10924: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10925: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10926: <p>In the directories for the quarterly branches, there is an
10927: additional file called
10928: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10929: which contains the state of pkgsrc when it was branched.</p>
10930: </div>
1.75 rillig 10931: </div>
10932: <div class="appendix" lang="en">
10933: <div class="titlepage"><div><div><h2 class="title">
10934: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
10935: <div class="toc">
10936: <p><b>Table of Contents</b></p>
10937: <dl>
1.79 rillig 10938: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10939: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10940: </dl>
10941: </div>
1.79 rillig 10942: <p>This section contains information on editing the pkgsrc
10943: guide itself.</p>
1.75 rillig 10944: <div class="sect1" lang="en">
10945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10946: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10947: <p>The pkgsrc guide's source code is stored in
10948: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10949: are created from it:</p>
10950: <div class="itemizedlist"><ul type="disc">
10951: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10952: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.101 ! rillig 10953: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
! 10954: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79 rillig 10955: The PDF version of the pkgsrc guide.</p></li>
1.101 ! rillig 10956: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79 rillig 10957: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10958: </ul></div>
10959: </div>
10960: <div class="sect1" lang="en">
10961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10962: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10963: <p>The procedure to edit the pkgsrc guide is:</p>
10964: <div class="procedure"><ol type="1">
10965: <li><p>Make sure you have the packages needed to
1.83 wiz 10966: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 10967: 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
10968: 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 10969: PostScript and PDF versions. You will need both packages
10970: installed, to make sure documentation is consistent across all
10971: formats.</p></li>
10972: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
10973: right directory. All further steps will take place
10974: here.</p></li>
10975: <li><p>Edit the XML file(s) in
10976: <code class="filename">files/</code>.</p></li>
10977: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
10978: guide for valid XML and to build the final output files. If you
10979: get any errors at this stage, you can just edit the files, as
10980: there are only symbolic links in the working directory, pointing
10981: to the files in <code class="filename">files/</code>.</p></li>
10982: <li><p><span><strong class="command">(cd files && cvs
10983: commit)</strong></span></p></li>
10984: <li><p>Run <span><strong class="command">bmake clean && bmake</strong></span> to
10985: regenerate the output files with the proper RCS
10986: Ids.</p></li>
1.91 rillig 10987: <li>
10988: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
10989: commit the files in both <code class="filename">pkgsrc/doc</code> and
10990: <code class="filename">htdocs</code>.</p>
10991: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10992: <h3 class="title">Note</h3>
10993: <p>If you have added, removed or renamed some chapters,
1.83 wiz 10994: you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
10995: <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91 rillig 10996: directory.</p>
10997: </div>
10998: </li>
1.79 rillig 10999: </ol></div>
1.75 rillig 11000: </div>
11001: </div>
11002: </div></body>
1.1 grant 11003: </html>
CVSweb <webmaster@jp.NetBSD.org>