Annotation of pkgsrc/doc/pkgsrc.html, revision 1.96
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>
6: <link rel="stylesheet" href="/NetBSD.css" type="text/css">
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>
69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
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>
207: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
208: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
209: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
210: <dd><dl>
211: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
212: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
213: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
214: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
215: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
216: </dl></dd>
217: </dl></dd>
218: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
219: <dd><dl>
220: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
221: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
222: <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>
223: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
224: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
225: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
226: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
227: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
228: </dl></dd>
229: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
230: <dd><dl>
231: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
232: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
233: <dd><dl>
234: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
235: <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>
236: </dl></dd>
237: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
238: <dd><dl>
239: <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>
240: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
241: </dl></dd>
242: </dl></dd>
243: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
244: <dd><dl>
245: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
246: <dd><dl>
247: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
248: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
249: </dl></dd>
250: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
251: <dd><dl>
252: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
253: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
254: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
255: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
256: </dl></dd>
257: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
258: <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>
259: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
260: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
261: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
262: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
263: <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>
264: </dl></dd>
265: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
266: <dd><dl>
267: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
268: <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>
269: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
270: </dl></dd>
271: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
272: <dd><dl>
273: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
274: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
275: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
276: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
277: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
278: <dd><dl>
279: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
280: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
281: </dl></dd>
282: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
283: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
284: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
285: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
286: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
287: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
288: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
289: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
293: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
294: </dl></dd>
295: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
296: <dd><dl>
297: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
298: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
299: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
300: </dl></dd>
301: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
302: <dd><dl>
303: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
304: <dd><dl>
305: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
306: <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>
307: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
308: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
309: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
310: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
311: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
312: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
313: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
314: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
315: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
316: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
317: </dl></dd>
318: <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>
319: <dd><dl>
320: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
321: <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>
322: </dl></dd>
323: <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>
324: <dd><dl>
325: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
326: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
327: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
328: </dl></dd>
329: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
330: <dd><dl>
331: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
332: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
333: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
334: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
335: </dl></dd>
336: <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>
337: <dd><dl>
338: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
339: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
340: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
341: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
342: </dl></dd>
343: <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>
344: <dd><dl>
345: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
346: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
347: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
348: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
349: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
350: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
351: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
352: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
353: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
354: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
355: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
356: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
357: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
358: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
359: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
360: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
361: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 362: emulation</a></span></dt>
1.90 rillig 363: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
364: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77 rillig 365: </dl></dd>
1.90 rillig 366: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 367: </dl></dd>
1.90 rillig 368: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
369: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 370: <dd><dl>
1.90 rillig 371: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
372: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
373: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
374: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
375: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
376: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
377: </dl></dd>
378: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
379: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
380: <dd><dl>
381: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
382: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
383: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
384: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 385: </dl></dd>
1.75 rillig 386: </dl></dd>
387: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
388: <dd><dl>
1.90 rillig 389: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 390: <dd><dl>
1.90 rillig 391: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
392: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
393: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 394: <dd><dl>
1.90 rillig 395: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
396: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 397: </dl></dd>
1.90 rillig 398: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
399: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 400: <dd><dl>
1.90 rillig 401: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
402: <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 403: </dl></dd>
1.90 rillig 404: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 405: <dd><dl>
1.90 rillig 406: <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>
407: <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 408: </dl></dd>
409: </dl></dd>
1.90 rillig 410: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 411: <dd><dl>
1.90 rillig 412: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
413: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
414: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 415: <dd><dl>
1.90 rillig 416: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
417: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 418: </dl></dd>
419: </dl></dd>
1.90 rillig 420: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 421: <dd><dl>
1.90 rillig 422: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
423: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 424: </dl></dd>
425: </dl></dd>
426: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
427: <dd><dl>
428: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
429: <dd><dl>
430: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
431: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
432: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
433: <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>
434: </dl></dd>
435: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
436: </dl></dd>
437: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
438: <dd><dl>
439: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
440: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
441: </dl></dd>
1.76 rillig 442: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
443: <dd><dl>
444: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
445: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
446: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
447: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
448: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
449: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 rillig 450: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 451: source packages</a></span></dt>
452: </dl></dd>
1.75 rillig 453: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
454: <dd><dl>
1.79 rillig 455: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 456: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
457: </dl></dd>
458: </dl>
459: </div>
1.82 rillig 460: <div class="list-of-tables">
461: <p><b>List of Tables</b></p>
462: <dl>
463: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
464: </dt>
465: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
466: </dt>
1.90 rillig 467: <dt>10.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 468: </dt>
1.90 rillig 469: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 470: </dt>
1.82 rillig 471: </dl>
472: </div>
1.75 rillig 473: <div class="chapter" lang="en">
474: <div class="titlepage"><div><div><h2 class="title">
475: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
476: <div class="toc">
477: <p><b>Table of Contents</b></p>
478: <dl>
479: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 480: <dd><dl>
481: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
482: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
483: </dl></dd>
1.75 rillig 484: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
485: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 486: <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 487: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
488: </dl>
489: </div>
490: <div class="sect1" lang="en">
491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
492: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 493: <p>There is a lot of software freely available for Unix-based
494: systems, which is usually available in form of the source code. Before
495: such software can be used, it needs to be configured to the local
496: system, compiled and installed, and this is exactly what The NetBSD
497: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
498: to handle binary packages, so that not every user has to build the
499: packages for himself, which is a time-costly task.</p>
1.75 rillig 500: <p>pkgsrc currently contains several thousand packages,
501: including:</p>
502: <div class="itemizedlist"><ul type="disc">
1.91 rillig 503: <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 504: web server</p></li>
1.91 rillig 505: <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 506: web browser</p></li>
1.91 rillig 507: <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 508: Desktop Environment</p></li>
1.91 rillig 509: <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 510: Desktop Environment</p></li>
511: </ul></div>
512: <p>...just to name a few.</p>
513: <p>pkgsrc has built-in support for handling varying dependencies,
514: such as pthreads and X11, and extended features such as IPv6 support on
515: a range of platforms.</p>
1.82 rillig 516: <div class="sect2" lang="en">
517: <div class="titlepage"><div><div><h3 class="title">
518: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
519: <p>
520: pkgsrc provides the following key features:
521: </p>
522: <div class="itemizedlist"><ul type="disc">
523: <li><p>Easy building of software from source as well as the creation
524: and installation of binary packages. The source and latest
525: patches are retrieved from a master or mirror download site, checksum
526: verified, then built on your system. Support for binary-only
527: distributions is available for both native platforms and NetBSD
528: emulated platforms.</p></li>
529: <li><p>All packages are installed in a consistent directory tree,
530: including binaries, libraries, man pages and other
531: documentation.</p></li>
532: <li><p>Package dependencies, including when performing package updates,
533: are handled automatically. The configuration files of various
534: packages are handled automatically during updates, so local changes
535: are preserved.</p></li>
536: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
537: consists of highly portable code. This allows the greatest speed of
538: development when porting to new a platform. This portability also
539: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
540: platforms</em></span>.</p></li>
541: <li><p>The installation prefix, acceptable software licenses,
542: international encryption requirements and build-time options for a
543: large number of packages are all set in a simple, central
544: configuration file.</p></li>
545: <li><p>The entire source (not including the distribution files) is
546: freely available under a BSD license, so you may extend and adapt
547: pkgsrc to your needs. Support for local packages and patches is
548: available right out of the box, so you can configure it specifically
549: for your environment.</p></li>
550: </ul></div>
1.91 rillig 551: <p>The following principles are basic to pkgsrc:</p>
552: <div class="itemizedlist"><ul type="disc">
553: <li><p>“<span class="quote">It should only work if it's right.</span>”
554: — That means, if a package contains bugs, it's better to find
555: them and to complain about them rather than to just install the package
556: and hope that it works. There are numerous checks in pkgsrc that try to
557: 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
558: of shell scripts), and post-installation checks (installed files,
559: references to shared libraries, script interpreters).</p></li>
560: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
561: — Like NetBSD has been ported to many hardware architectures,
562: pkgsrc has been ported to many operating systems. Care is taken that
563: packages behave the same on all platforms.</p></li>
564: </ul></div>
1.82 rillig 565: </div>
566: <div class="sect2" lang="en">
567: <div class="titlepage"><div><div><h3 class="title">
568: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
569: <p>pkgsrc consists of both a source distribution and a binary
570: distribution for these operating systems. After retrieving the required
571: source or binaries, you can be up and running with pkgsrc in just
572: minutes!</p>
1.75 rillig 573: <p>pkgsrc was derived from FreeBSD's ports system, and
574: initially developed for NetBSD only. Since then, pkgsrc has
575: grown a lot, and now supports the following platforms:</p>
1.82 rillig 576: <div class="table">
577: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 578: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 579: <colgroup>
580: <col>
581: <col>
582: </colgroup>
583: <thead><tr>
584: <th>Platform</th>
585: <th>Date Support Added</th>
586: </tr></thead>
587: <tbody>
588: <tr>
589: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
590: <td align="center">Aug 1997</td>
591: </tr>
592: <tr>
593: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
594: <td align="center">Mar 1999</td>
595: </tr>
596: <tr>
597: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
598: <td align="center">Jun 1999</td>
599: </tr>
600: <tr>
601: <td>
602: <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
603: (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
604: </td>
605: <td align="center">Oct 2001</td>
606: </tr>
607: <tr>
608: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
609: <td align="center">Nov 2002</td>
610: </tr>
611: <tr>
612: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
613: <td align="center">Nov 2002</td>
614: </tr>
615: <tr>
616: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
617: <td align="center">Dec 2002</td>
618: </tr>
619: <tr>
620: <td>BSD/OS</td>
621: <td align="center">Dec 2003</td>
622: </tr>
623: <tr>
624: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
625: <td align="center">Dec 2003</td>
626: </tr>
627: <tr>
628: <td>
629: <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
630: (Microsoft Windows Services for Unix)
631: </td>
632: <td align="center">Mar 2004</td>
633: </tr>
634: <tr>
635: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
636: <td align="center">Oct 2004</td>
637: </tr>
638: <tr>
639: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
640: <td align="center">Nov 2004</td>
641: </tr>
642: </tbody>
1.91 rillig 643: </table></div>
1.82 rillig 644: </div>
1.91 rillig 645: <br class="table-break">
1.82 rillig 646: </div>
1.75 rillig 647: </div>
648: <div class="sect1" lang="en">
649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
650: <a name="overview"></a>1.2. Overview</h2></div></div></div>
651: <p>This document is divided into three parts. The first,
652: <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
653: describes how one can use one of the packages in the Package
654: Collection, either by installing a precompiled binary package,
1.93 rillig 655: or by building one's own copy using the NetBSD package system.
1.75 rillig 656: 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
657: package so it can be easily built by other NetBSD users without
658: knowing about the package's building details. The third part,
659: <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
660: is intended for those who want to understand how pkgsrc is
661: implemented.</p>
662: <p>This document is available in various formats:
663: <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>
664: </div>
665: <div class="sect1" lang="en">
666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
667: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
668: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
669: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
670: terminology used within this document.</p>
671: <div class="variablelist"><dl>
672: <dt><span class="term">Package</span></dt>
673: <dd><p>A set of files and building instructions
674: that describe what's necessary
675: to build a certain piece of software using
676: pkgsrc. Packages are traditionally stored under
1.76 rillig 677: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 678: <dt><span class="term">The NetBSD package system</span></dt>
1.87 wiz 679: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
680: is part of the NetBSD operating system and can be bootstrapped
681: to run on non-NetBSD operating systems as well. It handles
682: building (compiling), installing, and removing of
683: packages.</p></dd>
1.75 rillig 684: <dt><span class="term">Distfile</span></dt>
685: <dd><p>This term describes the file or files that are
686: provided by the author of the piece of software to
687: distribute his work. All the changes necessary to build on
688: NetBSD are reflected in the corresponding package. Usually
689: the distfile is in the form of a compressed tar-archive,
690: but other types are possible, too. Distfiles are usually
691: stored below
1.76 rillig 692: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 693: <dt><span class="term">Port</span></dt>
694: <dd><p>This is the term used by FreeBSD and OpenBSD people
695: for what we call a package.
696: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
697: architecture.</p></dd>
698: <dt><span class="term">Precompiled/binary package</span></dt>
699: <dd>
700: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 701: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 702: file so it can be installed on machines of the same
703: machine architecture without the need to
704: recompile. Packages are usually generated in
1.76 rillig 705: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.75 rillig 706: an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
707: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
708: especially in the context of precompiled packages.</p>
709: </dd>
710: <dt><span class="term">Program</span></dt>
1.88 wiz 711: <dd><p>The piece of software to be installed which will be
712: constructed from all the files in the distfile by the
713: actions defined in the corresponding package.</p></dd>
1.75 rillig 714: </dl></div>
715: <div class="sect2" lang="en">
716: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 717: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75 rillig 718: <div class="variablelist"><dl>
719: <dt><span class="term">pkgsrc users</span></dt>
720: <dd>
721: <p>The
722: pkgsrc users are people who use the packages provided by pkgsrc.
723: Typically they are system administrators. The people using the
724: software that is inside the packages (maybe called “<span class="quote">end
725: users</span>”) are not covered by the pkgsrc guide.</p>
726: <p>There are two kinds of pkgsrc users: Some only want to
727: install pre-built binary packages. Others build the pkgsrc
728: packages from source, either for installing them directly or for
729: 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
730: documentation.</p>
731: </dd>
732: <dt><span class="term">package maintainers</span></dt>
733: <dd><p>A
734: 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>
735: <dt><span class="term">infrastructure developers</span></dt>
736: <dd><p>These people are involved in all those files
1.76 rillig 737: that live in the <code class="filename">mk/</code> directory and below.
1.75 rillig 738: 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,
739: too.</p></dd>
740: </dl></div>
741: </div>
742: </div>
743: <div class="sect1" lang="en">
744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
745: <a name="typography"></a>1.4. Typography</h2></div></div></div>
746: <p>When giving examples for commands, shell prompts are used to
747: show if the command should/can be issued as root, or if
748: “<span class="quote">normal</span>” user privileges are sufficient. We use a
749: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
750: shell prompt, assuming they use the C-shell or tcsh.</p>
751: </div>
752: </div>
753: <div class="part" lang="en">
754: <div class="titlepage"><div><div><h1 class="title">
755: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
756: <div class="toc">
757: <p><b>Table of Contents</b></p>
758: <dl>
759: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
760: <dd><dl>
761: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
762: <dd><dl>
763: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
764: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
765: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
766: </dl></dd>
767: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
768: <dd><dl>
769: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
770: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
771: </dl></dd>
772: </dl></dd>
773: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
774: <dd><dl>
1.82 rillig 775: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
776: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
777: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
778: <dd><dl>
779: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
780: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
781: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
782: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
783: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
784: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
785: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 786: </dl></dd>
787: </dl></dd>
788: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
789: <dd><dl>
790: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
791: <dd><dl>
792: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
793: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 794: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
795: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
796: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
797: <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>
798: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
799: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 800: </dl></dd>
801: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
802: <dd><dl>
803: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
804: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
805: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
806: </dl></dd>
807: </dl></dd>
808: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
809: <dd><dl>
810: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
811: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 812: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 813: <dd><dl>
1.89 rillig 814: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
815: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
816: <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 817: </dl></dd>
1.78 rillig 818: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
819: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 820: </dl></dd>
821: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
822: <dd><dl>
823: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
824: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
825: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
826: <dd><dl>
827: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
828: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
829: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
830: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
831: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
832: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
833: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
834: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
835: </dl></dd>
836: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
837: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
838: </dl></dd>
1.90 rillig 839: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
840: <dd><dl>
1.91 rillig 841: <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 842: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
843: </dl></dd>
844: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
1.75 rillig 845: <dd><dl>
1.90 rillig 846: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
847: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
848: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
849: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
850: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
851: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
852: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
853: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
854: <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>
855: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
856: <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 857: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 858: <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>
859: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
860: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
861: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
862: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
863: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
864: <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 865: </dl></dd>
866: </dl>
867: </div>
868: <div class="chapter" lang="en">
869: <div class="titlepage"><div><div><h2 class="title">
870: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
871: <div class="toc">
872: <p><b>Table of Contents</b></p>
873: <dl>
874: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
875: <dd><dl>
876: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
877: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
878: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
879: </dl></dd>
880: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
881: <dd><dl>
882: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
883: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
884: </dl></dd>
885: </dl>
886: </div>
1.91 rillig 887: <p>Before you download and extract the files, you need to decide
888: where you want to extract them. When using pkgsrc as root user, pkgsrc
889: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
890: free to install the sources and binary packages wherever you want in
891: your filesystem, provided that the pathname does not contain white-space
892: or other characters that are interpreted specially by the shell and some
893: other programs. A safe bet is to use only letters, digits, underscores
894: and dashes.</p>
1.75 rillig 895: <div class="sect1" lang="en">
896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
897: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
898: <p>Before you download any pkgsrc files, you should decide
899: whether you want the <span class="emphasis"><em>current</em></span> branch or the
900: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
901: quarterly basis from the current branch and only gets modified
902: for security updates. The names of the stable branches are built
903: from the year and the quarter, for example
1.96 ! rillig 904: <code class="literal">2006Q4</code>.</p>
1.75 rillig 905: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
906: want to download pkgsrc. You can get it as a tar file, via SUP,
907: or via CVS. All three ways are described here.</p>
908: <div class="sect2" lang="en">
909: <div class="titlepage"><div><div><h3 class="title">
910: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
911: <p>The primary download location for all pkgsrc files is
912: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
913: number of subdirectories for different purposes, which are
1.76 rillig 914: 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 915: <p>The tar file for the current branch is in the directory
1.76 rillig 916: <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 917: It is autogenerated daily.</p>
1.96 ! rillig 918: <p>The tar file for the stable branch 2006Q4 is in the
! 919: directory <code class="filename">pkgsrc-2006Q4</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2006Q4/pkgsrc-2006Q4.tar.gz" target="_top"><code class="filename">pkgsrc-2006Q4.tar.gz</code></a>.</p>
1.75 rillig 920: <p>After downloading the tar file, change to the directory
921: where you want to have pkgsrc. This is usually
1.91 rillig 922: <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
923: pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
1.75 rillig 924: </div>
925: <div class="sect2" lang="en">
926: <div class="titlepage"><div><div><h3 class="title">
927: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
928: <p>As an alternative to the tar file, you can get pkgsrc via
929: the Software Update Protocol, SUP. To do so, make sure your
930: supfile has a line
1.1 grant 931:
1.75 rillig 932: </p>
933: <pre class="programlisting">
1.51 rillig 934: release=pkgsrc
1.1 grant 935: </pre>
1.75 rillig 936: <p>
1.1 grant 937:
1.75 rillig 938: in it, see the examples in
1.76 rillig 939: <code class="filename">/usr/share/examples/supfiles</code>, and that the
940: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.75 rillig 941: run <span><strong class="command">sup -v
942: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
943: </div>
944: <div class="sect2" lang="en">
945: <div class="titlepage"><div><div><h3 class="title">
946: <a name="getting-via-cvs"></a>2.1.3. Via CVS</h3></div></div></div>
947: <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>
948: installed. To do an initial (full) checkout of pkgsrc, you first
949: have to set some environment variables. For the C-Shell,
950: type:</p>
951: <pre class="screen">
952: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
953: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
954: </pre>
955: <p>Or, the same for the bourne shell:</p>
956: <pre class="screen">
957: <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
958: <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
959: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
960: </pre>
961: <p>Then, you change to the directory where you want to have
962: your copy of pkgsrc. In most cases this is
1.76 rillig 963: <code class="filename">/usr</code>. In that directory you run the
1.75 rillig 964: checkout command, which is <span><strong class="command">cvs -q checkout -P
965: pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1.96 ! rillig 966: checkout -rpkgsrc-2006Q4 -P pkgsrc</strong></span> for the stable
1.75 rillig 967: branch. This command will create a directory called
1.76 rillig 968: <code class="filename">pkgsrc</code> with all the pkgsrc files in
1.75 rillig 969: it.</p>
970: </div>
971: </div>
972: <div class="sect1" lang="en">
973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
974: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
975: <p>The preferred way to keep pkgsrc up-to-date is via CVS
976: (which also works if you have first installed it via a tar
977: file). It saves bandwidth and hard disk activity, compared to
978: downloading the tar file again.</p>
979: <div class="sect2" lang="en">
980: <div class="titlepage"><div><div><h3 class="title">
981: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
982: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
983: <h3 class="title">Warning</h3>
1.77 rillig 984: <p>When updating from a tar file, you first need to
985: completely remove the old pkgsrc directory. Otherwise those
986: files that have been removed from pkgsrc in the mean time will
987: not be removed on your local disk, resulting in inconsistencies.
988: When removing the old files, any changes that you have done to
989: the pkgsrc files will be lost after updating. Therefore updating
990: via CVS is strongly recommended.</p>
1.75 rillig 991: </div>
1.82 rillig 992: <p>Note that by default the distfiles and the binary packages
993: are saved in the pkgsrc tree, so don't forget to rescue them
994: before updating. You can also configure pkgsrc to use other than
995: the default directories by setting the
996: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
997: variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 998: <p>To update pkgsrc from a tar file, download the tar file as
999: explained above. Then, make sure that you have not made any
1000: changes to the files in the pkgsrc directory. Remove the pkgsrc
1001: directory and extract the new tar file. Done.</p>
1002: </div>
1003: <div class="sect2" lang="en">
1004: <div class="titlepage"><div><div><h3 class="title">
1005: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1006: <p>To update pkgsrc via CVS, make sure the environment
1007: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1008: change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1.77 rillig 1009: -dP</strong></span>.</p>
1.75 rillig 1010: <div class="sect3" lang="en">
1011: <div class="titlepage"><div><div><h4 class="title">
1012: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1013: <p>When updating pkgsrc, the CVS program keeps track of the
1014: branch you selected. But if you, for whatever reason, want to
1015: switch from the stable branch to the current one, you can do it
1016: by adding the option “<span class="quote">-A</span>” after the
1017: “<span class="quote">update</span>” keyword. To switch from the current branch
1018: back to the stable branch, add the
1.96 ! rillig 1019: “<span class="quote">-rpkgsrc-2006Q4</span>” option.</p>
1.75 rillig 1020: </div>
1021: <div class="sect3" lang="en">
1022: <div class="titlepage"><div><div><h4 class="title">
1023: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1024: <p>When you update pkgsrc, the CVS program will only touch
1025: those files that are registered in the CVS repository. That
1026: means that any packages that you created on your own will stay
1027: unmodified. If you change files that are managed by CVS, later
1028: updates will try to merge your changes with those that have been
1029: done by others. See the CVS manual, chapter
1030: “<span class="quote">update</span>” for details.</p>
1031: </div>
1032: </div>
1033: </div>
1034: </div>
1035: <div class="chapter" lang="en">
1036: <div class="titlepage"><div><div><h2 class="title">
1037: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1038: <div class="toc">
1039: <p><b>Table of Contents</b></p>
1040: <dl>
1.82 rillig 1041: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1042: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1043: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1044: <dd><dl>
1045: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1046: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1047: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1048: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1049: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1050: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1051: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1052: </dl></dd>
1053: </dl>
1054: </div>
1055: <div class="sect1" lang="en">
1056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1057: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1058: <p>
1059: We provide a bootstrap kit in both source and binary form for other
1060: platforms than NetBSD, consisting of the pkg administration tools and other
1061: tools required to use pkgsrc and build packages.
1062: </p>
1063: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1064: <h3 class="title">Note</h3>
1065: <p>
1066: Older binary snapshots are available in the
1067: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
1068: directory on ftp.NetBSD.org.</p>
1069: </div>
1070: <div class="table">
1071: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1.91 rillig 1072: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1.82 rillig 1073: <colgroup>
1074: <col>
1075: <col>
1076: <col>
1077: <col>
1078: </colgroup>
1079: <thead><tr>
1080: <th>Platform</th>
1081: <th>Latest snapshot</th>
1082: <th>Binary kit</th>
1083: <th>Binary packages</th>
1084: </tr></thead>
1085: <tbody>
1086: <tr>
1087: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
1088: <td class="date">20021209</td>
1089: <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>
1090: <td class="binary-pkgs-url"> </td>
1091: </tr>
1092: <tr>
1093: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
1094: <td class="date">20030623</td>
1095: <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>
1096: <td class="binary-pkgs-url"> </td>
1097: </tr>
1098: <tr>
1099: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
1100: <td class="date">20041219</td>
1101: <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>
1102: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
1103: </tr>
1104: <tr>
1105: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
1106: <td class="date">20050320</td>
1107: <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>
1108: <td class="binary-pkgs-url"> </td>
1109: </tr>
1110: <tr>
1111: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
1112: <td class="date">20050625</td>
1113: <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>
1114: <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>
1115: </tr>
1116: <tr>
1117: <td class="osname">Debian GNU Linux/i386</td>
1118: <td class="date">20031023</td>
1119: <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>
1120: <td class="binary-pkgs-url"> </td>
1121: </tr>
1122: <tr>
1123: <td class="osname">Fedora Core 2 Linux/i386</td>
1124: <td class="date">20050618</td>
1125: <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>
1126: <td class="binary-pkgs-url"> </td>
1127: </tr>
1128: <tr>
1129: <td class="osname">Fedora Core 4 Linux/i386</td>
1130: <td class="date">20060105</td>
1131: <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>
1132: <td class="binary-pkgs-url"> </td>
1133: </tr>
1134: <tr>
1135: <td class="osname">FreeBSD 3.5/i386</td>
1136: <td class="date">20030411</td>
1137: <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>
1138: <td class="binary-pkgs-url"> </td>
1139: </tr>
1140: <tr>
1141: <td class="osname">FreeBSD 4.7/i386</td>
1142: <td class="date">20021211</td>
1143: <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>
1144: <td class="binary-pkgs-url"> </td>
1145: </tr>
1146: <tr>
1147: <td class="osname">FreeBSD 5.0/i386</td>
1148: <td class="date">20030411</td>
1149: <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>
1150: <td class="binary-pkgs-url"> </td>
1151: </tr>
1152: <tr>
1153: <td class="osname">FreeBSD 5.1/i386</td>
1154: <td class="date">20030630</td>
1155: <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>
1156: <td class="binary-pkgs-url"> </td>
1157: </tr>
1158: <tr>
1159: <td class="osname">FreeBSD 5.2.1/i386</td>
1160: <td class="date">20040227</td>
1161: <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>
1162: <td class="binary-pkgs-url"> </td>
1163: </tr>
1164: <tr>
1165: <td class="osname">FreeBSD 5.3/i386</td>
1166: <td class="date">20050119</td>
1167: <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>
1168: <td class="binary-pkgs-url"> </td>
1169: </tr>
1170: <tr>
1171: <td class="osname">Interix 3.5</td>
1.93 rillig 1172: <td class="date">20061106</td>
1173: <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>
1174: <td class="binary-pkgs-url"> </td>
1.82 rillig 1175: </tr>
1176: <tr>
1177: <td class="osname">IRIX 6.5 n32-bit ABI</td>
1178: <td class="date">20040911</td>
1179: <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>
1180: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
1181: </tr>
1182: <tr>
1183: <td class="osname">IRIX 6.5 64-bit ABI</td>
1184: <td class="date">20040912</td>
1185: <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>
1186: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
1187: </tr>
1188: <tr>
1189: <td class="osname">OpenBSD 3.2/i386</td>
1190: <td class="date">20030420</td>
1191: <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>
1192: <td class="binary-pkgs-url"> </td>
1193: </tr>
1194: <tr>
1195: <td class="osname">OpenBSD 3.3/i386</td>
1196: <td class="date">20030503</td>
1197: <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>
1198: <td class="binary-pkgs-url"> </td>
1199: </tr>
1200: <tr>
1201: <td class="osname">OpenBSD 3.5/i386</td>
1.93 rillig 1202: <td class="date">20040703</td>
1.82 rillig 1203: <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>
1204: <td class="binary-pkgs-url"> </td>
1205: </tr>
1206: <tr>
1207: <td class="osname">Slackware Linux 8.1/i386</td>
1208: <td class="date">20030417</td>
1209: <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>
1210: <td class="binary-pkgs-url"> </td>
1211: </tr>
1212: <tr>
1213: <td class="osname">Slackware Linux 9/i386</td>
1.93 rillig 1214: <td class="date">20040703</td>
1.82 rillig 1215: <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>
1216: <td class="binary-pkgs-url"> </td>
1217: </tr>
1218: <tr>
1219: <td class="osname">Solaris 8/sparc</td>
1220: <td class="date">20050220</td>
1221: <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>
1222: <td class="binary-pkgs-url"> </td>
1223: </tr>
1224: <tr>
1225: <td class="osname">Solaris 8/i386</td>
1226: <td class="date">20050220</td>
1227: <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>
1228: <td class="binary-pkgs-url"> </td>
1229: </tr>
1230: <tr>
1231: <td class="osname">Solaris 9/sparc</td>
1.93 rillig 1232: <td class="date">20060713</td>
1233: <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>
1234: <td class="binary-pkgs-url"> </td>
1.82 rillig 1235: </tr>
1236: <tr>
1237: <td class="osname">Solaris 9/i386</td>
1238: <td class="date">20030411</td>
1239: <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>
1240: <td class="binary-pkgs-url"> </td>
1241: </tr>
1242: </tbody>
1.91 rillig 1243: </table></div>
1.82 rillig 1244: </div>
1.91 rillig 1245: <br class="table-break"><p>
1.82 rillig 1246: Simply download the binary kit for your platform, and extract it into
1247: <code class="filename">/</code> e.g.
1248: </p>
1249: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
1250: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
1251: | tar -xpf -</code></strong></pre>
1252: <p>
1253: Of course, as with any binary distributions, you should verify the
1254: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
1255: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
1256: file and inspect the contents before extracting it.
1257: </p>
1258: </div>
1259: <div class="sect1" lang="en">
1260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1261: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1262: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1263: <pre class="screen">
1264: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1265: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1266: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1267: </pre>
1.75 rillig 1268: <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 1269: pkgsrc before bootstrapping. The given
1270: <span><strong class="command">bootstrap</strong></span> command will use the defaults of
1271: <code class="filename">/usr/pkg</code> for the
1272: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1273: and <code class="filename">/var/db/pkg</code> for the package database
1274: directory where pkgsrc will do its internal bookkeeping.
1275: However, these can also be set using command-line
1276: arguments.</p>
1.75 rillig 1277: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1.87 wiz 1278: available for supported platforms. An up-to-date list of these can be
1279: found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
1280: Note that this only works for privileged builds that install
1281: into <code class="filename">/usr/pkg</code>.</p>
1.75 rillig 1282: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1283: <h3 class="title">Note</h3>
1284: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1.87 wiz 1285: Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
1286: For examples in this guide, use <span><strong class="command">bmake</strong></span>
1287: instead of “<span class="quote">make</span>”.</p>
1.75 rillig 1288: </div>
1289: </div>
1290: <div class="sect1" lang="en">
1291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1292: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1293: <p>Here are some platform-specific notes you should be aware of.</p>
1294: <div class="sect2" lang="en">
1295: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1296: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85 jmmv 1297: <p>Darwin 5.x and up are supported. There are two methods of using
1.82 rillig 1298: 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 1299: 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 1300: partition</a>.</p>
1301: <p>Before you start, you will need to download and install the Mac OS X Developer
1.87 wiz 1302: Tools from Apple's Developer Connection. See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1303: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1304: from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1305: if you intend to build packages that use the X11 Window System.</p>
1.89 rillig 1306: <p>If you already have a UFS or HFSX partition, or have a spare partition
1307: that you can format as UFS or HFSX, it is recommended to use that instead of
1.87 wiz 1308: the disk image. It'll be somewhat faster and will mount automatically
1309: at boot time, where you must manually mount a disk image.</p>
1.75 rillig 1310: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1311: <h3 class="title">Note</h3>
1.85 jmmv 1312: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89 rillig 1313: 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 1314: </div>
1315: <div class="sect3" lang="en">
1316: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1317: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75 rillig 1318: <p>Create the disk image:</p>
1319: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95 tron 1320: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85 jmmv 1321: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75 rillig 1322: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85 jmmv 1323: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1324: <h3 class="title">Note</h3>
1.89 rillig 1325: <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 1326: </div>
1.89 rillig 1327: <p>Allow suid:</p>
1328: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.75 rillig 1329: </div>
1330: <div class="sect3" lang="en">
1331: <div class="titlepage"><div><div><h4 class="title">
1.89 rillig 1332: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76 rillig 1333: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87 wiz 1334: system, normally HFS+. It is possible to use the default
1335: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1336: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89 rillig 1337: or HFSX file system. Obviously, another symlink is required if you want to
1.87 wiz 1338: place the package database directory outside the
1339: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75 rillig 1340: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1341: <p>If you created your partitions at the time of installing Mac OS X
1.89 rillig 1342: and formatted the target partition as UFS or HFSX, it should automatically
1.87 wiz 1343: mount on <code class="filename">/Volumes/<volume name></code> when the
1.89 rillig 1344: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87 wiz 1345: to ensure that the partition map correctly reflects
1.89 rillig 1346: “<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 1347: <p>The problem is that none of the disk tools will let you touch a
1.87 wiz 1348: disk that is booted from. You can unmount the partition, but even if
1349: you newfs it, the partition type will be incorrect and the
1350: automounter won't mount it. It can be mounted manually, but it won't
1351: appear in Finder.</p>
1.75 rillig 1352: <p>You'll need to boot off of the OS X Installation (User) CD. When
1.87 wiz 1353: the Installation program starts, go up to the menu and select Disk
1354: Utility. Now, you will be able to select the partition you want
1.89 rillig 1355: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1356: installer which will reboot your machine. The new UFS or HFSX file system
1.87 wiz 1357: will appear in Finder.</p>
1.75 rillig 1358: <p>Be aware that the permissions on the new file system will be writable
1.87 wiz 1359: by root only.</p>
1.75 rillig 1360: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87 wiz 1361: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75 rillig 1362: </div>
1363: </div>
1364: <div class="sect2" lang="en">
1365: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1366: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1367: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1368: other versions may work.</p>
1.75 rillig 1369: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1370: with the FreeBSD userland tools. There are several steps:</p>
1.75 rillig 1371: <div class="orderedlist"><ol type="1">
1372: <li><p>FreeBSD stores its ports pkg database in
1.87 wiz 1373: <code class="filename">/var/db/pkg</code>. It is therefore
1374: recommended that you choose a different location (e.g.
1375: <code class="filename">/usr/pkgdb</code>) by
1376: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1377: <li>
1378: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1379: good idea to move them out of the way to avoid confusion, e.g.</p>
1380: <pre class="screen">
1381: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1382: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1383: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1384: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1385: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1386: </pre>
1.75 rillig 1387: </li>
1.76 rillig 1388: <li><p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87 wiz 1389: <code class="filename">/etc/mk.conf.example</code> file
1390: when you use the bootstrap script.</p></li>
1.75 rillig 1391: </ol></div>
1392: </div>
1393: <div class="sect2" lang="en">
1394: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1395: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1396: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1397: providing a Unix-like environment with a tighter kernel integration than
1398: available with Cygwin. It is part of the Windows Services for Unix
1399: package, available for free for any licensed copy of Windows 2000, XP
1400: (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 1401: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1402: are not officially supported. (The main difference in 3.0/3.1 is lack
1403: of pthreads, but other parts of libc may also be lacking.)</p>
1404: <p>Services for Unix Applications (aka SUA) is an integrated component
1405: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1.95 tron 1406: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75 rillig 1407: <div class="sect3" lang="en">
1408: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1409: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1410: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1411: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75 rillig 1412: <div class="itemizedlist"><ul type="disc">
1413: <li><p>Utilities -> Base Utilities</p></li>
1414: <li><p>Interix GNU Components -> (all)</p></li>
1415: <li><p>Remote Connectivity</p></li>
1416: <li><p>Interix SDK</p></li>
1417: </ul></div>
1418: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1419: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1420: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1421: pkgsrc (or from a binary package).</p>
1.75 rillig 1422: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1423: not need to be installed, but Remote Connectivity itself should be
1424: installed in order to have a working inetd.</p>
1.75 rillig 1425: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1426: behavior for Interix programs, and whether to make pathnames default to
1427: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1428: enabled. (Without case-sensitivity, a large number of packages including
1429: perl will not build.)</p>
1.75 rillig 1430: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1431: works (via the Data Execution Prevention feature). In order to use
1432: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1433: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1434: must be installed. Hotfixes are available from Microsoft through a
1435: support contract; however, a NetBSD developer has made most Interix
1436: 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 1437: <p>In addition to the hotfix noted above, it may be necessary to
1438: disable Data Execution Prevention entirely to make Interix functional.
1439: This may happen only with certain types of CPUs; the cause is not fully
1440: understood at this time. If gcc or other applications still segfault
1441: repeatedly after installing one of the hotfixes note above, the
1442: following option can be added to the appropriate "boot.ini" line on the
1443: Windows boot drive: /NoExecute=AlwaysOff
1444: (WARNING, this will disable DEP completely, which may be a security
1445: risk if applications are often run as a user in the Administrators
1446: group!)</p>
1.75 rillig 1447: </div>
1448: <div class="sect3" lang="en">
1449: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1450: <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 1451: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1452: with pkgsrc, note the following things.</p>
1.75 rillig 1453: <div class="itemizedlist"><ul type="disc">
1454: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1455: Windows Services for UNIX, then click Change. In the installer, choose
1456: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.75 rillig 1457: <li>
1458: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1459: change the following registry key:</p>
1.75 rillig 1460: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1461: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1462: </li>
1463: <li>
1464: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1465: following registry key:</p>
1.75 rillig 1466: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1467: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1468: </li>
1469: </ul></div>
1470: </div>
1471: <div class="sect3" lang="en">
1472: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1473: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1474: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1475: running "pkg_add") must be a member of the local Administrators
1476: group. Such a user must also be used to run the bootstrap. This is
1477: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1478: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1479: automatically complain if this is not the case. This ensures that
1480: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1481: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1482: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1483: NOT be used in conjunction with pkgsrc. If you choose to use them at
1484: the same time as the pkgsrc packages, ensure that you use the proper
1485: pkg_* tools for each type of binary package.</p>
1.75 rillig 1486: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1487: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1488: don't have a termcap/terminfo entry for it, but the following .termcap
1489: entry provides adequate emulation in most cases:</p>
1.75 rillig 1490: <pre class="programlisting">
1.87 wiz 1491: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1492: </pre>
1.75 rillig 1493: </div>
1494: <div class="sect3" lang="en">
1495: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1496: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1497: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1498: for a full Unix-like platform, it has some drawbacks that should
1499: be noted for those desiring to make the most of Interix.</p>
1.75 rillig 1500: <div class="itemizedlist"><ul type="disc">
1501: <li>
1502: <p><span class="strong"><strong>X11:</strong></span></p>
1503: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1504: and can run X11 based applications, but it does
1505: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1506: <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1507: <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1508: (available in a trimmed version for Interix from Interop Systems as the
1509: <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1510: and the free X11 server included with
1511: <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1512: </li>
1513: <li>
1514: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1515: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1516: Win32 applications, it does not currently support various X11
1517: protocol extensions for acceleration (such as MIT-SHM or DGA).
1518: Most interactive applications to a local X server will run
1519: reasonably fast, but full motion video and other graphics
1520: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1521: </li>
1522: <li>
1523: <p><span class="strong"><strong>Audio:</strong></span></p>
1524: <p>Interix has no native support for audio output. For audio
1.87 wiz 1525: support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
1526: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1527: <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 1528: <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
1529: server component. To output audio via an Interix host, the
1.91 rillig 1530: <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 1531: must also be installed.</p>
1.75 rillig 1532: </li>
1533: <li>
1534: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1535: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1536: is not currently possible to access CD/DVD drives, USB devices,
1537: or SCSI devices through non-filesystem means. Among other things,
1538: this makes it impossible to use Interix directly for CD/DVD
1539: burning.</p>
1.75 rillig 1540: </li>
1541: <li>
1542: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1543: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1544: drives are also not directly accessible in Interix. However,
1545: support is in work to make tape drive access possible by using
1546: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1547: esound server).</p>
1.75 rillig 1548: </li>
1549: </ul></div>
1550: </div>
1551: <div class="sect3" lang="en">
1552: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1553: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1554: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1555: Windows system; any member of the local Administrators group will
1556: suffice. However, some packages currently assume that the user
1557: named "root" is the privileged user. To accommodate these, you
1558: may create such a user; make sure it is in the local group
1559: Administrators (or your language equivalent).</p>
1560: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
1561: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1562: time being, install packages as the local Administrator (or
1563: your language equivalent), or run the following command after
1564: installing a package to work around the issue:</p>
1.75 rillig 1565: <pre class="screen">
1.87 wiz 1566: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1567: </pre>
1.75 rillig 1568: </div>
1569: </div>
1570: <div class="sect2" lang="en">
1571: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1572: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1573: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1574: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1575: according to your preference. If you do not have a license for the MIPSpro
1576: 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 1577: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87 wiz 1578: 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>,
1579: etc.</p>
1.86 schwarz 1580: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1581: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1582: you start out using "abi=n32", that's what all your packages will be built
1583: with.</p>
1584: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1585: <code class="varname">CFLAGS</code> in your environment or the
1586: <code class="filename">/etc/mk.conf</code>. Particularly, make sure that you do not
1587: try to link n32 object files with lib64 or vice versa. Check your
1588: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1589: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1590: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1591: as it appears that IRIX linker occasionally runs into issues when trying to
1592: link over a network-mounted file system.</p>
1.75 rillig 1593: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1594: as imake(1), but you may want to set some options depending on your local
1595: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1596: course, your compiler's man pages for details.</p>
1.75 rillig 1597: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1598:
1.87 wiz 1599: </p>
1.75 rillig 1600: <pre class="programlisting">
1.87 wiz 1601: PKGSRC_COMPILER= mipspro
1602: </pre>
1.75 rillig 1603: <p>
1.1 grant 1604:
1.87 wiz 1605: in <code class="filename">/etc/mk.conf</code>. Otherwise, pkgsrc will assume you
1606: are using gcc and may end up passing invalid flags to the compiler. Note that
1607: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1608: default.</p>
1.75 rillig 1609: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1610: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1611: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1612: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1613: '--preserve-path' flag.</p>
1.75 rillig 1614: </div>
1615: <div class="sect2" lang="en">
1616: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1617: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1618: <p>Some versions of Linux (for example Debian GNU/Linux) need
1619: either libtermcap or libcurses (libncurses). Installing the
1620: distributions libncurses-dev package (or equivalent) should fix
1621: the problem.</p>
1622: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1623: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1624: i386 have been tested.</p>
1.75 rillig 1625: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1626: directory:</p>
1.75 rillig 1627: <pre class="programlisting">
1.87 wiz 1628: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1629: ac_cv___attribute__=yes ./bootstrap
1630: </pre>
1.75 rillig 1631: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1632: <h3 class="title">Note</h3>
1633: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1634: </div>
1635: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1636: function, which icc does not support. #undef'ing __attribute__ has the
1637: unfortunate side-effect of breaking many of the Linux header files, which
1638: cannot be compiled properly without __attribute__. The test must be
1639: overridden so that __attribute__ is assumed supported by the
1640: compiler.</p>
1.75 rillig 1641: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.87 wiz 1642: in <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 1643: <pre class="programlisting">
1.87 wiz 1644: PKGSRC_COMPILER= icc
1645: </pre>
1.75 rillig 1646: <p>The default installation directory for icc is
1.87 wiz 1647: <code class="filename">/opt/intel_cc_80</code>, which
1648: is also the pkgsrc default. If you have installed it into a different
1649: directory, set <code class="varname">ICCBASE</code> in
1650: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 1651: <pre class="programlisting">
1.87 wiz 1652: ICCBASE= /opt/icc
1653: </pre>
1.75 rillig 1654: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1655: provided by icc, so binaries can be run on other systems which do not
1656: have the shared libraries installed.</p>
1657: <p>Libtool, however, extracts a list of libraries from the
1658: <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
1659: records it, throwing away the -Bstatic and -Bdynamic options
1660: interspersed between the libraries. This means that
1661: libtool-linked C++ shared libraries will have a runtime
1662: dependency on the icc libraries until this is fixed in
1663: libtool.</p>
1.75 rillig 1664: </div>
1665: <div class="sect2" lang="en">
1666: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1667: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1668: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1669: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1670: with the OpenBSD userland tools. There are several steps:</p>
1.75 rillig 1671: <div class="orderedlist"><ol type="1">
1672: <li><p>OpenBSD stores its ports pkg database in
1.87 wiz 1673: <code class="filename">/var/db/pkg</code>. It is therefore
1674: recommended that you choose a different location (e.g.
1675: <code class="filename">/usr/pkgdb</code>) by
1676: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1677: <li>
1678: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1679: good idea to move them out of the way to avoid confusion, e.g.</p>
1680: <pre class="screen">
1681: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1682: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1683: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1684: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1685: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1686: </pre>
1.75 rillig 1687: </li>
1688: <li>
1.76 rillig 1689: <p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87 wiz 1690: <code class="filename">/etc/mk.conf.example</code> file
1691: when you use the bootstrap script. OpenBSD's make program uses
1692: <code class="filename">/etc/mk.conf</code>
1693: as well. You can work around this by enclosing all the pkgsrc-specific parts
1694: of the file with:</p>
1695: <pre class="programlisting">
1696: .ifdef BSD_PKG_MK
1697: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1698: .else
1699: # OpenBSD stuff
1700: .endif
1701: </pre>
1.75 rillig 1702: </li>
1703: </ol></div>
1704: </div>
1705: <div class="sect2" lang="en">
1706: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1707: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1708: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1709: You will need a working C compiler. Both gcc 2.95.3 and
1710: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1711: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1712: process and to build packages.</p>
1.75 rillig 1713: <div class="itemizedlist"><ul type="disc">
1714: <li><p>SUNWsprot</p></li>
1715: <li><p>SUNWarc</p></li>
1716: <li><p>SUNWbtool</p></li>
1717: <li><p>SUNWtoo</p></li>
1718: <li><p>SUNWlibm</p></li>
1719: </ul></div>
1.78 rillig 1720: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1721: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1722: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1723: your $prefix are in your <code class="varname">PATH</code>. This includes
1724: <code class="filename">/usr/ccs/{bin,lib}</code>
1725: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75 rillig 1726: <div class="sect3" lang="en">
1727: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1728: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1729: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1730: for building all packages.</p>
1.75 rillig 1731: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1732: then either build gcc from
1.91 rillig 1733: <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 1734: package, then remove gcc used during bootstrapping.</p>
1.93 rillig 1735: <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 1736: </div>
1737: <div class="sect3" lang="en">
1738: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1739: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1740: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1741: 5.0)</p>
1.75 rillig 1742: <div class="itemizedlist"><ul type="disc">
1743: <li><p>SPROcc
1.87 wiz 1744: - Sun WorkShop Compiler C 5.0</p></li>
1.75 rillig 1745: <li><p>SPROcpl
1.87 wiz 1746: - Sun WorkShop Compiler C++ 5.0</p></li>
1.75 rillig 1747: <li><p>SPROild
1.87 wiz 1748: - Sun WorkShop Incremental Linker</p></li>
1.75 rillig 1749: <li><p>SPROlang
1.87 wiz 1750: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1751: </ul></div>
1.96 ! rillig 1752: <p>You should set the following variables in your
! 1753: <code class="filename">mk.conf</code> file:</p>
! 1754: <pre class="programlisting">
! 1755: CC= cc
! 1756: CXX= CC
! 1757: CPP= cc -E
! 1758: CXXCPP= CC -E
! 1759: </pre>
! 1760: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
! 1761: <h3 class="title">Note</h3>
! 1762: <p>The <code class="varname">CPP</code> setting might break some
! 1763: packages that use the C preprocessor for processing things other
! 1764: than C source code.</p>
! 1765: </div>
1.75 rillig 1766: </div>
1767: <div class="sect3" lang="en">
1768: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1769: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 ! rillig 1770: <p>To build 64-bit packages, you just need to have the
! 1771: following lines in your <code class="filename">mk.conf</code>
1.75 rillig 1772: file:</p>
1773: <pre class="programlisting">
1.96 ! rillig 1774: PKGSRC_COMPILER= sunpro
! 1775: ABI= 64
! 1776: </pre>
! 1777: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
! 1778: <h3 class="title">Note</h3>
! 1779: <p>This setting has been tested for the SPARC
! 1780: architecture. Intel and AMD machines need some more
! 1781: work.</p>
! 1782: </div>
1.75 rillig 1783: </div>
1784: <div class="sect3" lang="en">
1785: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1786: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75 rillig 1787: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87 wiz 1788: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1789: The workaround is to use another shell for the configure
1.91 rillig 1790: 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 1791: to your <code class="filename">mk.conf</code>:</p>
1792: <pre class="programlisting">
1793: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1794: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1795: </pre>
1.91 rillig 1796: <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 1797: </div>
1798: </div>
1799: </div>
1800: </div>
1801: <div class="chapter" lang="en">
1802: <div class="titlepage"><div><div><h2 class="title">
1803: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1804: <div class="toc">
1805: <p><b>Table of Contents</b></p>
1806: <dl>
1807: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1808: <dd><dl>
1809: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1810: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1811: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1812: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1813: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1814: <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>
1815: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1816: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1817: </dl></dd>
1818: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1819: <dd><dl>
1820: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1821: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1822: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1823: </dl></dd>
1824: </dl>
1825: </div>
1826: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1827: is to only install the package tools and to use binary packages
1828: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1829: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1830: of pkgsrc, too. Then you are able to build your own packages,
1831: and you can still use binary packages from someone else.</p>
1.75 rillig 1832: <div class="sect1" lang="en">
1833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1834: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1835: <p>To use binary packages, you need some tools to manage
1.88 wiz 1836: them. On NetBSD, these tools are already installed. On all other
1837: operating systems, you need to install them first. For the
1838: following platforms, prebuilt versions of the package tools
1839: are available and can simply be downloaded and unpacked in the
1840: <code class="filename">/</code> directory:</p>
1.75 rillig 1841: <div class="informaltable">
1842: <a name="binary-bootstrap-kits"></a><table border="1">
1843: <colgroup>
1844: <col>
1845: <col>
1846: </colgroup>
1847: <thead><tr>
1848: <th>Platform</th>
1849: <th>URL</th>
1850: </tr></thead>
1851: <tbody>
1852: <tr>
1853: <td>Solaris 9</td>
1.76 rillig 1854: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1855: </tr>
1856: <tr>
1857: <td>Solaris 10</td>
1.76 rillig 1858: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1859: </tr>
1860: </tbody>
1861: </table>
1862: </div>
1.82 rillig 1863: <p>These pre-built package tools use
1.88 wiz 1864: <code class="filename">/usr/pkg</code> for the base directory, and
1865: <code class="filename">/var/db/pkg</code> for the database of installed
1866: packages. If you cannot use these directories for whatever
1867: reasons (maybe because you're not root), you have to build the
1868: 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 1869: <div class="sect2" lang="en">
1870: <div class="titlepage"><div><div><h3 class="title">
1871: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1872: <p>To install binary packages, you first need to know from
1.88 wiz 1873: where to get them. You can get them on CD-ROMs, DVDs, or via FTP
1874: or HTTP.</p>
1.81 rillig 1875: <p>The binary packages can be found at the following
1.88 wiz 1876: locations.</p>
1.75 rillig 1877: <div class="informaltable">
1878: <a name="binary-packages"></a><table border="1">
1879: <colgroup>
1880: <col>
1881: <col>
1882: </colgroup>
1883: <thead><tr>
1884: <th>Platform</th>
1885: <th>URL</th>
1886: </tr></thead>
1887: <tbody>
1888: <tr>
1.81 rillig 1889: <td>NetBSD</td>
1890: <td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
1891: </tr>
1892: <tr>
1.75 rillig 1893: <td>Solaris 9</td>
1.76 rillig 1894: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
1.75 rillig 1895: </tr>
1896: <tr>
1897: <td>Solaris 10</td>
1.76 rillig 1898: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/</code></td>
1.75 rillig 1899: </tr>
1900: </tbody>
1901: </table>
1902: </div>
1.81 rillig 1903: <p>Most of these directories contain binary packages for
1.88 wiz 1904: multiple platforms. Select the appropriate subdirectories,
1905: according to your machine architecture and operating system,
1906: until you find a directory called <code class="filename">All</code>. This
1907: directory contains all the binary packages. Further, there are
1908: subdirectories for categories that contain symbolic links that
1909: point to the actual binary package in
1910: <code class="filename">../All</code>. This directory layout is used for
1911: all package repositories, no matter if they are accessed via
1912: HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
1.75 rillig 1913: </div>
1914: <div class="sect2" lang="en">
1915: <div class="titlepage"><div><div><h3 class="title">
1916: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87 wiz 1917: <p>If you have the files on a CD-ROM or downloaded them to
1.88 wiz 1918: your hard disk, you can install them with the following command
1919: (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75 rillig 1920: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87 wiz 1921: <p>If you have FTP access and you don't want to download the
1.88 wiz 1922: packages via FTP prior to installation, you can do this
1923: automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.82 rillig 1924: <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 1925: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1926: package in question will be installed, too, assuming they are
1927: present where you install from.</p>
1.75 rillig 1928: <p>To save some typing, you can set the
1.88 wiz 1929: <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
1930: list of paths (including remote URLs); trailing slashes are not allowed.
1931: </p>
1.76 rillig 1932: <p>Additionally to the <code class="filename">All</code> directory
1.88 wiz 1933: there exists a <code class="filename">vulnerable</code> directory to
1934: which binary packages with known vulnerabilities are
1935: moved, since removing them could cause missing dependencies. To
1936: use these packages, add the <code class="filename">vulnerable</code>
1937: directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91 rillig 1938: <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 1939: especially after installing new packages, and verify that the
1940: vulnerabilities are acceptable for your configuration. An example
1941: <code class="varname">PKG_PATH</code> would be:
1942: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
1943: Please note that semicolon (';') is a shell meta-character, so
1944: you'll probably have to quote it.</p>
1.75 rillig 1945: <p>After you've installed packages, be sure to have
1.88 wiz 1946: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1947: <code class="varname">PATH</code> so you can actually start the just
1948: installed program.</p>
1.75 rillig 1949: </div>
1950: <div class="sect2" lang="en">
1951: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1952: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1953: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1954: installed from source code or from a binary package. The
1955: <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
1956: To delete a package, you can just run <span><strong class="command">pkg_delete
1957: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1958: name can be given with or without version number. Wildcards can
1959: also be used to deinstall a set of packages, for example
1960: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1961: so that the shell does not expand them before
1962: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1963: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1964: removes all the packages that require the package in question
1965: and then removes the package itself. For example:
1.82 rillig 1966:
1.88 wiz 1967: </p>
1.82 rillig 1968: <pre class="screen">
1.88 wiz 1969: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1970: </pre>
1.82 rillig 1971: <p>
1972:
1.88 wiz 1973: will remove jpeg and all the packages that used it; this allows
1974: upgrading the jpeg package.</p>
1.82 rillig 1975: </div>
1976: <div class="sect2" lang="en">
1977: <div class="titlepage"><div><div><h3 class="title">
1978: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1979: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88 wiz 1980: installed packages or binary package files.</p>
1.82 rillig 1981: </div>
1982: <div class="sect2" lang="en">
1983: <div class="titlepage"><div><div><h3 class="title">
1984: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1985: <p>
1.88 wiz 1986: The NetBSD Security-Officer and Packages Groups maintain a list of
1987: known security vulnerabilities to packages which are (or have been)
1988: included in pkgsrc. The list is available from the NetBSD
1989: FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1990: </p>
1.82 rillig 1991: <p>
1.93 rillig 1992: 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 1993: this list can be downloaded
1994: automatically, and a security audit of all packages installed on a system
1995: can take place.
1996: </p>
1.82 rillig 1997: <p>
1.93 rillig 1998: There are two components to
1.91 rillig 1999: <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 2000: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
2001: the list of vulnerabilities from the NetBSD FTP site. The second
2002: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
2003: installed packages are vulnerable. If a package is vulnerable, you
2004: will see output similar to the following:
2005: </p>
1.82 rillig 2006: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 2007: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 2008: <p>
1.91 rillig 2009: 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 2010: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
2011: file daily, and include a package audit in the daily security script.
2012: 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 2013: 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 2014: </p>
1.82 rillig 2015: </div>
2016: <div class="sect2" lang="en">
2017: <div class="titlepage"><div><div><h3 class="title">
2018: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
2019: <p>
1.93 rillig 2020: 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 2021: <span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
2022: argument to check if your packages are up-to-date, e.g.
2023: </p>
2024: <pre class="screen">
2025: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 2026: ...
1.88 wiz 2027: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
2028: </pre>
1.82 rillig 2029: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88 wiz 2030: package on your system and rebuild any dependencies.
2031: </p>
1.82 rillig 2032: </div>
2033: <div class="sect2" lang="en">
2034: <div class="titlepage"><div><div><h3 class="title">
2035: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
2036: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88 wiz 2037: administrative functions on the package system.</p>
1.82 rillig 2038: </div>
2039: <div class="sect2" lang="en">
2040: <div class="titlepage"><div><div><h3 class="title">
2041: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 2042: <p>Please pay very careful attention to the warnings
1.88 wiz 2043: 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
2044: inherent dangers of installing binary packages which you did
2045: not create yourself, and the security holes that can be
2046: introduced onto your system by indiscriminate adding of such
2047: files.</p>
1.75 rillig 2048: <p>The same warning of course applies to every package you
1.88 wiz 2049: install from source when you haven't completely read and
2050: understood the source code of the package, the compiler that
2051: is used to build the package and all the other tools that are
2052: involved.</p>
1.75 rillig 2053: </div>
2054: </div>
2055: <div class="sect1" lang="en">
2056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2057: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 2058: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
2059: directory now contains a set of packages, organized into
2060: categories. You can browse the online index of packages, or run
2061: <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
2062: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 2063: 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 2064: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
2065: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
2066: should do so by setting <code class="varname">LOCALBASE</code> in
2067: <code class="filename">mk.conf</code>. You should not try to use multiple
2068: different <code class="varname">LOCALBASE</code> definitions on the same
2069: system (inside a chroot is an exception). </p>
2070: <p>The rest of this chapter assumes that the package is already
2071: 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
2072: instructions how to create your own packages.</p>
1.75 rillig 2073: <div class="sect2" lang="en">
2074: <div class="titlepage"><div><div><h3 class="title">
2075: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 2076: <p>To build packages from source, you need a working C
1.88 wiz 2077: compiler. On NetBSD, you need to install the
2078: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
2079: sets. If you want to build X11-related packages, the
2080: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
2081: sets are required, too.</p>
1.75 rillig 2082: </div>
2083: <div class="sect2" lang="en">
2084: <div class="titlepage"><div><div><h3 class="title">
2085: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
2086: <p>The first step for building a package is downloading the
1.88 wiz 2087: distfiles (i.e. the unmodified source). If they have not yet been
2088: downloaded, pkgsrc will fetch them automatically.</p>
2089: <p>If you have all files that you need in the
2090: <code class="filename">distfiles</code> directory,
2091: you don't need to connect. If the distfiles are on CD-ROM, you can
2092: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
2093: </p>
1.82 rillig 2094: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
2095: <p>
1.88 wiz 2096: to your <code class="filename">mk.conf</code>.</p>
1.91 rillig 2097: <p>By default a list of distribution sites will be randomly
2098: intermixed to prevent huge load on servers which holding popular
2099: packages (for example, SourceForge.net mirrors). Thus, every
2100: time when you need to fetch yet another distfile all the mirrors
2101: will be tried in new (random) order. You can turn this feature
2102: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
2103: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 2104: <p>You can overwrite some of the major distribution sites to
2105: fit to sites that are close to your own. By setting one or two
2106: variables you can modify the order in which the master sites are
2107: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
2108: delimited list of domain suffixes.
2109: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
2110: contains a whitespace delimited list of regular expressions. It
2111: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
2112: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
2113: some examples. This may save some of your bandwidth and
2114: time.</p>
1.75 rillig 2115: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 2116: if you want to keep the settings, by editing the
2117: <code class="filename">/etc/mk.conf</code> file,
2118: and adding the definitions there.</p>
1.82 rillig 2119: <p>
1.88 wiz 2120: If a package depends on many other packages (such as
1.93 rillig 2121: <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 2122: alternate between periods of
2123: downloading source, and compiling. To ensure you have all the source
2124: downloaded initially you can run the command:
2125: </p>
1.82 rillig 2126: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
2127: <p>
1.88 wiz 2128: which will output and run a set of shell commands to fetch the
2129: necessary files into the <code class="filename">distfiles</code> directory. You can
2130: also choose to download the files manually.
2131: </p>
1.75 rillig 2132: </div>
2133: <div class="sect2" lang="en">
2134: <div class="titlepage"><div><div><h3 class="title">
2135: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 2136: <p>
1.88 wiz 2137: Once the software has downloaded, any patches will be applied, then it
2138: will be compiled for you. This may take some time depending on your
2139: computer, and how many other packages the software depends on and their
2140: compile time.
2141: </p>
1.75 rillig 2142: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2143: <h3 class="title">Note</h3>
2144: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88 wiz 2145: use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
2146: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 2147: </div>
1.87 wiz 2148: <p>For example, type</p>
1.88 wiz 2149: <pre class="screen">
2150: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2151: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2152: </pre>
1.75 rillig 2153: <p>at the shell prompt to build the various components of the
1.88 wiz 2154: package.</p>
1.82 rillig 2155: <p>The next stage is to actually install the newly compiled
1.88 wiz 2156: program onto your system. Do this by entering:
1.82 rillig 2157:
1.88 wiz 2158: </p>
1.82 rillig 2159: <pre class="screen">
1.88 wiz 2160: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2161: </pre>
1.82 rillig 2162: <p>
2163:
1.88 wiz 2164: while you are still in the directory for whatever package you
2165: are installing.</p>
1.82 rillig 2166: <p>Installing the package on your system may require you to
1.88 wiz 2167: be root. However, pkgsrc has a
2168: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2169: to only become root for the actual installation step.</p>
1.82 rillig 2170: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2171: You can now enter:
1.82 rillig 2172:
1.88 wiz 2173: </p>
1.82 rillig 2174: <pre class="screen">
1.88 wiz 2175: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2176: </pre>
1.82 rillig 2177: <p>
2178:
1.88 wiz 2179: to remove the compiled files in the work directory, as you shouldn't need
2180: them any more. If other packages were also added to your system
2181: (dependencies) to allow your program to compile, you can tidy these up
2182: also with the command:</p>
1.82 rillig 2183: <pre class="screen">
1.88 wiz 2184: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2185: </pre>
1.75 rillig 2186: <p>Taking the figlet utility as an example, we can install it on our
1.88 wiz 2187: system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
2188: <p>The program is installed under the default root of the
2189: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2190: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2191: variable in your environment, and it will use that value as the
2192: root of your packages tree. So, to use
2193: <code class="filename">/usr/local</code>, set
2194: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2195: Please note that you should use a directory which is dedicated to
2196: packages and not shared with other programs (i.e., do not try and
2197: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2198: to add any of your own files or directories (such as
2199: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2200: <code class="filename">pkgsrc/</code>) below the
2201: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2202: conflicts between programs and other files installed by the
2203: package system and whatever else may have been installed
2204: there.</p>
2205: <p>Some packages look in <code class="filename">/etc/mk.conf</code> to
2206: alter some configuration options at build time. Have a look at
2207: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2208: of what will be set there by default. Environment variables such
2209: as <code class="varname">LOCALBASE</code> can be set in
2210: <code class="filename">/etc/mk.conf</code> to save having to remember to
2211: set them each time you want to use pkgsrc.</p>
2212: <p>Occasionally, people want to “<span class="quote">look under the
2213: covers</span>” to see what is going on when a package is building
2214: or being installed. This may be for debugging purposes, or out of
2215: simple curiosity. A number of utility values have been added to
2216: help with this.</p>
1.75 rillig 2217: <div class="orderedlist"><ol type="1">
2218: <li>
1.88 wiz 2219: <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
2220: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2221: information will be displayed. For example,</p>
1.75 rillig 2222: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2223: <p>will show all the commands that are invoked, up to and
2224: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 2225: </li>
2226: <li>
1.88 wiz 2227: <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>
2228: definition, then the <code class="varname">VARNAME</code> definition
2229: should be used, in conjunction with the show-var
2230: 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>
2231: variable <code class="varname">LOCALBASE</code>:</p>
2232: <pre class="screen">
2233: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2234: /usr/pkg
2235: <code class="prompt">%</code>
1.88 wiz 2236: </pre>
1.75 rillig 2237: </li>
2238: </ol></div>
2239: <p>If you want to install a binary package that you've either
1.88 wiz 2240: created yourself (see next section), that you put into
2241: pkgsrc/packages manually or that is located on a remote FTP
2242: server, you can use the "bin-install" target. This target will
2243: 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>,
2244: else do a <span><strong class="command">make package</strong></span>. The list of remote FTP
2245: sites searched is kept in the variable
2246: <code class="varname">BINPKG_SITES</code>, which defaults to
2247: 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>
2248: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2249: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2250: details.</p>
2251: <p>A final word of warning: If you set up a system that has a
2252: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2253: set that before any packages are installed, as you cannot use
2254: several directories for the same purpose. Doing so will result in
2255: pkgsrc not being able to properly detect your installed packages,
2256: and fail miserably. Note also that precompiled binary packages are
2257: usually built with the default <code class="varname">LOCALBASE</code> of
2258: <code class="filename">/usr/pkg</code>, and that you should
2259: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2260: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2261: </div>
2262: </div>
2263: </div>
2264: <div class="chapter" lang="en">
2265: <div class="titlepage"><div><div><h2 class="title">
2266: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2267: <div class="toc">
2268: <p><b>Table of Contents</b></p>
2269: <dl>
2270: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2271: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 2272: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2273: <dd><dl>
1.89 rillig 2274: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
2275: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2276: <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 2277: </dl></dd>
1.78 rillig 2278: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
2279: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 2280: </dl>
2281: </div>
1.89 rillig 2282: <p>The whole pkgsrc system is configured in a single file, usually
2283: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2284: that file depends on the installation. On NetBSD, when you use
2285: <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
2286: <code class="filename">/etc/</code>. In all other cases the default location is
2287: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2288: bootstrap program to install the binary packages.</p>
2289: <p>During the bootstrap, an example configuration file is created. To
2290: use that, you have to create the directory
2291: <code class="filename">${PREFIX}/etc</code> and copy the example file
2292: there.</p>
2293: <p>The format of the configuration file is that of the usual
2294: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2295: is done by setting variables in this file. Note that you can define all
2296: kinds of variables, and no special error checking (for example for
2297: spelling mistakes) takes place, so you have to try it out to see if it
2298: works.</p>
1.75 rillig 2299: <div class="sect1" lang="en">
2300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2301: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2302: <p>In this section, you can find some variables that apply to all
1.89 rillig 2303: pkgsrc packages. A complete list of the variables that can be
2304: configured by the user is available in
2305: <code class="filename">mk/defaults/mk.conf</code>, together with some
2306: comments that describe each variable's intent.</p>
1.75 rillig 2307: <div class="itemizedlist"><ul type="disc">
2308: <li><p><code class="varname">LOCALBASE</code>: Where
2309: packages will be installed. The default is
1.76 rillig 2310: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2311: with different <code class="varname">LOCALBASE</code>s!</p></li>
2312: <li><p><code class="varname">CROSSBASE</code>: Where
2313: “<span class="quote">cross</span>” category packages will be
2314: installed. The default is
1.76 rillig 2315: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2316: <li><p><code class="varname">X11BASE</code>: Where
2317: X11 is installed on the system. The default is
1.76 rillig 2318: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2319: <li><p><code class="varname">DISTDIR</code>: Where to store the
2320: downloaded copies of the original source distributions used
2321: for building pkgsrc packages. The default is
1.76 rillig 2322: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.75 rillig 2323: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2324: If set, override the packages'
2325: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2326: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2327: Backup location(s) for distribution files and patch files
2328: if not found locally or in
1.76 rillig 2329: <code class="filename">${MASTER_SITES}</code> or
2330: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2331: The defaults are
1.76 rillig 2332: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2333: and
1.76 rillig 2334: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2335: <li><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2336: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2337: <em class="replaceable"><code>arch</code></em> are replaced with OS
2338: release (“<span class="quote">2.0</span>”, etc.) and architecture
2339: (“<span class="quote">mipsel</span>”, etc.).</p></li>
1.82 rillig 2340: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2341: List of acceptable licenses. Whenever you try to build a package
2342: whose license is not in this list, you will get an error message
2343: that includes instructions on how to change this variable.</p></li>
1.75 rillig 2344: </ul></div>
2345: </div>
2346: <div class="sect1" lang="en">
2347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2348: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2349: <p>XXX
2350: </p>
2351: <div class="itemizedlist"><ul type="disc">
2352: <li><p><code class="varname">PACKAGES</code>: The top level
2353: directory for the binary packages. The default is
1.76 rillig 2354: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2355: <li><p><code class="varname">WRKOBJDIR</code>:
2356: The top level directory where, if defined, the separate
2357: working directories will get created, and symbolically
1.76 rillig 2358: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2359: This is useful for building packages on several
1.76 rillig 2360: architectures, then <code class="filename">${PKGSRCDIR}</code>
2361: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2362: is local to every architecture. (It should be noted that
2363: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.89 rillig 2364: — it is an internal definition which refers to the
1.75 rillig 2365: root of the pkgsrc tree. It is possible to have many
2366: pkgsrc tree instances.)</p></li>
2367: <li><p><code class="varname">LOCALPATCHES</code>:
2368: Directory for local patches that aren't part of pkgsrc.
1.90 rillig 2369: See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more
1.93 rillig 2370: information.</p></li>
1.75 rillig 2371: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.76 rillig 2372: the <code class="filename">mk.conf</code> file used by a package's
1.75 rillig 2373: BSD-style Makefile. If this is not set,
2374: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2375: <code class="filename">/dev/null</code> to avoid picking up
2376: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2377: <li><p><code class="varname">DEPENDS_TARGET</code>:
2378: By default, dependencies are only installed, and no binary
2379: package is created for them. You can set this variable to
2380: <code class="literal">package</code> to automatically create binary
2381: packages after installing dependencies.</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">
1.78 rillig 2386: <a name="conf.compiler"></a>5.3. Selecting and configuring the compiler</h2></div></div></div>
2387: <div class="sect2" lang="en">
2388: <div class="titlepage"><div><div><h3 class="title">
1.89 rillig 2389: <a name="selecting-the-compiler"></a>5.3.1. Selecting the compiler</h3></div></div></div>
2390: <p>By default, pkgsrc will use GCC to build packages. This may be
2391: overridden by setting the following variables in /etc/mk.conf:</p>
2392: <div class="variablelist"><dl>
2393: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2394: <dd>
2395: <p>This is a list of values specifying the chain of
2396: compilers to invoke when building packages. Valid values
2397: are:</p>
2398: <div class="itemizedlist"><ul type="disc">
2399: <li><p><code class="varname">distcc</code>:
2400: distributed C/C++ (chainable)</p></li>
2401: <li><p><code class="varname">ccache</code>:
2402: compiler cache (chainable)</p></li>
2403: <li><p><code class="varname">gcc</code>:
2404: GNU C/C++ Compiler</p></li>
2405: <li><p><code class="varname">mipspro</code>:
2406: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2407: <li><p><code class="varname">mipspro</code>:
2408: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2409: <li><p><code class="varname">sunpro</code>:
2410: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2411: </ul></div>
2412: <p>The default is
2413: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2414: <code class="varname">ccache</code> and/or
2415: <code class="varname">distcc</code> with an appropriate
2416: <code class="varname">PKGSRC_COMPILER</code> setting,
2417: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
1.94 dmcmahil 2418: variable should always be terminated with a value for
2419: a real compiler. Note that only one real compiler
2420: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2421: is not allowed).</p>
1.89 rillig 2422: </dd>
2423: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2424: <dd><p>This specifies the minimum version of GCC to use
2425: when building packages. If the system GCC doesn't
2426: satisfy this requirement, then pkgsrc will build and
2427: install one of the GCC packages to use instead.</p></dd>
2428: </dl></div>
2429: </div>
2430: <div class="sect2" lang="en">
2431: <div class="titlepage"><div><div><h3 class="title">
2432: <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 2433: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2434: please make sure to use the <code class="literal">+=</code> operator
2435: instead of the <code class="literal">=</code> operator:</p>
2436: <pre class="programlisting">
2437: CFLAGS+= -your -flags
2438: </pre>
2439: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2440: “<span class="quote">+</span>”) may lead to problems with packages that need
2441: to add their own flags. Also, you may want to take a look at
1.91 rillig 2442: 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 2443: you're interested in optimization for the current CPU.</p>
2444: </div>
1.88 wiz 2445: <div class="sect2" lang="en">
2446: <div class="titlepage"><div><div><h3 class="title">
1.89 rillig 2447: <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 2448: <p>If you want to pass flags to the linker, both in the configure
2449: step and the build step, you can do this in two ways. Either set
2450: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2451: between the two is that <code class="varname">LIBS</code> will be appended to
2452: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2453: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2454: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2455: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2456: <code class="varname">CFLAGS</code>, if you do not wish to override these
2457: settings, use the <code class="literal">+=</code> operator:</p>
2458: <pre class="programlisting">
2459: LDFLAGS+= -your -linkerflags
2460: </pre>
2461: </div>
1.78 rillig 2462: </div>
2463: <div class="sect1" lang="en">
2464: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2465: <a name="developer-advanced-settings"></a>5.4. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2466: <p>XXX
2467: </p>
2468: <div class="itemizedlist"><ul type="disc">
2469: <li>
2470: <p><code class="varname">PKG_DEVELOPER</code>:
2471: Run some sanity checks that package developers want:
2472: </p>
2473: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2474: <li><p>make sure patches apply with zero
2475: fuzz</p></li>
2476: <li><p>run check-shlibs to see that all
2477: binaries will find their shared libs.</p></li>
1.75 rillig 2478: </ul></div>
2479: <p>
1.87 wiz 2480: </p>
1.75 rillig 2481: </li>
1.88 wiz 2482: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2483: of debugging output which is displayed whilst making and
2484: installing the package. The default value for this is 0,
2485: which will not display the commands as they are executed
2486: (normal, default, quiet operation); the value 1 will display
2487: all shell commands before their invocation, and the value 2
2488: will display both the shell commands before their invocation,
2489: and their actual execution progress with <span><strong class="command">set
2490: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2491: </ul></div>
2492: <p>
2493: </p>
2494: </div>
2495: <div class="sect1" lang="en">
2496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78 rillig 2497: <a name="selecting-build-options"></a>5.5. Selecting Build Options</h2></div></div></div>
1.88 wiz 2498: <p>Some packages have build time options, usually to select
2499: between different dependencies, enable optional support for big
2500: dependencies or enable experimental features.</p>
1.75 rillig 2501: <p>To see which options, if any, a package supports, and which
1.88 wiz 2502: options are mutually exclusive, run <span><strong class="command">make
2503: show-options</strong></span>, for example:</p>
1.75 rillig 2504: <pre class="programlisting">
2505: The following options are supported by this package:
2506: ssl Enable SSL support.
2507: Exactly one of the following gecko options is required:
2508: firefox Use firefox as gecko rendering engine.
2509: mozilla Use mozilla as gecko rendering engine.
2510: At most one of the following database options may be selected:
2511: mysql Enable support for MySQL database.
2512: pgsql Enable support for PostgreSQL database.
1.1 grant 2513:
1.75 rillig 2514: These options are enabled by default: firefox
2515: These options are currently enabled: mozilla ssl
1.1 grant 2516: </pre>
1.75 rillig 2517: <p>The following variables can be defined in
1.88 wiz 2518: <code class="filename">/etc/mk.conf</code> to select which options to
2519: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2520: which can be used to select or disable options for all packages
2521: that support them, and
2522: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2523: which can be used to select or disable options specifically for
2524: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2525: these variables are selected, options preceded by “<span class="quote">-</span>”
2526: are disabled. A few examples:</p>
1.75 rillig 2527: <pre class="screen">
2528: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" /etc/mk.conf</strong></span>
2529: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2530: PKG_OPTIONS.kdebase= debug -sasl
2531: PKG_OPTIONS.apache= suexec </pre>
1.88 wiz 2532: <p>The following settings are consulted in the order given, and
2533: the last setting that selects or disables an option is
2534: used:</p>
1.75 rillig 2535: <div class="orderedlist"><ol type="1">
2536: <li><p>the default options as suggested by the package
1.88 wiz 2537: maintainer</p></li>
1.75 rillig 2538: <li><p>the options implied by the settings of legacy
1.88 wiz 2539: variables (see below)</p></li>
1.75 rillig 2540: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2541: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2542: </ol></div>
2543: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2544: selected is used, all others are automatically disabled. If an
2545: option of the group is explicitly disabled, the previously
2546: selected option, if any, is used. It is an error if no option
2547: from a required group of options is selected, and building the
2548: package will fail.</p>
2549: <p>Before the options framework was introduced, build options
2550: were selected by setting a variable (often named
2551: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
2552: <code class="filename">/etc/mk.conf</code> for each option. To ease
2553: transition to the options framework for the user, these legacy
2554: variables are converted to the appropriate options setting
2555: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2556: automatically. A warning is issued to prompt the user to update
2557: <code class="filename">/etc/mk.conf</code> to use the options framework
2558: directly. Support for the legacy variables will be removed
2559: eventually.</p>
1.75 rillig 2560: </div>
2561: </div>
2562: <div class="chapter" lang="en">
2563: <div class="titlepage"><div><div><h2 class="title">
2564: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2565: <div class="toc">
2566: <p><b>Table of Contents</b></p>
2567: <dl>
2568: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2569: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2570: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
2571: <dd><dl>
2572: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
2573: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
2574: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
2575: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
2576: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
2577: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2578: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
2579: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
2580: </dl></dd>
2581: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2582: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
2583: </dl>
2584: </div>
2585: <div class="sect1" lang="en">
2586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2587: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2588: <p>Once you have built and installed a package, you can create
2589: a <span class="emphasis"><em>binary package</em></span> which can be installed on
2590: 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
2591: the same package on a group of hosts and wasting CPU time. It also
2592: provides a simple means for others to install your package, should
2593: you distribute it.</p>
2594: <p>To create a binary package, change into the appropriate
2595: directory in pkgsrc, and run <span><strong class="command">make
2596: package</strong></span>:</p>
2597: <pre class="screen">
2598: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2599: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2600: </pre>
2601: <p>This will build and install your package (if not already done),
2602: and then build a binary package from what was installed. You can
2603: then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
2604: it. Binary packages are created by default in
2605: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2606: gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2607: 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 2608: <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 2609: such a binary package.</p>
1.75 rillig 2610: </div>
2611: <div class="sect1" lang="en">
2612: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2613: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90 rillig 2614: <p>See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, “Other helpful targets”</a>.</p>
1.75 rillig 2615: </div>
2616: <div class="sect1" lang="en">
2617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2618: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
2619: <p>If you want to get a full set of precompiled binary
1.87 wiz 2620: packages, this section describes how to get them. Beware that
2621: the bulk build will remove all currently installed packages from
2622: your system!</p>
1.75 rillig 2623: <p>Having an FTP server configured either on the
1.87 wiz 2624: machine doing the bulk builds or on a nearby NFS server can help
2625: to make the packages available to other machines that can then
2626: 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
2627: more information. If you use a remote NFS server's storage, be
2628: sure to not actually compile on NFS storage, as this slows
2629: things down a lot.</p>
1.75 rillig 2630: <div class="sect2" lang="en">
2631: <div class="titlepage"><div><div><h3 class="title">
2632: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
2633: <div class="sect3" lang="en">
2634: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 2635: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code>
2636: </h4></div></div></div>
1.76 rillig 2637: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2638: configuration file for bulk builds. You can configure how your
2639: copy of pkgsrc is kept up to date, how the distfiles are
2640: downloaded, how the packages are built and how the report is
2641: generated. You can find an annotated example file in
2642: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2643: it, copy <code class="filename">build.conf-example</code> to
2644: <code class="filename">build.conf</code> and edit it, following the
2645: comments in that file.</p>
1.75 rillig 2646: </div>
2647: <div class="sect3" lang="en">
2648: <div class="titlepage"><div><div><h4 class="title">
2649: <a name="binary.mk.conf"></a>6.3.1.2. /etc/mk.conf</h4></div></div></div>
2650: <p>You may want to set variables in
1.87 wiz 2651: <code class="filename">/etc/mk.conf</code>.
2652: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2653: details of the default settings. You will want to ensure that
2654: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2655: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
2656: accepts <span class="emphasis"><em>all</em></span> licenses.</p>
2657: <pre class="programlisting">
2658: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2659: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2660: BSDSRCDIR= /usr/src
2661: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2662: OBJHOSTNAME?= yes # use work.`hostname`
2663: FAILOVER_FETCH= yes # insist on the correct checksum
2664: PKG_DEVELOPER?= yes
2665: _ACCEPTABLE= yes
2666: </pre>
1.75 rillig 2667: <p>Some options that are especially useful for bulk builds
2668: can be found at the top lines of the file
1.76 rillig 2669: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2670: options of these are briefly described here.</p>
2671: <div class="itemizedlist"><ul type="disc">
2672: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2673: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2674: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2675: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2676: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2677: to the directory where all log files are created. Otherwise the
2678: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2679: <li><p>Another important variable is
1.87 wiz 2680: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2681: should be always available while building other
2682: packages.</p></li>
1.75 rillig 2683: </ul></div>
2684: <p>Some other options are scattered in the pkgsrc
2685: infrastructure:</p>
2686: <div class="itemizedlist"><ul type="disc">
2687: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2688: should be set to <code class="literal">yes</code>. The purpose of the bulk
2689: builds is creating binary packages, no matter if they are
2690: vulnerable or not. When uploading the packages to a public
2691: server, the vulnerable packages will be put into a directory of
2692: their own. Leaving this variable unset would prevent the bulk
2693: build system from even trying to build them, so possible
2694: building errors would not show up.</p></li>
1.75 rillig 2695: <li><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2696: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87 wiz 2697: “<span class="quote">yes</span>” to check that the installed set of files
2698: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2699: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2700: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87 wiz 2701: “<span class="quote">yes</span>” to check that the installed
2702: “<span class="quote">#!</span>”-scripts will find their
2703: interpreter.</p></li>
1.91 rillig 2704: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2705: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2706: package's self-test before installing it. Note that some
2707: packages make heavy use of “<span class="quote">good</span>” random
2708: numbers, so you need to assure that the machine on which you
2709: are doing the bulk builds is not completely idle. Otherwise
2710: some test programs will seem to hang, while they are just
2711: waiting for new random data to be
2712: available.</p></li>
1.75 rillig 2713: </ul></div>
2714: </div>
2715: <div class="sect3" lang="en">
2716: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 2717: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
2718: </h4></div></div></div>
1.75 rillig 2719: <p>It is possible to configure the bulk build to perform
1.87 wiz 2720: certain site-specific tasks at the end of the pre-build
2721: stage. If the file
2722: <code class="filename">pre-build.local</code> exists in
2723: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2724: (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
2725: stage. An example use of
2726: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2727: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2728: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2729: <p>to prevent the system from trying to build a particular package
1.87 wiz 2730: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2731: </div>
2732: </div>
2733: <div class="sect2" lang="en">
2734: <div class="titlepage"><div><div><h3 class="title">
2735: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2736: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2737: deleted at the start of bulk builds, make sure your login
2738: shell is placed somewhere else. Either drop it into
2739: <code class="filename">/usr/local/bin</code> (and adjust your login
2740: shell in the passwd file), or (re-)install it via
2741: <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
2742: you can login after a reboot (remember that your current
2743: process won't die if the package is removed, you just can't
2744: start any new instances of the shell any more). Also, if you
2745: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2746: version of ssh for some reason, be sure to install ssh before
2747: starting it from <code class="filename">rc.local</code>:</p>
2748: <pre class="programlisting">
2749: ( cd /usr/pkgsrc/security/ssh ; make bulk-install )
2750: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2751: /usr/pkg/etc/rc.d/sshd
2752: fi
2753: </pre>
1.75 rillig 2754: <p>Not doing so will result in you being not able to log in
1.87 wiz 2755: via ssh after the bulk build is finished or if the machine
2756: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2757: </div>
2758: <div class="sect2" lang="en">
2759: <div class="titlepage"><div><div><h3 class="title">
2760: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
2761: <p>Make sure you don't need any of the packages still
1.87 wiz 2762: installed.</p>
1.75 rillig 2763: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2764: <h3 class="title">Warning</h3>
2765: <p>During the bulk build, <span class="emphasis"><em>all packages will be
1.87 wiz 2766: removed!</em></span></p>
1.75 rillig 2767: </div>
2768: <p>Be sure to remove all other things that might
1.87 wiz 2769: interfere with builds, like some libs installed in
2770: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2771: <pre class="screen">
2772: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2773: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2774: </pre>
1.75 rillig 2775: <p>If for some reason your last build didn't complete (power
1.87 wiz 2776: failure, system panic, ...), you can continue it by
2777: running:</p>
1.75 rillig 2778: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2779: <p>At the end of the bulk build, you will get a summary via mail,
2780: and find build logs in the directory specified by
2781: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2782: file.</p>
1.75 rillig 2783: </div>
2784: <div class="sect2" lang="en">
2785: <div class="titlepage"><div><div><h3 class="title">
2786: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
2787: <p>The bulk builds consist of three steps:</p>
2788: <div class="variablelist"><dl>
2789: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2790: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2791: cleans out any broken distfiles, and removes all
2792: packages installed.</p></dd>
1.75 rillig 2793: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2794: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2795: an optimised order in which packages will be
2796: built. Packages that don't require other packages will
2797: be built first, and packages with many dependencies will
2798: be built later.</p></dd>
1.75 rillig 2799: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2800: <dd><p>Generates a report that's placed in the directory
2801: specified in the <code class="filename">build.conf</code> file
2802: named <code class="filename">broken.html</code>, a short version
2803: of that report will also be mailed to the build's
2804: admin.</p></dd>
1.75 rillig 2805: </dl></div>
1.87 wiz 2806: <p>During the build, a list of broken packages will be compiled
2807: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2808: <code class="filename">.../.broken.${MACHINE}</code> if
2809: <code class="varname">OBJMACHINE</code> is set), individual build logs
2810: of broken builds can be found in the package's
2811: directory. These files are used by the bulk-targets to mark
2812: broken builds to not waste time trying to rebuild them, and
2813: they can be used to debug these broken package builds
2814: later.</p>
1.75 rillig 2815: </div>
2816: <div class="sect2" lang="en">
2817: <div class="titlepage"><div><div><h3 class="title">
2818: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
2819: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2820: NetBSD 2.0/i386:</p>
1.75 rillig 2821: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2822: <li><p>10 GB - distfiles (NFS ok)</p></li>
2823: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2824: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2825: </ul></div>
2826: <p>Note that all pkgs will be de-installed as soon as they are
2827: turned into a binary package, and that sources are removed,
2828: so there is no excessively huge demand to disk
2829: space. Afterwards, if the package is needed again, it will
2830: 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
2831: there are no cycles wasted by recompiling.</p>
1.75 rillig 2832: </div>
2833: <div class="sect2" lang="en">
2834: <div class="titlepage"><div><div><h3 class="title">
2835: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2836: <p>If you don't want all the packages nuked from a machine
2837: (rendering it useless for anything but pkg compiling), there
2838: is the possibility of doing the package bulk build inside a
2839: chroot environment.</p>
2840: <p>The first step is to set up a chroot sandbox,
2841: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2842: using null mounts, or manually.</p>
2843: <p>There is a shell script called
2844: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2845: up the sandbox environment using null mounts. It will also
2846: create a script called <code class="filename">sandbox</code> in the
2847: root of the sandbox environment, which will allow the null
2848: mounts to be activated using the <span><strong class="command">sandbox
2849: mount</strong></span> command and deactivated using the
2850: <span><strong class="command">sandbox umount</strong></span> command.</p>
2851: <p>To set up a sandbox environment by hand, after extracting all
2852: the sets from a NetBSD installation or doing a <span><strong class="command">make
2853: distribution DESTDIR=/usr/sandbox</strong></span> in
2854: <code class="filename">/usr/src/etc</code>, be sure the following items
2855: are present and properly configured:</p>
1.75 rillig 2856: <div class="procedure"><ol type="1">
2857: <li>
2858: <p>Kernel</p>
2859: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2860: </li>
2861: <li>
1.76 rillig 2862: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2863: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2864: </li>
2865: <li>
1.91 rillig 2866: <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 2867: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2868: </li>
2869: <li>
2870: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2871: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2872: </li>
2873: <li>
1.91 rillig 2874: <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 2875: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2876: </li>
2877: <li>
1.76 rillig 2878: <p><code class="filename">/usr/src</code> (system sources,
1.91 rillig 2879: 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 2880: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2881: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2882: </li>
2883: <li>
1.76 rillig 2884: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2885: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2886: </li>
2887: <li>
1.76 rillig 2888: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2889: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2890: </li>
2891: <li>
2892: <p>Checkout pkgsrc via cvs into
1.87 wiz 2893: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2894: <pre class="screen">
2895: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2896: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2897: </pre>
1.75 rillig 2898: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2899: you do development in, as this will likely cause problems!</p>
1.75 rillig 2900: </li>
2901: <li><p>Make
1.87 wiz 2902: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2903: <code class="filename">.../distfiles</code> point somewhere
2904: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.76 rillig 2905: <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>
2906: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2907: </ol></div>
2908: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2909: the build with the following steps:</p>
2910: <pre class="screen">
2911: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2912: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2913: </pre>
2914: <p>This will just jump inside the sandbox and start building. At
2915: the end of the build, mail will be sent with the results of
2916: the build. Created binary pkgs will be in
2917: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2918: (wherever that points/mounts to/from).</p>
1.75 rillig 2919: </div>
2920: <div class="sect2" lang="en">
2921: <div class="titlepage"><div><div><h3 class="title">
2922: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2923: <p>In addition to building a complete set of all packages in
2924: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2925: may be used to build a subset of the packages contained in
2926: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
2927: in <code class="filename">/etc/mk.conf</code>, the variables</p>
1.75 rillig 2928: <div class="itemizedlist"><ul type="disc">
2929: <li><p>SITE_SPECIFIC_PKGS</p></li>
2930: <li><p>HOST_SPECIFIC_PKGS</p></li>
2931: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2932: <li><p>USER_SPECIFIC_PKGS</p></li>
2933: </ul></div>
1.87 wiz 2934: <p>will define the set of packages which should be built.
2935: The bulk build code will also include any packages which are
2936: needed as dependencies for the explicitly listed packages.</p>
2937: <p>One use of this is to do a bulk build with
2938: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2939: periodically to have a complete set of the binary packages
2940: needed for your site available without the overhead of
2941: building extra packages that are not needed.</p>
1.75 rillig 2942: </div>
2943: <div class="sect2" lang="en">
2944: <div class="titlepage"><div><div><h3 class="title">
2945: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2946: <p>This section describes how pkgsrc developers can upload binary
2947: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2948: <p>If you would like to automatically create checksum files for the
2949: binary packages you intend to upload, remember to set
2950: <code class="varname">MKSUMS=yes</code> in your
2951: <code class="filename">mk/bulk/build.conf</code>.</p>
2952: <p>If you would like to PGP sign the checksum files (highly
2953: recommended!), remember to set
2954: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2955: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2956: your GPG password to sign the files before uploading everything.</p>
2957: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2958: set properly in your <code class="filename">mk/bulk/build.conf</code>
2959: file, i.e. adjust it to something like one of the following:</p>
1.93 rillig 2960: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
2961: <p>Please use appropriate values for "packages-200xQy",
1.87 wiz 2962: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2963: is different from your local login, write your login directly
2964: into the variable, e.g. my local account is "feyrer", but for my
2965: login "hubertf", I use:</p>
1.93 rillig 2966: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 2967: <p>A separate <code class="filename">upload</code> directory is used
2968: here to allow "closing" the directory during upload. To do
2969: so, run the following command on ftp.NetBSD.org next:</p>
1.93 rillig 2970: <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 2971: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2972: only appropriate for packages for the NetBSD operating
2973: system. Binary packages for other operating systems should go
2974: into <code class="filename">/pub/pkgsrc</code>.</p>
2975: <p>Before uploading the binary pkgs, ssh authentication needs
2976: to be set up. This example shows how to set up temporary keys
2977: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2978: (assuming that no keys should be present there usually):</p>
2979: <pre class="screen">
2980: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 2981: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2982: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 2983: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
2984: </pre>
2985: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
2986: append it to your <code class="filename">~/.ssh/authorized_keys</code>
2987: file on ftp.NetBSD.org. You can remove the key after the
2988: upload is done!</p>
2989: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 2990: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 2991: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2992: <p>Now after all this works, you can exit the sandbox and start
2993: the upload:</p>
2994: <pre class="screen">
2995: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 2996: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 2997: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2998: </pre>
2999: <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
3000: <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
3001: upload. The upload script will take care of not uploading
3002: restricted packages and putting vulnerable packages into the
3003: <code class="filename">vulnerable</code> subdirectory.</p>
3004: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 3005: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 3006: Gdd:x! </pre>
3007: <p>Use whatever is needed to remove the key you've entered
3008: before! Last, move the uploaded packages out of the
3009: <code class="filename">upload</code> directory to have them accessible
3010: to everyone:</p>
3011: <pre class="screen">
1.93 rillig 3012: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 3013: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3014: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 3015: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
3016: </pre>
1.75 rillig 3017: </div>
3018: </div>
3019: <div class="sect1" lang="en">
3020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3021: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 3022: <p>After your pkgsrc bulk-build has completed, you may wish to
3023: create a CD-ROM set of the resulting binary packages to assist
3024: in installing packages on other machines. The
1.91 rillig 3025: <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 3026: a simple tool for creating the ISO 9660 images.
3027: <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
3028: way that keeps all the dependencies for a given package on the same
3029: CD as that package.</p>
1.75 rillig 3030: <div class="sect2" lang="en">
3031: <div class="titlepage"><div><div><h3 class="title">
3032: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 3033: <p>Complete documentation for cdpack is found in the cdpack(1)
3034: man page. The following short example assumes that the binary
3035: packages are left in
3036: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3037: sufficient disk space exists in <code class="filename">/u2</code> to
3038: hold the ISO 9660 images.</p>
3039: <pre class="screen">
3040: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3041: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3042: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3043: </pre>
3044: <p>If you wish to include a common set of files
3045: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3046: etc.) on each CD in the collection, then you need to create a
3047: directory which contains these files. e.g.</p>
3048: <pre class="screen">
3049: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3050: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3051: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3052: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3053: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3054: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3055: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3056: </pre>
1.75 rillig 3057: <p>Now create the images:</p>
3058: <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 3059: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3060: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3061: in their root directories.</p>
1.75 rillig 3062: </div>
3063: </div>
3064: </div>
3065: <div class="chapter" lang="en">
3066: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3067: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
3068: <div class="toc">
3069: <p><b>Table of Contents</b></p>
3070: <dl>
1.91 rillig 3071: <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 3072: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
3073: </dl>
3074: </div>
3075: <p>The files that are installed by pkgsrc are organized in a way that
3076: is similar to what you find in the <code class="filename">/usr</code> directory
3077: of the base system. But some details are different. This is because
3078: pkgsrc initially came from FreeBSD and had adopted its file system
3079: hierarchy. Later it was largely influenced by NetBSD. But no matter
3080: which operating system you are using pkgsrc with, you can expect the
3081: same layout for pkgsrc.</p>
1.91 rillig 3082: <p>There are mainly four root directories for pkgsrc, which are all
3083: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3084: When pkgsrc has been installed as root, the default locations
3085: are:</p>
3086: <pre class="programlisting">
3087: LOCALBASE= /usr/pkg
3088: PKG_SYSCONFBASE= /usr/pkg/etc
3089: VARBASE= /var
1.93 rillig 3090: PKG_DBDIR= /var/db/pkg
1.91 rillig 3091: </pre>
3092: <p>In unprivileged mode (when pkgsrc has been installed as any other
3093: user), the default locations are:</p>
3094: <pre class="programlisting">
3095: LOCALBASE= ${HOME}/pkg
3096: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3097: VARBASE= ${HOME}/pkg/var
1.93 rillig 3098: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3099: </pre>
3100: <p>What these four directories are for, and what they look like is
3101: explained below.</p>
1.90 rillig 3102: <div class="itemizedlist"><ul type="disc">
3103: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3104: <code class="filename">/usr</code> directory in the base system. It is the
3105: “<span class="quote">main</span>” directory where the files are installed and contains
3106: the well-known subdirectories like <code class="filename">bin</code>,
3107: <code class="filename">include</code>, <code class="filename">lib</code>,
3108: <code class="filename">share</code> and
3109: <code class="filename">sbin</code>.</p></li>
3110: <li><p><code class="varname">VARBASE</code> corresponds to
3111: <code class="filename">/var</code> in the base system. Some programs (especially
3112: games, network daemons) need write access to it during normal
3113: operation.</p></li>
3114: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3115: <code class="filename">/etc</code> in the base system. It contains configuration
3116: files of the packages, as well as pkgsrc's <code class="filename">mk.conf</code>
3117: itself.</p></li>
3118: </ul></div>
3119: <div class="sect1" lang="en">
3120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 3121: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code>
3122: </h2></div></div></div>
1.90 rillig 3123: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3124: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3125: <div class="variablelist"><dl>
3126: <dt><span class="term"><code class="filename">bin</code></span></dt>
3127: <dd><p>Contains executable programs that are intended to be
3128: directly used by the end user.</p></dd>
3129: <dt><span class="term"><code class="filename">emul</code></span></dt>
3130: <dd><p>Contains files for the emulation layers of various other
3131: operating systems, especially for
3132: NetBSD.</p></dd>
3133: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3134: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3135: <dd><p>Contains
3136: the configuration files.</p></dd>
3137: <dt><span class="term"><code class="filename">include</code></span></dt>
3138: <dd><p>Contains headers for the C and C++ programming
3139: languages.</p></dd>
3140: <dt><span class="term"><code class="filename">info</code></span></dt>
3141: <dd><p>Contains GNU info files of various
3142: packages.</p></dd>
3143: <dt><span class="term"><code class="filename">lib</code></span></dt>
3144: <dd><p>Contains shared and static
3145: libraries.</p></dd>
3146: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3147: <dd><p>Contains data files that don't change after
3148: installation. Other data files belong into
3149: <code class="filename">${VARBASE}</code>.</p></dd>
3150: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3151: <dd><p>Contains programs that are not intended to be used by
3152: end users, such as helper programs or network
3153: daemons.</p></dd>
3154: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3155: <dd><p>Contains programs that are intended to be executed as
3156: CGI scripts by a web server.</p></dd>
3157: <dt><span class="term"><code class="filename">man</code> (the usual value of
3158: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3159: <dd><p>Contains brief
3160: documentation in form of manual pages.</p></dd>
3161: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3162: <dd><p>Contains programs that are intended to be used only by
3163: the super-user.</p></dd>
3164: <dt><span class="term"><code class="filename">share</code></span></dt>
3165: <dd><p>Contains platform-independent data files that don't
3166: change after installation.</p></dd>
3167: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3168: <dd><p>Contains documentation files provided by the
3169: packages.</p></dd>
3170: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3171: <dd><p>Contains example files provided by the packages. Among
3172: others, the original configuration files are saved here and copied to
3173: <code class="filename">${PKG_SYSCONFDIR}</code> during
3174: installation.</p></dd>
3175: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3176: <dd><p>Contains the original files for rc.d
3177: scripts.</p></dd>
3178: <dt><span class="term"><code class="filename">var</code> (the usual location of
3179: <code class="filename">${VARBASE}</code>)</span></dt>
3180: <dd><p>Contains files
3181: that may be modified after
3182: installation.</p></dd>
3183: </dl></div>
3184: </div>
3185: <div class="sect1" lang="en">
3186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 3187: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code>
3188: </h2></div></div></div>
1.90 rillig 3189: <div class="variablelist"><dl>
3190: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3191: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3192: <dd><p>Contains
3193: information about the currently installed
3194: packages.</p></dd>
3195: <dt><span class="term"><code class="filename">games</code></span></dt>
3196: <dd><p>Contains highscore
3197: files.</p></dd>
3198: <dt><span class="term"><code class="filename">log</code></span></dt>
3199: <dd><p>Contains log files.</p></dd>
3200: <dt><span class="term"><code class="filename">run</code></span></dt>
3201: <dd><p>Contains informational files about daemons that are
3202: currently running.</p></dd>
3203: </dl></div>
3204: </div>
3205: </div>
3206: <div class="chapter" lang="en">
3207: <div class="titlepage"><div><div><h2 class="title">
3208: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3209: <div class="toc">
3210: <p><b>Table of Contents</b></p>
3211: <dl>
1.90 rillig 3212: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3213: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
3214: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
3215: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
3216: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
3217: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
3218: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
3219: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
3220: <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>
3221: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
3222: <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 3223: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 3224: <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>
3225: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
3226: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
3227: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
3228: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3229: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
3230: <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 3231: </dl>
3232: </div>
3233: <p>This section contains hints, tips & tricks on special things in
3234: pkgsrc that we didn't find a better place for in the previous chapters, and
3235: it contains items for both pkgsrc users and developers.</p>
3236: <div class="sect1" lang="en">
3237: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3238: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3239: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3240: <div class="itemizedlist"><ul type="disc">
1.78 rillig 3241: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
3242: This is a general purpose list for most issues regarding
3243: pkgsrc, regardless of platform, e.g. soliciting user help
3244: for pkgsrc configuration, unexpected build failures, using
3245: particular packages, upgrading pkgsrc installations,
3246: questions regarding the pkgsrc release branches, etc. General announcements or
3247: proposals for changes that impact the pkgsrc user community,
3248: e.g. major infrastructure changes, new features, package
3249: removals, etc., may also be posted.</p></li>
1.75 rillig 3250: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
3251: A list where the results of pkgsrc bulk builds are sent and
3252: discussed.</p></li>
3253: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
3254: This list is for those who are interested in getting a
3255: commit message for every change committed to pkgsrc. It is
3256: also available in digest form, meaning one daily message
3257: containing all commit messages for changes to the package
3258: source tree in that 24 hour period.</p></li>
3259: </ul></div>
3260: <p>To subscribe, do:</p>
3261: <pre class="programlisting">
3262: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3263: </pre>
3264: <p>Archives for all these mailing lists are available from
3265: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3266: </div>
3267: <div class="sect1" lang="en">
3268: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3269: <a name="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3270: <p>Pkgviews is tightly integrated with buildlink. You can find a
3271: pkgviews User's guide in
1.76 rillig 3272: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3273: </div>
3274: <div class="sect1" lang="en">
3275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3276: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3277: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3278: a number of useful utilities for both users and developers of pkgsrc. This
3279: section attempts only to make the reader aware of the utilities and when
3280: they might be useful, and not to duplicate the documentation that comes
3281: with each package.</p>
3282: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 rillig 3283: <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 3284: Symlinks for use by buildlink.</p></li></ul></div>
3285: <p>OS tool augmentation (automatically installed when needed):</p>
3286: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3287: <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 3288: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 rillig 3289: <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 3290: Compatibility library for pkgsrc tools.</p></li>
1.91 rillig 3291: <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 3292: non-BSD systems due to lack of native mtree.</p></li>
1.91 rillig 3293: <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 3294: Up-to-date replacement for
1.76 rillig 3295: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3296: systems where pkg_install is not present.</p></li>
3297: </ul></div>
3298: <p>Utilities used by pkgsrc (not automatically installed):</p>
3299: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3300: <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 3301: Create a binary package from an
3302: already-installed package. Used by <span><strong class="command">make replace</strong></span> to
3303: save the old package.</p></li>
1.91 rillig 3304: <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 3305: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3306: from multiple locations. It currently supports the following
3307: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 rillig 3308: <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 3309: packages someplace else (enabled by default).</p></li>
1.91 rillig 3310: <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 3311: best compiler flags to optimise code for your current CPU and
3312: compiler.</p></li>
3313: </ul></div>
3314: <p>Utilities for keeping track of installed packages, being up to date,
3315: etc:</p>
3316: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3317: <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 3318: packages whose installed versions do not match the latest pkgsrc
3319: entries.</p></li>
1.91 rillig 3320: <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 3321: dependency graphs of packages, to aid in choosing a strategy for
3322: updating.</p></li>
1.91 rillig 3323: <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
3324: 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>
3325: <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 3326: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3327: does various checks on the complete pkgsrc system.</p></li>
1.91 rillig 3328: <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 3329: packages you have installed.</p></li>
3330: </ul></div>
3331: <p>Utilities for people maintaining or creating individual packages:</p>
3332: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3333: <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 3334: making and maintaining patches for a package (includes pkgdiff,
3335: pkgvi, mkpatches, etc.).</p></li>
1.91 rillig 3336: <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>,
3337: <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 3338: converting to pkgsrc.</p></li>
1.91 rillig 3339: <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 3340: pkgsrc to a Solaris package.</p></li>
3341: </ul></div>
3342: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3343: utilities)</p>
3344: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3345: <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 3346: packages in a chrooted area.</p></li>
1.91 rillig 3347: <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 3348: kernel version for chrooted cross builds.</p></li>
3349: </ul></div>
3350: </div>
3351: <div class="sect1" lang="en">
3352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3353: <a name="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3354: <p>If you want to use pkgsrc as non-root user, you can set some
3355: variables to make pkgsrc work under these conditions. At the very least,
3356: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3357: will turn on unprivileged mode and set multiple related variables to allow
3358: installation of packages as non-root.</p>
3359: <p>In case the defaults are not enough, you may want to tune some other
3360: variables used. For example, if the automatic user/group detection leads
3361: to incorrect values (or not the ones you would like to use), you can change
3362: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3363: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3364: <p>As regards bootstrapping, please note that the
3365: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
3366: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3367: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3368: installation targets. These directories can be overridden by the
1.75 rillig 3369: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3370: that allow finer tuning of the tree layout.</p>
3371: </div>
3372: <div class="sect1" lang="en">
3373: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3374: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3375: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3376: enable this feature by adding the option
3377: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.76 rillig 3378: <code class="filename">/etc/mk.conf</code>. If, during a fetch step, an incomplete
1.75 rillig 3379: distfile is found, pkgsrc will try to resume it.</p>
3380: <p>You can also
3381: 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
3382: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3383: <code class="varname">FETCH_RESUME_ARGS</code> and
3384: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3385: values.</p>
3386: <p>For example, if you want to use
1.76 rillig 3387: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75 rillig 3388: like:</p>
3389: <pre class="programlisting">
3390: FETCH_CMD= wget
3391: FETCH_BEFORE_ARGS= --passive-ftp
3392: FETCH_RESUME_ARGS= -c
3393: FETCH_OUTPUT_ARGS= -O
1.1 grant 3394: </pre>
1.75 rillig 3395: </div>
3396: <div class="sect1" lang="en">
3397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3398: <a name="XFree86-from-pkgsrc"></a>8.6. How can I install/use XFree86 from pkgsrc?</h2></div></div></div>
1.75 rillig 3399: <p>If you want to use XFree86 from pkgsrc instead of your system's own
1.76 rillig 3400: X11 (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>,
1.75 rillig 3401: ...), you will have to add the following line into
1.76 rillig 3402: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3403: <pre class="programlisting">
3404: X11_TYPE=XFree86
1.1 grant 3405: </pre>
1.75 rillig 3406: </div>
3407: <div class="sect1" lang="en">
3408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3409: <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 3410: <p>If you want to use X.org from pkgsrc instead of your system's own X11
1.76 rillig 3411: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3412: you will have to add the following line into
1.76 rillig 3413: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3414: <pre class="programlisting">
3415: X11_TYPE=xorg
1.1 grant 3416: </pre>
1.75 rillig 3417: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3418: <h3 class="title">Note</h3>
3419: <p>The DragonFly operating system defaults to using
1.87 wiz 3420: this X.org X11 implementation from pkgsrc.</p>
1.75 rillig 3421: </div>
3422: </div>
3423: <div class="sect1" lang="en">
3424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3425: <a name="fetch-behind-firewall"></a>8.8. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3426: <p>If you are sitting behind a firewall which does not allow direct
3427: connections to Internet hosts (i.e. non-NAT), you may specify the
3428: relevant proxy hosts. This is done using an environment variable in the
3429: form of a URL, e.g. in Amdahl, the machine
3430: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3431: port 80 as the proxy port number. So the proxy environment variables
3432: are:</p>
3433: <pre class="programlisting">
3434: ftp_proxy=ftp://orpheus.amdahl.com:80/
3435: http_proxy=http://orpheus.amdahl.com:80/
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="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 3441: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3442: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3443: the first available command from the following list:</p>
3444: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3445: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3446: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3447: </ul></div>
3448: <p>On a default NetBSD installation, this will be
1.76 rillig 3449: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3450: connections first, and falls back to active connections if the server
3451: refuses to do passive. For the other tools, add the following to your
1.76 rillig 3452: <code class="filename">/etc/mk.conf</code> file:
1.75 rillig 3453: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3454: <p>Having that option present will prevent
1.76 rillig 3455: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3456: transfers.</p>
3457: </div>
3458: <div class="sect1" lang="en">
3459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3460: <a name="fetching-all-distfiles"></a>8.10. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3461: <p>You would like to download all the distfiles in a single batch
3462: from work or university, where you can't run a <span><strong class="command">make
3463: 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 3464: but downloading the entire directory may not be appropriate.</p>
3465: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76 rillig 3466: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3467: resulting list to your machine at work/school and use it there. If you
3468: 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
3469: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3470: URL:</p>
3471: <p>At home:</p>
3472: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3473: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3474: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3475: <p>At work:</p>
3476: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3477: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3478: home.</p>
3479: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3480: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3481: machine architecture), you can do so by using the above-mentioned
3482: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
3483: directly by running:</p>
1.75 rillig 3484: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3485: <p>If you even decide to ignore
3486: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3487: by running:</p>
3488: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3489: </div>
3490: <div class="sect1" lang="en">
3491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3492: <a name="tmac.andoc-missing"></a>8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 3493: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 rillig 3494: <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 3495: package, you get the error from make that it doesn't know how to make
1.76 rillig 3496: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3497: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3498: the NetBSD base distribution on your machine. It is recommended to do
3499: that to format man pages.</p>
1.91 rillig 3500: <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 3501: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.76 rillig 3502: environment or in <code class="filename">/etc/mk.conf</code>.</p>
1.75 rillig 3503: </div>
3504: <div class="sect1" lang="en">
3505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3506: <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 3507: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3508: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3509: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3510: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3511: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3512: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.75 rillig 3513: the one that corresponds to your release (determine via <span><strong class="command">uname
3514: -r</strong></span>).</p>
3515: </div>
3516: <div class="sect1" lang="en">
3517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3518: <a name="using-sudo-with-pkgsrc"></a>8.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3519: <p>When installing packages as non-root user and using the just-in-time
3520: <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
3521: password for each required package installed. To avoid this, the sudo
3522: package can be used, which does password caching over a limited time. To
3523: use it, install sudo (either as binary package or from
1.91 rillig 3524: <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 following
1.76 rillig 3525: into your <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3526: <pre class="programlisting">
3527: .if exists(${LOCALBASE}/bin/sudo)
3528: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3529: .endif
1.1 grant 3530: </pre>
1.75 rillig 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="faq.conf"></a>8.14. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3535: <p>As the system administrator, you can choose where configuration files
3536: are installed. The default settings make all these files go into
1.76 rillig 3537: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3538: be suboptimal depending on your expectations (e.g., a read-only,
3539: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3540: configuration of the provided packages).</p>
3541: <p>In order to change the defaults, you can modify the
3542: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.76 rillig 3543: <code class="filename">/etc/mk.conf</code>) to point to your preferred configuration
3544: directory; some common examples include <code class="filename">/etc</code> or
3545: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3546: <p>Furthermore, you can change this value on a per-package basis by
3547: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3548: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3549: package you would like to modify, that is, the contents of
3550: <code class="varname">PKGBASE</code>.</p>
3551: <p>Note that after changing these settings, you must rebuild and
3552: reinstall any affected packages.</p>
3553: </div>
3554: <div class="sect1" lang="en">
3555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3556: <a name="audit-packages"></a>8.15. Automated security checks</h2></div></div></div>
1.75 rillig 3557: <p>Please be aware that there can often be bugs in third-party software,
3558: and some of these bugs can leave a machine vulnerable to exploitation by
3559: attackers. In an effort to lessen the exposure, the NetBSD packages team
3560: maintains a database of known-exploits to packages which have at one time
3561: been included in pkgsrc. The database can be downloaded automatically, and
3562: a security audit of all packages installed on a system can take place. To
1.91 rillig 3563: 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 3564: components:</p>
3565: <div class="orderedlist"><ol type="1">
3566: <li>
3567: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
3568: download a list of the security vulnerabilities information. This list
3569: is kept up to date by the NetBSD security officer and the NetBSD
3570: packages team, and is distributed from the NetBSD ftp server:</p>
3571: <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>
3572: </li>
3573: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
3574: current machine, checking each vulnerability which is known. If a
3575: vulnerable package is installed, it will be shown by output to stdout,
3576: including a description of the type of vulnerability, and a URL
3577: containing more information.</p></li>
3578: </ol></div>
1.91 rillig 3579: <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 3580: package is strongly recommended! After
3581: “<span class="quote">audit-packages</span>” is installed, please read
3582: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3583: audit-packages</code></strong>.</p>
1.87 wiz 3584: <p>If this package is installed, pkgsrc builds will use it to
3585: 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
3586: check.</p>
1.75 rillig 3587: </div>
3588: <div class="sect1" lang="en">
3589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3590: <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 3591: <p>When you add your own preferences to the
3592: <code class="varname">CFLAGS</code> variable in your
1.76 rillig 3593: <code class="filename">mk.conf</code>, these flags are passed in
3594: environment variables to the <code class="filename">./configure</code>
1.75 rillig 3595: 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
3596: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3597: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3598: package.</p>
3599: <p>Currently there is no solution to this problem. If you
3600: really need the package to use your <code class="varname">CFLAGS</code>
3601: you should run <span><strong class="command">make patch</strong></span> in the package
1.76 rillig 3602: directory and then inspect any <code class="filename">Makefile</code> and
3603: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3604: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3605: these lines. But be aware that some “<span class="quote">smart</span>”
3606: programmers write so bad code that it only works for the
3607: specific combination of <code class="varname">CFLAGS</code> they have
3608: chosen.</p>
3609: </div>
1.80 rillig 3610: <div class="sect1" lang="en">
3611: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3612: <a name="ufaq-fail"></a>8.17. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3613: <div class="procedure"><ol type="1">
3614: <li><p>Make sure that your copy of pkgsrc is consistent. A
3615: case that occurs often is that people only update pkgsrc in
3616: parts, because of performance reasons. Since pkgsrc is one large
3617: system, not a collection of many small systems, there are
3618: sometimes changes that only work when the whole pkgsrc tree is
3619: updated.</p></li>
3620: <li><p>Make sure that you don't have any CVS conflicts.
3621: Search for “<span class="quote"><<<<<<</span>” or
3622: “<span class="quote">>>>>>></span>” in all your pkgsrc
3623: files.</p></li>
3624: <li><p>Make sure that you don't have old copies of the packages
3625: extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
3626: verify this.</p></li>
3627: <li><p>If the problem still exists, write a mail to the
3628: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3629: </ol></div>
3630: </div>
1.88 wiz 3631: <div class="sect1" lang="en">
3632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3633: <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 3634: <p>You have modified a file from pkgsrc, and someone else has
3635: modified that same file afterwards in the CVS repository. Both changes
3636: are in the same region of the file, so when you updated pkgsrc, the
3637: <code class="literal">cvs</code> command marked the conflicting changes in the
3638: file. Because of these markers, the file is no longer a valid
3639: <code class="filename">Makefile</code>.</p>
3640: <p>Have a look at that file, and if you don't need your local changes
3641: anymore, you can remove that file and run <span><strong class="command">cvs -q update
3642: -dP</strong></span> in that directory to download the current version.</p>
3643: </div>
1.75 rillig 3644: </div>
3645: </div>
3646: <div class="part" lang="en">
3647: <div class="titlepage"><div><div><h1 class="title">
3648: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3649: <div class="partintro" lang="en">
3650: <div></div>
3651: <p>This part of the book deals with creating and
3652: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3653: guide on creating a new package. The remaining chapters are more
3654: like a reference manual for pkgsrc.</p>
1.75 rillig 3655: <div class="toc">
3656: <p><b>Table of Contents</b></p>
3657: <dl>
1.90 rillig 3658: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3659: <dd><dl>
3660: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3661: <dd><dl>
3662: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3663: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3664: </dl></dd>
3665: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3666: <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>
3667: </dl></dd>
1.90 rillig 3668: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 3669: <dd><dl>
1.90 rillig 3670: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
3671: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
3672: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
3673: <dd><dl>
1.93 rillig 3674: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
3675: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
3676: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
3677: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
3678: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 3679: </dl></dd>
3680: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
3681: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
3682: <dd><dl>
3683: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
3684: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
3685: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
3686: </dl></dd>
3687: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
3688: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
3689: </dl></dd>
3690: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3691: <dd><dl>
3692: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
3693: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
3694: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
3695: <dd><dl>
3696: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
3697: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
3698: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
3699: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
3700: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
3701: </dl></dd>
3702: </dl></dd>
3703: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
3704: <dd><dl>
3705: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
3706: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3707: <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>
3708: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
3709: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
3710: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3711: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
3712: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
3713: </dl></dd>
3714: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
3715: <dd><dl>
3716: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
3717: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3718: <dd><dl>
3719: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3720: <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>
3721: </dl></dd>
3722: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3723: <dd><dl>
3724: <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>
3725: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3726: </dl></dd>
3727: </dl></dd>
3728: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
3729: <dd><dl>
3730: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
3731: <dd><dl>
3732: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
3733: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
3734: </dl></dd>
3735: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
3736: <dd><dl>
3737: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3738: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
3739: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
3740: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
3741: </dl></dd>
3742: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
3743: <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>
3744: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
3745: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
3746: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
3747: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
3748: <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>
3749: </dl></dd>
3750: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
3751: <dd><dl>
3752: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
3753: <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>
3754: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
3755: </dl></dd>
3756: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
3757: <dd><dl>
3758: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
3759: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
3760: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
3761: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
3762: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3763: <dd><dl>
3764: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
3765: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
3766: </dl></dd>
3767: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3768: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3769: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3770: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3771: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3772: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3773: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3774: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3775: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3776: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3777: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
3778: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
3779: </dl></dd>
3780: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
3781: <dd><dl>
3782: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3783: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3784: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3785: </dl></dd>
3786: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
3787: <dd><dl>
3788: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
3789: <dd><dl>
3790: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
3791: <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>
3792: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
3793: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
3794: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
3795: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
3796: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
3797: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
3798: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
3799: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
3800: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3801: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3802: </dl></dd>
3803: <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>
3804: <dd><dl>
3805: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3806: <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>
3807: </dl></dd>
3808: <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>
3809: <dd><dl>
3810: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
3811: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3812: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
3813: </dl></dd>
3814: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
3815: <dd><dl>
3816: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
3817: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
3818: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
3819: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
3820: </dl></dd>
3821: <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>
3822: <dd><dl>
3823: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
3824: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
3825: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3826: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
3827: </dl></dd>
3828: <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>
3829: <dd><dl>
3830: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
3831: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
3832: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
3833: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
3834: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
3835: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
3836: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
3837: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
3838: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
3839: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
3840: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
3841: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
3842: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
3843: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
3844: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
3845: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
3846: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 3847: emulation</a></span></dt>
1.90 rillig 3848: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
3849: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77 rillig 3850: </dl></dd>
1.90 rillig 3851: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3852: </dl></dd>
1.90 rillig 3853: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
3854: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 3855: <dd><dl>
1.90 rillig 3856: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
3857: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3858: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
3859: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
3860: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
3861: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
3862: </dl></dd>
3863: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
3864: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3865: <dd><dl>
3866: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3867: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3868: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3869: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 3870: </dl></dd>
1.75 rillig 3871: </dl>
3872: </div>
1.77 rillig 3873: </div>
3874: <div class="chapter" lang="en">
3875: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3876: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3877: <div class="toc">
3878: <p><b>Table of Contents</b></p>
3879: <dl>
3880: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3881: <dd><dl>
3882: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3883: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3884: </dl></dd>
3885: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3886: <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>
3887: </dl>
3888: </div>
1.77 rillig 3889: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3890: most likely have a URL from where you can download the source
3891: code. Starting with this URL, creating a package involves only a
3892: few steps.</p>
1.77 rillig 3893: <div class="procedure"><ol type="1">
1.91 rillig 3894: <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 3895: <li><p>Then, choose one of the top-level directories as the
1.91 rillig 3896: category in which you want to place your package. You can also create a
3897: directory of your own (maybe called <code class="filename">local</code>). In that
3898: category directory, create another directory for your package and change
3899: into it.</p></li>
3900: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
3901: you for a URL. Enter the URL of the distribution file (in most cases a
3902: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3903: of your package are created automatically. The distribution file is
3904: extracted automatically to fill in some details in the
3905: <code class="filename">Makefile</code> that would otherwise have to be done
3906: manually.</p></li>
3907: <li>
3908: <p>Examine the extracted files to determine the dependencies of
3909: your package. Ideally, this is mentioned in some
3910: <code class="filename">README</code> file, but things may differ. For each of
3911: these dependencies, look where it exists in pkgsrc, and if there is a
3912: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3913: line to your package <code class="filename">Makefile</code> which includes that
3914: file just before the last line. If the
3915: <code class="filename">buildlink3.mk</code> file does not exist, add a
3916: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3917: version of the dependency and where it can be found in pkgsrc. This line
3918: should be placed in the third paragraph. If the dependency is only
3919: needed for building the package, but not when using it, use
3920: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3921: Your package may then look like this:</p>
1.77 rillig 3922: <pre class="programlisting">
3923: [...]
3924:
3925: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3926: DEPENDS+= screen-[0-9]*:../../misc/screen
3927: DEPENDS+= screen>=4.0:../../misc/screen
3928:
3929: [...]
3930:
3931: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3932: .include "../../devel/glib2/buildlink3.mk"
3933: .include "../../mk/bsd.pkg.mk"
3934: </pre>
3935: </li>
1.91 rillig 3936: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
3937: to be done to make your package a “<span class="quote">good</span>” one. If you don't
3938: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
3939: --explain</strong></span> or <span><strong class="command">pkglint
3940: -e</strong></span>, which outputs additional
3941: explanations.</p></li>
3942: <li><p>In many cases the package is not yet ready to build. You can
3943: 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
3944: over there, you can hopefully continue here.</p></li>
3945: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
3946: directory from the extracted files. Besides these files, a lot of cache
3947: files and other system information has been saved in the working
3948: directory, which may become wrong after you edited the
3949: <code class="filename">Makefile</code>.</p></li>
3950: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
3951: 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>
3952: <li><p>When the package builds fine, the next step is to install
3953: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
3954: everything works.</p></li>
3955: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
3956: contains a list of the files that are installed by the package, is
3957: nearly empty. Run <span><strong class="command">bmake print-PLIST
3958: >PLIST</strong></span> to generate a probably correct list. Check
3959: the file using your preferred text editor to see if the list of
3960: files looks plausible.</p></li>
3961: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
3962: <code class="filename">PLIST</code> contains garbage or not.</p></li>
3963: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
3964: has been registered in the database of installed files, but with an
3965: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
3966: and <span><strong class="command">bmake install</strong></span> again. Now the package is
3967: registered with the list of files from
3968: <code class="filename">PLIST</code>.</p></li>
3969: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
3970: package from the set of installed files.</p></li>
1.77 rillig 3971: </ol></div>
1.91 rillig 3972: <div class="sect1" lang="en">
3973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3974: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
3975: <div class="sect2" lang="en">
3976: <div class="titlepage"><div><div><h3 class="title">
3977: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
3978: <p>Simple Perl modules are handled automatically by
3979: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
3980: </div>
3981: <div class="sect2" lang="en">
3982: <div class="titlepage"><div><div><h3 class="title">
3983: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
3984: <p>KDE applications should always include
3985: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3986: settings that are typical of KDE packages.</p>
3987: </div>
3988: </div>
3989: <div class="sect1" lang="en">
3990: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3991: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
3992: <div class="sect2" lang="en">
3993: <div class="titlepage"><div><div><h3 class="title">
3994: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
3995: <div class="sect3" lang="en">
3996: <div class="titlepage"><div><div><h4 class="title">
3997: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
3998: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
3999: that the “<span class="quote">nvu</span>” package has not yet been imported into
4000: pkgsrc. As the description says it has to do with the web, the obvious
4001: choice for the category is “<span class="quote">www</span>”.</p>
4002: <pre class="programlisting">
4003: <code class="prompt">$</code> mkdir www/nvu
4004: <code class="prompt">$</code> cd www/nvu
4005: </pre>
4006: <p>The web site says that the sources are available as a tar file, so
4007: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
4008: <pre class="programlisting">
4009: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4010: </pre>
4011: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4012: below the <code class="varname">DISTNAME</code> line, as the package name should
4013: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4014: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4015: <code class="varname">COMMENT</code> fields. Then the package
4016: <code class="filename">Makefile</code> looked like that:</p>
4017: <pre class="programlisting">
4018: # $NetBSD$
4019: #
4020:
4021: DISTNAME= nvu-1.0-sources
4022: PKGNAME= nvu-1.0
4023: CATEGORIES= www
4024: MASTER_SITES= http://cvs.nvu.com/download/
4025: EXTRACT_SUFX= .tar.bz2
4026:
4027: MAINTAINER= rillig@NetBSD.org
4028: HOMEPAGE= http://cvs.nvu.com/
4029: COMMENT= Web Authoring System
4030:
4031: # url2pkg-marker (please do not remove this line.)
4032: .include "../../mk/bsd.pkg.mk"
4033: </pre>
4034: <p>Then, I quit the editor and watched pkgsrc downloading a large
4035: source archive:</p>
4036: <pre class="programlisting">
4037: url2pkg> Running "make makesum" ...
4038: => Required installed package digest>=20010302: digest-20060826 found
4039: => Fetching nvu-1.0-sources.tar.bz2
4040: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4041: 100% |*************************************| 28992 KB 150.77 KB/s 00:00 ETA
4042: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4043: url2pkg> Running "make extract" ...
4044: => Required installed package digest>=20010302: digest-20060826 found
4045: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4046: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4047: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4048: ===> Installing dependencies for nvu-1.0
4049: ===> Overriding tools for nvu-1.0
4050: ===> Extracting for nvu-1.0
4051: url2pkg> Adjusting the Makefile.
4052:
4053: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
4054:
4055: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
4056: </pre>
4057: </div>
4058: <div class="sect3" lang="en">
4059: <div class="titlepage"><div><div><h4 class="title">
4060: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
4061: <p>Now that the package has been extracted, let's see what's inside
4062: it. The package has a <code class="filename">README.txt</code>, but that only
4063: says something about mozilla, so it's probably useless for seeing what
4064: dependencies this package has. But since there is a GNU configure script
4065: in the package, let's hope that it will complain about everything it
4066: needs.</p>
4067: <pre class="programlisting">
4068: <code class="prompt">$</code> bmake
4069: => Required installed package digest>=20010302: digest-20060826 found
4070: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4071: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4072: ===> Patching for nvu-1.0
4073: ===> Creating toolchain wrappers for nvu-1.0
4074: ===> Configuring for nvu-1.0
4075: [...]
4076: configure: error: Perl 5.004 or higher is required.
4077: [...]
4078: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4079: [...]
4080: </pre>
4081: <p>That worked quite well. So I opened the package Makefile in my
4082: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4083: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4084: package have changed now, and since a perl wrapper is automatically
4085: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4086: from scratch.</p>
4087: <pre class="programlisting">
4088: <code class="prompt">$</code> bmake clean
4089: ===> Cleaning for nvu-1.0
4090: <code class="prompt">$</code> bmake
4091: [...]
4092: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4093: GNU Make. You will not be able to build Mozilla without GNU Make.
4094: [...]
4095: </pre>
4096: <p>So I added “<span class="quote">gmake</span>” to the
4097: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4098: <pre class="programlisting">
4099: [...]
4100: checking for GTK - version >= 1.2.0... no
4101: *** Could not run GTK test program, checking why...
4102: [...]
4103: </pre>
4104: <p>Now to the other dependencies. The first question is: Where is the
4105: GTK package hidden in pkgsrc?</p>
4106: <pre class="programlisting">
4107: <code class="prompt">$</code> echo ../../*/gtk*
4108: [many packages ...]
4109: <code class="prompt">$</code> echo ../../*/gtk
4110: ../../x11/gtk
4111: <code class="prompt">$</code> echo ../../*/gtk2
4112: ../../x11/gtk2
4113: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4114: ../../x11/gtk2/buildlink3.mk
4115: </pre>
4116: <p>The first try was definitely too broad. The second one had exactly
4117: one result, which is very good. But there is one pitfall with GNOME
4118: packages. Before GNOME 2 had been released, there were already many
4119: GNOME 1 packages in pkgsrc. To be able to continue to use these
4120: packages, the GNOME 2 packages were imported as separate packages, and
4121: their names usually have a “<span class="quote">2</span>” appended. So I checked
4122: whether this was the case here, and indeed it was.</p>
4123: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4124: file, adding the dependency is very easy. I just inserted an
4125: <code class="literal">.include</code> line before the last line of the package
4126: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4127: <pre class="programlisting">
4128: [...]
4129: .include "../../x11/gtk2/buildlink3.mk"
4130: .include "../../mk/bsd.pkg.mk
4131: </pre>
4132: <p>After another <span><strong class="command">bmake clean && bmake</strong></span>, the answer
4133: was:</p>
4134: <pre class="programlisting">
4135: [...]
4136: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4137: checking for GTK - version >= 1.2.0... no
4138: *** Could not run GTK test program, checking why...
4139: *** The test program failed to compile or link. See the file config.log for the
4140: *** exact error that occured. This usually means GTK was incorrectly installed
4141: *** or that you have moved GTK since it was installed. In the latter case, you
4142: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4143: configure: error: Test for GTK failed.
4144: [...]
4145: </pre>
4146: <p>In this particular case, the assumption that “<span class="quote">every package
4147: prefers GNOME 2</span>” had been wrong. The first of the lines above
4148: told me that this package really wanted to have the GNOME 1 version of
4149: GTK. If the package had looked for GTK2, it would have looked for
4150: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
4151: So I changed the <code class="literal">x11/gtk2</code> to
4152: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4153: and tried again.</p>
4154: <pre class="programlisting">
4155: [...]
4156: 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
4157: In file included from xpidl.c:42:
4158: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4159: In file included from xpidl.c:42:
4160: xpidl.h:132: error: parse error before "IDL_ns"
4161: [...]
4162: </pre>
4163: <p>The package still does not find all of its dependencies. Now the
4164: question is: Which package provides the
4165: <code class="filename">libIDL/IDL.h</code> header file?</p>
4166: <pre class="programlisting">
4167: <code class="prompt">$</code> echo ../../*/*idl*
4168: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4169: <code class="prompt">$</code> echo ../../*/*IDL*
4170: ../../net/libIDL
4171: </pre>
4172: <p>Let's take the one from the second try. So I included the
4173: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4174: again. But the error didn't change. After digging through some of the
4175: code, I concluded that the build process of the package was broken and
4176: couldn't have ever worked, but since the Mozilla source tree is quite
4177: large, I didn't want to fix it. So I added the following to the package
4178: <code class="filename">Makefile</code> and tried again:</p>
4179: <pre class="programlisting">
4180: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4181: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
4182: </pre>
4183: <p>The latter line is needed because the package expects the library
4184: <code class="filename">libIDL.so</code>, but only
4185: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4186: wrapper to rewrite that on the fly.</p>
4187: <p>The next problem was related to a recent change of the FreeType
4188: 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>
4189: which patch files were relevant for this issue and copied them to the
4190: <code class="filename">patches</code> directory. Then I retried, fixed the
4191: patches so that they applied cleanly and retried again. This time,
4192: everything worked.</p>
4193: </div>
4194: <div class="sect3" lang="en">
4195: <div class="titlepage"><div><div><h4 class="title">
4196: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
4197: <pre class="programlisting">
4198: <code class="prompt">$</code> bmake CHECK_FILES=no install
4199: [...]
4200: <code class="prompt">$</code> bmake print-PLIST >PLIST
4201: <code class="prompt">$</code> bmake deinstall
4202: <code class="prompt">$</code> bmake install
4203: </pre>
4204: </div>
4205: </div>
4206: </div>
1.77 rillig 4207: </div>
1.75 rillig 4208: <div class="chapter" lang="en">
4209: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4210: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4211: <div class="toc">
4212: <p><b>Table of Contents</b></p>
4213: <dl>
1.90 rillig 4214: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
4215: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
4216: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
4217: <dd><dl>
1.93 rillig 4218: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
4219: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
4220: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
4221: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
4222: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 4223: </dl></dd>
4224: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
4225: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
4226: <dd><dl>
4227: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
4228: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
4229: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4230: </dl></dd>
1.90 rillig 4231: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
4232: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4233: </dl>
4234: </div>
1.87 wiz 4235: <p>Whenever you're preparing a package, there are a number of
4236: files involved which are described in the following
4237: sections.</p>
1.75 rillig 4238: <div class="sect1" lang="en">
4239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4240: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code>
4241: </h2></div></div></div>
1.75 rillig 4242: <p>Building, installation and creation of a binary package are all
1.87 wiz 4243: controlled by the package's <code class="filename">Makefile</code>.
4244: The <code class="filename">Makefile</code> describes various things about
4245: a package, for example from where to get it, how to configure,
4246: build, and install it.</p>
1.76 rillig 4247: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4248: sections that describe the package.</p>
1.75 rillig 4249: <p>In the first section there are the following variables, which
1.87 wiz 4250: should appear exactly in the order given here. The order and
4251: grouping of the variables is mostly historical and has no further
4252: meaning.</p>
1.75 rillig 4253: <div class="itemizedlist"><ul type="disc">
4254: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4255: distribution file to be downloaded from the package's
4256: website.</p></li>
1.75 rillig 4257: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4258: package, as used by pkgsrc. You only need to provide it if
4259: <code class="varname">DISTNAME</code> (which is the default) is not a good
4260: name for the package in pkgsrc. Usually it is the pkgsrc
4261: directory name together with the version number. It must match the
4262: regular expression
4263: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4264: starts with a letter or digit, and contains only letters, digits,
4265: dashes, underscores, dots and plus signs.</p></li>
4266: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4267: the package file to create if the <code class="varname">PKGNAME</code>
4268: isn't unique on a SVR4 system. The default is
4269: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4270: <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 4271: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4272: does not produce an unique package name on a SVR4 system.
4273: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4274: characters.</p></li>
1.75 rillig 4275: <li>
4276: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4277: which the package fits in. You can choose any of the top-level
4278: directories of pkgsrc for it.</p>
1.75 rillig 4279: <p>Currently the following values are available for
1.87 wiz 4280: <code class="varname">CATEGORIES</code>. If more than
4281: one is used, they need to be separated by spaces:</p>
1.75 rillig 4282: <pre class="programlisting">
1.87 wiz 4283: archivers cross geography meta-pkgs security
4284: audio databases graphics misc shells
4285: benchmarks devel ham multimedia sysutils
4286: biology editors inputmethod net textproc
4287: cad emulators lang news time
4288: chat finance mail parallel wm
4289: comms fonts math pkgtools www
4290: converters games mbone print x11
4291: </pre>
1.75 rillig 4292: </li>
1.81 rillig 4293: <li><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4294: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4295: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4296: and <code class="varname">DISTFILES</code> are discussed in detail in
1.90 rillig 4297: <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 4298: </ul></div>
4299: <p>The second section contains information about separately
1.87 wiz 4300: downloaded patches, if any.
4301: </p>
1.75 rillig 4302: <div class="itemizedlist"><ul type="disc">
4303: <li><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4304: Name(s) of additional files that contain distribution patches.
4305: There is no default. pkgsrc will look for them at
4306: <code class="varname">PATCH_SITES</code>.
4307: They will automatically be uncompressed before patching if
4308: the names end with <code class="filename">.gz</code> or
4309: <code class="filename">.Z</code>.</p></li>
1.75 rillig 4310: <li><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4311: Primary location(s) for distribution patch files (see
4312: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4313: </ul></div>
4314: <p>The third section contains the following variables.
1.87 wiz 4315: </p>
1.75 rillig 4316: <div class="itemizedlist"><ul type="disc">
4317: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87 wiz 4318: of the person who feels responsible for this package, and who is
4319: most likely to look at problems or questions regarding this
4320: 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
4321: developers should contact the <code class="varname">MAINTAINER</code> before
4322: making major changes to the package. When packaging a new program,
4323: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4324: maintain the package for future updates, set it to
4325: <code class="email"><<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.75 rillig 4326: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4327: find more information about the package.</p></li>
1.75 rillig 4328: <li><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4329: description of the package (should not include the package
4330: name).</p></li>
1.75 rillig 4331: </ul></div>
4332: <p>Other variables that affect the build:
1.87 wiz 4333: </p>
1.75 rillig 4334: <div class="itemizedlist"><ul type="disc"><li>
4335: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4336: interesting distribution files of the package are found. The
4337: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4338: works for most packages.</p>
1.75 rillig 4339: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4340: (most GNU software does, for instance), but extracts itself in
4341: the current directory, you should set
4342: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4343: <p>If a package doesn't create a subdirectory with the
4344: name of <code class="varname">DISTNAME</code> but some different name,
4345: set <code class="varname">WRKSRC</code> to point to the proper name in
4346: <code class="filename">${WRKDIR}</code>, for example
4347: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4348: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75 rillig 4349: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4350: taken from the <code class="varname">WRKDIR_BASENAME</code>
4351: variable. By default, its value is
4352: <code class="filename">work</code>. If you want to use the same
4353: pkgsrc tree for building different kinds of binary packages,
4354: you can change the variable according to your needs. Two
4355: other variables handle common cases of setting
4356: <code class="varname">WRKDIR_BASENAME</code> individually. If
4357: <code class="varname">OBJHOSTNAME</code> is defined in
4358: <code class="filename">/etc/mk.conf</code>, the first component of
4359: the host's name is attached to the directory name. If
4360: <code class="varname">OBJMACHINE</code> is defined, the platform name
4361: is attached, which might look like
4362: <code class="filename">work.i386</code> or
4363: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4364: </li></ul></div>
4365: <p>Please pay attention to the following gotchas:</p>
4366: <div class="itemizedlist"><ul type="disc">
1.87 wiz 4367: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4368: installed in compressed form by the package. For packages using
4369: BSD-style makefiles which honor MANZ, there is
4370: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76 rillig 4371: <li><p>Replace <code class="filename">/usr/local</code> with
1.88 wiz 4372: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4373: below).</p></li>
1.90 rillig 4374: <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 4375: </ul></div>
4376: </div>
4377: <div class="sect1" lang="en">
4378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4379: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code>
4380: </h2></div></div></div>
1.76 rillig 4381: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4382: digest, or checksum, of each distfile needed for the package. This
4383: ensures that the distfiles retrieved from the Internet have not been
4384: corrupted during transfer or altered by a malign force to introduce
4385: a security hole. Due to recent rumor about weaknesses of digest
4386: algorithms, all distfiles are protected using both SHA1 and RMD160
4387: message digests, as well as the file size.</p>
1.76 rillig 4388: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4389: checksums for all the patches found in the
1.90 rillig 4390: <code class="filename">patches</code> directory (see <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a>).</p>
1.76 rillig 4391: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87 wiz 4392: <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
4393: command.</p>
1.75 rillig 4394: <p>Some packages have different sets of distfiles depending on
1.91 rillig 4395: 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 4396: <code class="filename">distinfo</code> file and care should be taken when
4397: upgrading such a package to ensure distfile information is not
4398: lost.</p>
1.75 rillig 4399: </div>
4400: <div class="sect1" lang="en">
4401: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4402: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.93 rillig 4403: <p>Many packages still don't work out-of-the box on the various
4404: platforms that are supported by pkgsrc. Therefore, a number of custom
4405: patch files are needed to make the package work. These patch files are
4406: found in the <code class="filename">patches/</code> directory.</p>
4407: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4408: applied to the files in <code class="varname">WRKSRC</code> directory after
4409: extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
4410: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4411: <code class="filename">patch-ab</code>, etc.</p>
1.93 rillig 4412: <div class="sect2" lang="en">
4413: <div class="titlepage"><div><div><h3 class="title">
4414: <a name="components.patch.structure"></a>10.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4415: <p>The <code class="filename">patch-*</code> files should be in
1.87 wiz 4416: <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4417: problems. (To force patches to apply with fuzz you can set
4418: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4419: should contain only changes for a single file, and no file should be
1.93 rillig 4420: patched by more than one patch file. This helps to keep future
4421: modifications simple.</p>
4422: <p>Each patch file is structured as follows: In the first line,
4423: there is the RCS Id of the patch itself. The second line should be
4424: empty for aesthetic reasons. After that, there should be a comment for
4425: each change that the patch does. There are a number of standard
4426: cases:</p>
4427: <div class="itemizedlist"><ul type="disc">
4428: <li><p>Patches that replace the <code class="literal">==</code>
4429: 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
4430: should contain a reference to , to avoid
4431: redundant explanations.</p></li>
4432: <li><p>Patches for commonly known vulnerabilities should
4433: mention the vulnerability ID (CAN, CVE).</p></li>
4434: <li><p>Patches that change source code should mention the
4435: platform and other environment (for example, the compiler) that the
4436: patch is needed for.</p></li>
4437: </ul></div>
4438: <p>In all other cases, the patch should be commented so that any
4439: developer who knows the code of the application can make some use of
4440: the patch. Special care should be taken for the upstream developers,
4441: since we generally want that they accept our patches, so we have less
4442: work in the future.</p>
4443: </div>
4444: <div class="sect2" lang="en">
4445: <div class="titlepage"><div><div><h3 class="title">
4446: <a name="components.patches.caveats"></a>10.3.2. Creating patch files</h3></div></div></div>
4447: <p>One important thing to mention is to pay attention that no RCS
4448: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4449: later checked into the NetBSD CVS tree. Use the
1.93 rillig 4450: <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
4451: problems.</p>
1.87 wiz 4452: <p>For even more automation, we recommend using
4453: <span><strong class="command">mkpatches</strong></span> from the same package to make a
4454: whole set of patches. You just have to backup files before you
4455: edit them to <code class="filename">filename.orig</code>, e.g. with
4456: <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
4457: using <span><strong class="command">pkgvi</strong></span> again from the same package. If
4458: you upgrade a package this way, you can easily compare the new
4459: set of patches with the previously existing one with
4460: <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
4461: or update from the <code class="filename">work/.newpatches</code>
4462: directory to <code class="filename">patches/</code>.</p>
4463: <p>When you have finished a package, remember to generate
4464: the checksums for the patch files by using the <span><strong class="command">make
1.90 rillig 4465: 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 4466: <p>When adding a patch that corrects a problem in the
4467: distfile (rather than e.g. enforcing pkgsrc's view of where
4468: man pages should go), send the patch as a bug report to the
4469: maintainer. This benefits non-pkgsrc users of the package,
4470: and usually makes it possible to remove the patch in future
4471: version.</p>
1.93 rillig 4472: </div>
4473: <div class="sect2" lang="en">
4474: <div class="titlepage"><div><div><h3 class="title">
4475: <a name="components.patches.sources"></a>10.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4476: <p>If you want to share patches between multiple packages
4477: in pkgsrc, e.g. because they use the same distfiles, set
4478: <code class="varname">PATCHDIR</code> to the path where the patch files
4479: can be found, e.g.:</p>
4480: <pre class="programlisting">
4481: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4482: </pre>
1.75 rillig 4483: <p>Patch files that are distributed by the author or other
1.87 wiz 4484: maintainers can be listed in
4485: <code class="varname">PATCHFILES</code>.</p>
4486: <p>If it is desired to store any patches that should not be
4487: committed into pkgsrc, they can be kept outside the pkgsrc
4488: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4489: directory tree there is expected to have the same
4490: “<span class="quote">category/package</span>” structure as pkgsrc, and
4491: patches are expected to be stored inside these dirs (also
4492: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4493: example, if you want to keep a private patch for
4494: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4495: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4496: files in the named directory are expected to be patch files,
4497: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4498: applied</em></span>.</p>
1.93 rillig 4499: </div>
1.85 jmmv 4500: <div class="sect2" lang="en">
4501: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 4502: <a name="components.patches.guidelines"></a>10.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4503: <p>When fixing a portability issue in the code do not use
4504: preprocessor magic to check for the current operating system nor
4505: platform. Doing so hurts portability to other platforms because
4506: the OS-specific details are not abstracted appropriately.</p>
4507: <p>The general rule to follow is: instead of checking for the
4508: operating system the application is being built on, check for the
4509: specific <span class="emphasis"><em>features</em></span> you need. For example,
4510: instead of assuming that kqueue is available under NetBSD and
4511: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.89 rillig 4512: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4513: yes, this generally involves patching the
4514: <span><strong class="command">configure</strong></span> script. There is absolutely nothing
4515: that prevents some OSes from adopting interfaces from other OSes
4516: (e.g. Linux implementing kqueue), something that the above checks
4517: cannot take into account.</p>
4518: <p>Of course, checking for features generally involves more
4519: work on the developer's side, but the resulting changes are
1.87 wiz 4520: cleaner and there are chances they will work on many other
1.85 jmmv 4521: platforms. Not to mention that there are higher chances of being
4522: later integrated into the mainstream sources. Remember:
4523: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4524: <p>Some typical examples:</p>
4525: <div class="table">
1.90 rillig 4526: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91 rillig 4527: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4528: <colgroup>
4529: <col>
4530: <col>
4531: <col>
4532: </colgroup>
4533: <thead><tr>
4534: <th>Where</th>
4535: <th>Incorrect</th>
4536: <th>Correct</th>
4537: </tr></thead>
4538: <tbody>
4539: <tr>
4540: <td>configure script</td>
4541: <td>
4542: <pre class="programlisting">case ${target_os} in
1.87 wiz 4543: netbsd*) have_kvm=yes ;;
4544: *) have_kvm=no ;;
4545: esac</pre>
1.85 jmmv 4546: </td>
4547: <td>
4548: <pre class="programlisting">AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)</pre>
4549: </td>
4550: </tr>
4551: <tr>
4552: <td>C source file</td>
4553: <td>
4554: <pre class="programlisting">#if defined(__NetBSD__)
1.87 wiz 4555: # include <sys/event.h>
4556: #endif</pre>
1.85 jmmv 4557: </td>
4558: <td>
4559: <pre class="programlisting">#if defined(HAVE_SYS_EVENT_H)
1.87 wiz 4560: # include <sys/event.h>
4561: #endif</pre>
1.85 jmmv 4562: </td>
4563: </tr>
4564: <tr>
4565: <td>C source file</td>
4566: <td>
4567: <pre class="programlisting">int
1.87 wiz 4568: monitor_file(...)
4569: {
4570: #if defined(__NetBSD__)
4571: int fd = kqueue();
4572: ...
4573: #else
4574: ...
4575: #endif
4576: }</pre>
1.85 jmmv 4577: </td>
4578: <td>
4579: <pre class="programlisting">int
1.87 wiz 4580: monitor_file(...)
4581: {
4582: #if defined(HAVE_KQUEUE)
4583: int fd = kqueue();
4584: ...
4585: #else
4586: ...
4587: #endif
4588: }</pre>
1.85 jmmv 4589: </td>
4590: </tr>
4591: </tbody>
1.91 rillig 4592: </table></div>
1.85 jmmv 4593: </div>
1.91 rillig 4594: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85 jmmv 4595: packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4596: 1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4597: 2</a>). It summarizes multiple details on how to make
4598: software easier to package; all the suggestions in it were
4599: collected from our experience in pkgsrc work, so they are possibly
4600: helpful when creating patches too.</p>
4601: </div>
4602: <div class="sect2" lang="en">
4603: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 4604: <a name="components.patches.feedback"></a>10.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4605: <p>Always, always, <span class="strong"><strong>always</strong></span>
4606: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4607: improvements you do to a package to the mainstream developers.
4608: This is the only way to get their attention on portability issues
4609: and to ensure that future versions can be built out-of-the box on
4610: NetBSD. Furthermore, any user that gets newer distfiles will get
4611: the fixes straight from the packaged code.</p>
1.93 rillig 4612: <p>This generally involves cleaning up the patches
4613: (because sometimes the patches that are
1.85 jmmv 4614: added to pkgsrc are quick hacks), filling bug reports in the
4615: appropriate trackers for the projects and working with the
4616: mainstream authors to accept your changes. It is
4617: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4618: the packages in pkgsrc are kept simple and thus further changes
4619: can be done without much hassle.</p>
4620: <p>Support the idea of free software!</p>
4621: </div>
1.75 rillig 4622: </div>
4623: <div class="sect1" lang="en">
4624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4625: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4626: <div class="variablelist"><dl>
1.76 rillig 4627: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4628: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4629: any credits where they are due. Please bear in mind that others do not
4630: share your sense of humour (or spelling idiosyncrasies), and that others
4631: will read everything that you write here.</p></dd>
1.76 rillig 4632: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4633: <dd><p>This file governs the files that are installed on your
4634: system: all the binaries, manual pages, etc. There are other
4635: directives which may be entered in this file, to control the
4636: creation and deletion of directories, and the location of
1.90 rillig 4637: inserted files. See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87 wiz 4638: information.</p></dd>
1.75 rillig 4639: </dl></div>
4640: </div>
4641: <div class="sect1" lang="en">
4642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4643: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78 rillig 4644: <div class="sect2" lang="en">
4645: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4646: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4647: <div class="variablelist"><dl>
1.76 rillig 4648: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75 rillig 4649: <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 4650: First time after package extraction and before files are
4651: moved in place, the second time after the files to install
4652: are moved in place. This can be used to do any custom
4653: procedures not possible with @exec commands in
4654: <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 4655: <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 4656: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4657: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4658: this script's responsibility to clean up any additional messy details
4659: around the package's installation, since all pkg_delete knows is how to
4660: delete the files created in the original distribution.
4661: 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>
4662: 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 4663: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4664: <dd>
4665: <p>This file is displayed after installation of the package.
1.87 wiz 4666: Useful for things like legal notices on almost-free
4667: software and hints for updating config files after
4668: installing modules for apache, PHP etc.
4669: Please note that you can modify variables in it easily by using
4670: <code class="varname">MESSAGE_SUBST</code> in the package's
4671: <code class="filename">Makefile</code>:</p>
1.75 rillig 4672: <pre class="programlisting">
1.87 wiz 4673: MESSAGE_SUBST+= SOMEVAR="somevalue"
4674: </pre>
1.75 rillig 4675: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4676: <code class="filename">MESSAGE</code>. By default, substitution is
4677: performed for <code class="varname">PKGNAME</code>,
4678: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4679: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4680: <code class="varname">X11BASE</code>,
4681: <code class="varname">PKG_SYSCONFDIR</code>,
4682: <code class="varname">ROOT_GROUP</code>, and
4683: <code class="varname">ROOT_GROUP</code>.</p>
4684: <p>You can display a different or additional files by
4685: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4686: default is <code class="filename">MESSAGE</code>, if the file
4687: exists.</p>
1.75 rillig 4688: </dd>
1.78 rillig 4689: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4690: <dd><p>FIXME: There is no documentation on the
4691: alternatives framework.</p></dd>
4692: </dl></div>
4693: </div>
4694: <div class="sect2" lang="en">
4695: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4696: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4697: <div class="variablelist"><dl>
4698: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4699: <dd><p>This file contains arbitrary things that could
4700: also go into a <code class="filename">Makefile</code>, but its purpose is
4701: to be used by more than one package. This file should only be
4702: used when the packages that will use the file are known in
4703: advance. For other purposes it is often better to write a
4704: <code class="filename">*.mk</code> file and give it a good name that
4705: describes what it does.</p></dd>
4706: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4707: <dd><p>This file contains the dependency information
1.90 rillig 4708: 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 4709: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4710: <dd><p>This file contains workarounds for compiler bugs
4711: and similar things. It is included automatically by the pkgsrc
4712: infrastructure, so you don't need an extra
4713: <code class="literal">.include</code> line for
4714: it.</p></dd>
4715: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4716: <dd><p>This file contains the code for the
1.90 rillig 4717: 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 4718: selected by the user. If a package has only one or two options,
4719: it is equally acceptable to put the code directly into the
4720: <code class="filename">Makefile</code>.</p></dd>
4721: </dl></div>
4722: </div>
4723: <div class="sect2" lang="en">
4724: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4725: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4726: <div class="variablelist"><dl>
4727: <dt><span class="term"><code class="filename">README*</code></span></dt>
4728: <dd><p>These files do not take place in the creation of
4729: a package and thus are purely informative to the package
4730: developer.</p></dd>
4731: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4732: <dd><p>This file contains things that need to be done
4733: to make the package even
4734: better.</p></dd>
1.75 rillig 4735: </dl></div>
4736: </div>
1.78 rillig 4737: </div>
1.75 rillig 4738: <div class="sect1" lang="en">
4739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4740: <a name="work-dir"></a>10.6. <code class="filename">work*</code>
4741: </h2></div></div></div>
1.75 rillig 4742: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87 wiz 4743: unpacked into the directory denoted by
4744: <code class="varname">WRKDIR</code>. It can be removed by running
4745: <span><strong class="command">make clean</strong></span>. Besides the sources, this
4746: directory is also used to keep various timestamp files.
4747: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4748: The default is <code class="filename">${.CURDIR}/work</code>
4749: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4750: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4751: </div>
4752: <div class="sect1" lang="en">
4753: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4754: <a name="files-dir"></a>10.7. <code class="filename">files/*</code>
4755: </h2></div></div></div>
1.75 rillig 4756: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4757: to configuration or building, you could place these files here and use
4758: a <span><strong class="command">${CP}</strong></span> command in the
4759: “<span class="quote">pre-configure</span>” target to achieve
4760: this. Alternatively, you could simply diff the file against
4761: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4762: the creation of this file.</p>
4763: <p>If you want to share files in this way with other
4764: packages, set the <code class="varname">FILESDIR</code> variable to point
4765: to the other package's <code class="filename">files</code> directory,
4766: e.g.:</p>
4767: <pre class="programlisting">
4768: FILESDIR=${.CURDIR}/../xemacs/files
4769: </pre>
1.75 rillig 4770: </div>
4771: </div>
4772: <div class="chapter" lang="en">
4773: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4774: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4775: <div class="toc">
4776: <p><b>Table of Contents</b></p>
4777: <dl>
1.90 rillig 4778: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
4779: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
4780: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
4781: <dd><dl>
4782: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
4783: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
4784: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
4785: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
4786: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
1.75 rillig 4787: </dl></dd>
4788: </dl>
4789: </div>
1.76 rillig 4790: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4791: each of which forms a well-defined part of the pkgsrc system. Using
4792: 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
4793: like pkgsrc requires some discipline to keep the code correct and
4794: understandable.</p>
1.76 rillig 4795: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4796: programming are variables (which are actually macros) and shell
4797: commands. Among these shell commands may even be more complex ones
4798: 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
4799: as intended it is necessary to quote all variables correctly when they
4800: are used.</p>
4801: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4802: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4803: with them.</p>
4804: <div class="sect1" lang="en">
4805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4806: <a name="makefile.variables"></a>11.1. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4807: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4808: can be processed using the five operators ``='', ``+='', ``?='',
4809: ``:='', 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
4810: page.</p>
4811: <p>When a variable's value is parsed from a
1.76 rillig 4812: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4813: backslash character ``\'' are handled specially. If a backslash is
4814: followed by a newline, any whitespace immediately in front of the
4815: backslash, the backslash, the newline, and any whitespace
4816: immediately behind the newline are replaced with a single space. A
4817: backslash character and an immediately following hash character are
4818: replaced with a single hash character. Otherwise, the backslash is
4819: passed as is. In a variable assignment, any hash character that is
4820: not preceded by a backslash starts a comment that continues upto the
4821: end of the logical line.</p>
4822: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4823: the only way to create a variable consisting of a single backslash
4824: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4825: <p>So far for defining variables. The other thing you can do with
4826: variables is evaluating them. A variable is evaluated when it is
4827: part of the right side of the ``:='' or the ``!='' operator, or
4828: directly before executing a shell command which the variable is part
4829: 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
4830: is, variables are not evaluated until there's no other way. The
4831: ``modifiers'' mentioned in the man page also evaluate the
4832: variable.</p>
4833: <p>Some of the modifiers split the string into words and then
4834: operate on the words, others operate on the string as a whole. When
4835: a string is split into words, it is split as you would expect
4836: 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 4837: <p>No rule without exception—the <span><strong class="command">.for</strong></span>
1.75 rillig 4838: loop does not follow the shell quoting rules but splits at sequences
4839: of whitespace.</p>
4840: <p>There are several types of variables that should be handled
4841: differently. Strings and two types of lists.</p>
4842: <div class="itemizedlist"><ul type="disc">
4843: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4844: characters. Nevertheless, you should restrict yourself to only
4845: using printable characters. Examples are
4846: <code class="varname">PREFIX</code> and
4847: <code class="varname">COMMENT</code>.</p></li>
4848: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4849: are never exported to any shell command. Their elements are
4850: separated by whitespace. Therefore, the elements themselves cannot
4851: have embedded whitespace. Any other characters are allowed.
4852: Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
4853: Examples are <code class="varname">DEPENDS</code> and
4854: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4855: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4856: may be exported to a shell command. Their elements can contain any
4857: characters, including whitespace. That's why they cannot be used
4858: in <span><strong class="command">.for</strong></span> loops. Examples are
4859: <code class="varname">DISTFILES</code> and
4860: <code class="varname">MASTER_SITES</code>.</p></li>
4861: </ul></div>
4862: <div class="sect2" lang="en">
4863: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4864: <a name="makefile.variables.names"></a>11.1.1. Naming conventions</h3></div></div></div>
1.75 rillig 4865: <div class="itemizedlist"><ul type="disc">
4866: <li><p>All variable names starting with an underscore
4867: are reserved for use by the pkgsrc infrastructure. They shall
4868: not be used by package
1.76 rillig 4869: <code class="filename">Makefile</code>s.</p></li>
1.75 rillig 4870: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
4871: lowercase variable names for the iteration
4872: variables.</p></li>
4873: <li><p>All list variables should have a ``plural''
4874: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4875: <code class="varname">DISTFILES</code>.</p></li>
4876: </ul></div>
4877: </div>
4878: </div>
4879: <div class="sect1" lang="en">
4880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4881: <a name="makefile.code"></a>11.2. Code snippets</h2></div></div></div>
1.75 rillig 4882: <p>This section presents you with some code snippets you should
4883: use in your own code. If you don't find anything appropriate here,
4884: you should test your code and add it here.</p>
4885: <div class="sect2" lang="en">
4886: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4887: <a name="adding-to-list"></a>11.2.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4888: <pre class="programlisting">
4889: STRING= foo * bar `date`
4890: INT_LIST= # empty
4891: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4892: EXT_LIST= # empty
4893: ANOTHER_EXT_LIST= a=b c=d
1.1 grant 4894:
1.75 rillig 4895: INT_LIST+= ${STRING} # 1
4896: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4897: EXT_LIST+= ${STRING:Q} # 3
4898: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4899: </pre>
1.75 rillig 4900: <p>When you add a string to an external list (example 3), it
4901: must be quoted. In all other cases, you must not add a quoting
4902: level. You must not merge internal and external lists, unless you
4903: are sure that all entries are correctly interpreted in both
4904: lists.</p>
4905: </div>
4906: <div class="sect2" lang="en">
4907: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4908: <a name="converting-internal-to-external"></a>11.2.2. Converting an internal list into an external list</h3></div></div></div>
1.75 rillig 4909: <pre class="programlisting">
4910: EXT_LIST= # empty
4911: .for i in ${INT_LIST}
4912: EXT_LIST+= ${i:Q}""
4913: .endfor
1.1 grant 4914: </pre>
1.75 rillig 4915: <p>This code converts the internal list
4916: <code class="varname">INT_LIST</code> into the external list
4917: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4918: are unquoted they must be quoted here. The reason for appending
4919: <code class="varname">""</code> is explained below.</p>
4920: </div>
4921: <div class="sect2" lang="en">
4922: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4923: <a name="passing-variable-to-shell"></a>11.2.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4924: <p>Sometimes you may want to print an arbitrary string. There
4925: are many ways to get it wrong and only few that can handle every
4926: nastiness.</p>
1.75 rillig 4927: <pre class="programlisting">
4928: STRING= foo bar < > * `date` $$HOME ' "
4929: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4930:
1.75 rillig 4931: all:
4932: echo ${STRING} # 1
4933: echo "${STRING}" # 2
4934: echo "${STRING:Q}" # 3
4935: echo ${STRING:Q} # 4
4936: echo x${STRING:Q} | sed 1s,.,, # 5
1.79 rillig 4937: printf "%s\\n" ${STRING:Q}"" # 6
1.75 rillig 4938: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4939: </pre>
1.75 rillig 4940: <p>Example 1 leads to a syntax error in the shell, as the
4941: characters are just copied.</p>
4942: <p>Example 2 leads to a syntax error too, and if you leave out
4943: the last " character from <code class="varname">${STRING}</code>,
4944: <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
4945: variable would be evaluated, too.</p>
4946: <p>Example 3 outputs each space character preceded by a
4947: backslash (or not), depending on the implementation of the
4948: <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>
4949: <p>Example 4 handles correctly every string that does not start
4950: with a dash. In that case, the result depends on the
4951: 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
4952: guarantee that your input does not start with a dash, this form is
4953: appropriate.</p>
4954: <p>Example 5 handles even the case of a leading dash
4955: correctly.</p>
1.79 rillig 4956: <p>Example 6 also works with every string and is the
4957: light-weight solution, since it does not involve a pipe, which has
4958: its own problems.</p>
1.75 rillig 4959: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4960: because the quoting has already been done when adding elements to
4961: the list.</p>
4962: <p>As internal lists shall not be passed to the shell, there is
4963: no example for it.</p>
4964: </div>
4965: <div class="sect2" lang="en">
4966: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4967: <a name="quoting-guideline"></a>11.2.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4968: <p>There are many possible sources of wrongly quoted variables.
4969: This section lists some of the commonly known ones.</p>
4970: <div class="itemizedlist"><ul type="disc">
4971: <li>
4972: <p>Whenever you use the value of a list, think
4973: about what happens to leading or trailing whitespace. If the
4974: list is a well-formed shell expression, you can apply the
4975: <code class="varname">:M*</code> modifier to strip leading and trailing
4976: whitespace from each word. The <code class="varname">:M</code> operator
4977: first splits its argument according to the rules of the shell,
4978: and then creates a new list consisting of all words that match
4979: the shell glob expression <code class="varname">*</code>, that is: all.
4980: One class of situations where this is needed is when adding a
4981: variable like <code class="varname">CPPFLAGS</code> to
4982: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4983: invokes other configure scripts, it strips the leading and
4984: trailing whitespace from the variable and then passes it to the
4985: other configure scripts. But these configure scripts expect the
4986: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4987: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4988: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4989: here is how we do it:</p>
4990: <pre class="programlisting">
4991: CPPFLAGS= # empty
4992: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4993: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 4994:
1.75 rillig 4995: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 4996:
1.75 rillig 4997: all:
4998: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4999: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5000: </pre>
1.75 rillig 5001: </li>
5002: <li><p>The example above contains one bug: The
5003: <code class="varname">${PREFIX}</code> is a properly quoted shell
5004: expression, but there is the C compiler after it, which also
5005: expects a properly quoted string (this time in C syntax). The
5006: version above is therefore only correct if
5007: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5008: or double quotes. If you want to allow these, you have to add
5009: another layer of quoting to each variable that is used as a C
5010: string literal. You cannot use the <code class="varname">:Q</code>
5011: operator for it, as this operator only works for the
5012: shell.</p></li>
5013: <li>
5014: <p>Whenever a variable can be empty, the
5015: <code class="varname">:Q</code> operator can have surprising results. Here
5016: are two completely different cases which can be solved with the
5017: same trick.</p>
5018: <pre class="programlisting">
5019: EMPTY= # empty
5020: empty_test:
5021: for i in a ${EMPTY:Q} c; do \
5022: echo "$$i"; \
5023: done
1.1 grant 5024:
1.75 rillig 5025: for_test:
5026: .for i in a:\ a:\test.txt
5027: echo ${i:Q}
5028: echo "foo"
5029: .endfor
1.1 grant 5030: </pre>
1.75 rillig 5031: <p>The first example will only print two of the three lines
5032: we might have expected. This is because
5033: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5034: the shell cannot see. The workaround is to write
5035: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5036: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5037: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5038: <p>The second example will only print three lines instead of
5039: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5040: This is because the backslash of the value
5041: <code class="varname">a:\</code> is interpreted as a line-continuation by
5042: <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
5043: <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
5044: <code class="varname">${i:Q}""</code>.</p>
5045: </li>
5046: </ul></div>
5047: </div>
5048: <div class="sect2" lang="en">
5049: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5050: <a name="bsd-make-bug-workaround"></a>11.2.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5051: <p>The pkgsrc bmake program does not handle the following
5052: assignment correctly. In case <code class="varname">_othervar_</code>
5053: contains a ``-'' character, one of the closing braces is included
5054: in <code class="varname">${VAR}</code> after this code executes.</p>
5055: <pre class="programlisting">
5056: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5057: </pre>
1.75 rillig 5058: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5059: 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 5060: <code class="varname">bug1</code>.</p>
5061: </div>
5062: </div>
5063: </div>
5064: <div class="chapter" lang="en">
5065: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5066: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75 rillig 5067: <div class="toc">
5068: <p><b>Table of Contents</b></p>
5069: <dl>
1.90 rillig 5070: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
5071: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5072: <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>
5073: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
5074: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
5075: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5076: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
5077: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5078: </dl>
5079: </div>
1.87 wiz 5080: <p>The <code class="filename">PLIST</code> file contains a package's
5081: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5082: the package (relative to the <code class="filename">${PREFIX}</code>
5083: directory it's been installed in) plus some additional statements
5084: - 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.
5085: This chapter addresses some issues that need attention when
5086: dealing with the <code class="filename">PLIST</code> file (or files, see
5087: below!).</p>
1.75 rillig 5088: <div class="sect1" lang="en">
5089: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5090: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87 wiz 5091: <p>Be sure to add a RCS ID line as the first thing in any
5092: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5093: <pre class="programlisting">
1.87 wiz 5094: @comment $NetBSD$
5095: </pre>
1.75 rillig 5096: </div>
5097: <div class="sect1" lang="en">
5098: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5099: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75 rillig 5100: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87 wiz 5101: to output a PLIST that matches any new files since the package
1.90 rillig 5102: 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 5103: more information on this target.</p>
1.75 rillig 5104: </div>
5105: <div class="sect1" lang="en">
5106: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 5107: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
5108: </h2></div></div></div>
1.87 wiz 5109: <p>If you have used any of the *-dirs packages, as explained in
1.90 rillig 5110: <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 5111: <span><strong class="command">make print-PLIST</strong></span> outputs a set of
5112: <code class="varname">@comment</code>s instead of real
5113: <code class="varname">@dirrm</code> lines. You can also do this for
5114: specific directories and files, so that the results of that
5115: command are very close to reality. This helps <span class="emphasis"><em>a
5116: lot</em></span> during the update of packages.</p>
5117: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5118: of AWK patterns and actions that are used to filter the output of
5119: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5120: scripting you like to it, but be careful with quoting.</p>
5121: <p>For example, to get all files inside the
5122: <code class="filename">libdata/foo</code> directory removed from the
5123: resulting PLIST:</p>
5124: <pre class="programlisting">
5125: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
5126: </pre>
5127: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5128: to a specific (shared) directory converted to
5129: <code class="varname">@comment</code>s:</p>
1.75 rillig 5130: <pre class="programlisting">
1.87 wiz 5131: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5132: </pre>
1.75 rillig 5133: </div>
5134: <div class="sect1" lang="en">
5135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5136: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5137: <p>A number of variables are substituted automatically in
5138: PLISTs when a package is installed on a system. This includes the
5139: following variables:</p>
1.75 rillig 5140: <div class="variablelist"><dl>
5141: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5142: <dd>
5143: <p>Some packages like emacs and perl embed information
1.87 wiz 5144: about which architecture they were built on into the
5145: pathnames where they install their files. To handle this
5146: case, PLIST will be preprocessed before actually used, and
5147: the symbol
5148: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
5149: replaced by what <span><strong class="command">uname -p</strong></span> gives. The
5150: same is done if the string
5151: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5152: PLIST somewhere - use this on packages that have GNU
5153: autoconf-created configure scripts.</p>
1.75 rillig 5154: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5155: <h3 class="title">Legacy note</h3>
5156: <p>There used to be a symbol
1.87 wiz 5157: “<span class="quote"><code class="varname">$ARCH</code></span>” that
5158: was replaced by the output of <span><strong class="command">uname
5159: -m</strong></span>, but that's no longer supported and has
5160: been removed.</p>
1.75 rillig 5161: </div>
5162: </dd>
5163: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5164: <dd>
5165: <p>Some packages want to embed the OS name and version
1.87 wiz 5166: into some paths. To do this, use these variables in the
5167: <code class="filename">PLIST</code>:
5168: </p>
1.75 rillig 5169: <div class="itemizedlist"><ul type="disc">
5170: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span><strong class="command">uname -s</strong></span></span>”</p></li>
5171: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
5172: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span><strong class="command">uname -r</strong></span></span>”</p></li>
5173: </ul></div>
5174: </dd>
5175: </dl></div>
1.87 wiz 5176: <p>For a complete list of values which are replaced by
5177: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5178: search for <code class="varname">PLIST_SUBST</code>).</p>
5179: <p>If you want to change other variables not listed above, you
5180: can add variables and their expansions to this variable in the
1.90 rillig 5181: 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 5182: <pre class="programlisting">
1.87 wiz 5183: PLIST_SUBST+= SOMEVAR="somevalue"
5184: </pre>
1.75 rillig 5185: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5186: in the <code class="filename">PLIST</code> with
5187: “<span class="quote">somevalue</span>”.</p>
1.75 rillig 5188: </div>
5189: <div class="sect1" lang="en">
5190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5191: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75 rillig 5192: <p>Man pages should be installed in compressed form if
1.87 wiz 5193: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5194: and uncompressed otherwise. To handle this in the
5195: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5196: appended/removed automatically for man pages according to
5197: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5198: or not, see above for details. This modification of the
5199: <code class="filename">PLIST</code> file is done on a copy of it, not
5200: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5201: </div>
5202: <div class="sect1" lang="en">
5203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 5204: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
5205: </h2></div></div></div>
1.76 rillig 5206: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5207: in generating the binary package, set the variable
5208: <code class="varname">PLIST_SRC</code> to the names of that file(s).
5209: 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
5210: important. The default for <code class="varname">PLIST_SRC</code> is
5211: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5212: </div>
5213: <div class="sect1" lang="en">
5214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5215: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5216: <p>Some packages decide to install a different set of files based on
1.87 wiz 5217: the operating system being used. These differences can be
5218: automatically handled by using the following files:</p>
1.75 rillig 5219: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5220: <li><p><code class="filename">PLIST.common</code></p></li>
5221: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5222: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5223: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5224: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5225: </ul></div>
5226: </div>
5227: <div class="sect1" lang="en">
5228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5229: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5230: <p>A “<span class="quote">shared directory</span>” is a directory where
5231: multiple (and unrelated) packages install files. These
5232: directories are problematic because you have to add special tricks
5233: in the PLIST to conditionally remove them, or have some
5234: centralized package handle them.</p>
5235: <p>Within pkgsrc, you'll find both approaches. If a directory
5236: is shared by a few unrelated packages, it's often not worth to add
5237: an extra package to remove it. Therefore, one simply does:</p>
5238: <pre class="programlisting">
5239: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
5240: </pre>
5241: <p>in the PLISTs of all affected packages, instead of the
5242: regular "@dirrm" line.</p>
5243: <p>However, if the directory is shared across many packages, two
5244: different solutions are available:</p>
1.75 rillig 5245: <div class="orderedlist"><ol type="1">
1.87 wiz 5246: <li><p>If the packages have a common dependency, the directory
5247: can be removed in that. For example, see
1.91 rillig 5248: <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 5249: removes the shared directory
5250: <code class="filename">share/omf</code>.</p></li>
5251: <li><p>If the packages using the directory are not related at
5252: all (they have no common dependencies), a *-dirs package is
5253: used.</p></li>
1.75 rillig 5254: </ol></div>
1.87 wiz 5255: <p>From now on, we'll discuss the second solution. To get an
5256: idea of the *-dirs packages available, issue:</p>
1.75 rillig 5257: <pre class="programlisting">
1.87 wiz 5258: <code class="prompt">%</code> cd .../pkgsrc
5259: <code class="prompt">%</code> ls -d */*-dirs
5260: </pre>
5261: <p>Their use from other packages is very simple. The
5262: <code class="varname">USE_DIRS</code> variable takes a list of package names
5263: (without the “<span class="quote">-dirs</span>” part) together with the required
5264: version number (always pick the latest one when writing new
5265: packages).</p>
5266: <p>For example, if a package installs files under
5267: <code class="filename">share/applications</code>, it should have the
5268: following line in it:</p>
5269: <pre class="programlisting">
5270: USE_DIRS+= xdg-1.1
5271: </pre>
5272: <p>After regenerating the PLIST using <span><strong class="command">make
5273: print-PLIST</strong></span>, you should get the right (commented out)
5274: lines.</p>
5275: <p>Note that even if your package is using
5276: <code class="filename">$X11BASE</code>, it must not depend on the
5277: *-x11-dirs packages. Just specify the name without that part and
5278: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5279: care of it.</p>
1.75 rillig 5280: </div>
5281: </div>
5282: <div class="chapter" lang="en">
5283: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5284: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75 rillig 5285: <div class="toc">
5286: <p><b>Table of Contents</b></p>
5287: <dl>
1.90 rillig 5288: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
5289: <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 5290: <dd><dl>
1.90 rillig 5291: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5292: <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 5293: </dl></dd>
1.90 rillig 5294: <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 5295: <dd><dl>
1.90 rillig 5296: <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>
5297: <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 5298: </dl></dd>
5299: </dl>
5300: </div>
5301: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5302: are seen by a package's configure and build processes. This is implemented
5303: in a two step process:</p>
1.75 rillig 5304: <div class="orderedlist"><ol type="1">
5305: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5306: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5307: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5308: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5309: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5310: <code class="option">-L${LOCALBASE}/lib</code> into references to
5311: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5312: native compiler on some operating systems look like GCC, so that
5313: packages that expect GCC won't require modifications to build with
5314: those native compilers.</p></li>
1.75 rillig 5315: </ol></div>
5316: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5317: package may be built consistently despite what other software may be
5318: installed. Please note that the normal system header and library paths,
5319: e.g. <code class="filename">/usr/include</code>,
5320: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5321: designed to insulate the package build from non-system-supplied
5322: software.</p>
1.75 rillig 5323: <div class="sect1" lang="en">
5324: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5325: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5326: <p>The process of converting packages to use the buildlink3
1.87 wiz 5327: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5328: The things to keep in mind are:</p>
1.75 rillig 5329: <div class="orderedlist"><ol type="1">
1.87 wiz 5330: <li><p>Ensure that the build always calls the wrapper scripts
5331: instead of the actual toolchain. Some packages are tricky,
5332: and the only way to know for sure is the check
5333: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5334: wrappers are being invoked.</p></li>
5335: <li><p>Don't override <code class="varname">PREFIX</code> from within
5336: the package Makefile, e.g. Java VMs, standalone shells,
5337: etc., because the code to symlink files into
5338: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5339: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5340: </p></li>
5341: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5342: <code class="filename">buildlink3.mk</code> files that you list in a
5343: package's Makefile are added as dependencies for that package.
5344: </p></li>
1.75 rillig 5345: </ol></div>
1.87 wiz 5346: <p>If a dependency on a particular package is required for its libraries and
5347: headers, then we replace:</p>
1.75 rillig 5348: <pre class="programlisting">
1.87 wiz 5349: DEPENDS+= foo>=1.1.0:../../category/foo
5350: </pre>
1.75 rillig 5351: <p>with</p>
5352: <pre class="programlisting">
1.87 wiz 5353: .include "../../category/foo/buildlink3.mk"
5354: </pre>
1.75 rillig 5355: <p>The buildlink3.mk files usually define the required dependencies.
5356: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5357: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5358: <pre class="programlisting">
1.87 wiz 5359: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5360: .include "../../category/foo/buildlink3.mk"
5361: </pre>
1.76 rillig 5362: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5363: files in <code class="filename">pkgsrc/mk</code>
5364: that handle special package issues:</p>
1.75 rillig 5365: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5366: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5367: the native or a pkgsrc Berkeley DB implementation based on
5368: the values of <code class="varname">BDB_ACCEPTED</code> and
5369: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5370: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5371: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5372: 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 5373: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5374: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5375: adding a dependency on Heimdal or MIT-krb5 for packages that
5376: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5377: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5378: system-provided Motif installation or adds a dependency on
1.91 rillig 5379: <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 5380: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5381: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5382: which Motif version will be used.</p></li>
1.76 rillig 5383: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5384: variables that may be used by packages that use the
5385: Open Sound System (OSS) API.</p></li>
1.76 rillig 5386: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5387: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5388: the file for more information.</p></li>
1.76 rillig 5389: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5390: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5391: 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 5392: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5393: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5394: library.</p></li>
1.75 rillig 5395: </ul></div>
1.76 rillig 5396: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5397: files provide a more complete
5398: description of how to use them properly.</p>
1.75 rillig 5399: </div>
5400: <div class="sect1" lang="en">
5401: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5402: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87 wiz 5403: <p>A package's <code class="filename">buildlink3.mk</code> file is
5404: included by Makefiles to indicate the need to compile and link
5405: against header files and libraries provided by the package. A
5406: <code class="filename">buildlink3.mk</code> file should always provide
5407: enough information to add the correct type of dependency
5408: relationship and include any other
5409: <code class="filename">buildlink3.mk</code> files that it needs to find
5410: headers and libraries that it needs in turn.</p>
5411: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5412: 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 5413: package is highly recommended. For most packages, the following
5414: command will generate a good starting point for
5415: <code class="filename">buildlink3.mk</code> files:</p>
5416: <pre class="screen">
5417: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5418: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5419: </pre>
1.75 rillig 5420: <div class="sect2" lang="en">
5421: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5422: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5423: <p>The following real-life example
1.87 wiz 5424: <code class="filename">buildlink3.mk</code> is taken
5425: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5426: <pre class="programlisting">
1.87 wiz 5427: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1 grant 5428:
1.87 wiz 5429: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5430: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
1.1 grant 5431:
1.87 wiz 5432: .if !empty(BUILDLINK_DEPTH:M+)
5433: BUILDLINK_DEPENDS+= tiff
5434: .endif
5435:
5436: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5437: BUILDLINK_PACKAGES+= tiff
5438:
5439: .if !empty(TIFF_BUILDLINK3_MK:M+)
5440: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5441: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5442: .endif # TIFF_BUILDLINK3_MK
5443:
5444: .include "../../devel/zlib/buildlink3.mk"
5445: .include "../../graphics/jpeg/buildlink3.mk"
5446:
5447: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5448: </pre>
5449: <p>The header and footer manipulate
5450: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5451: <code class="filename">buildlink3.mk</code> files and is used to track
5452: at what depth we are including
5453: <code class="filename">buildlink3.mk</code> files.</p>
5454: <p>The first section controls if the dependency on
5455: <em class="replaceable"><code>pkg</code></em> is added.
5456: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5457: packages for which dependencies are added by
5458: buildlink3.</p>
5459: <p>The second section advises pkgsrc that the
5460: <code class="filename">buildlink3.mk</code> file for
5461: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5462: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5463: packages for which <code class="filename">buildlink3.mk</code> files
5464: have been included. It must <span class="emphasis"><em>always</em></span> be
5465: appended to within a <code class="filename">buildlink3.mk</code>
5466: file.</p>
5467: <p>The third section is protected from multiple inclusion
5468: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5469: added. Several important variables are set in the section:</p>
5470: <div class="itemizedlist"><ul type="disc">
5471: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5472: is the actual dependency recorded in the installed
5473: package; this should always be set using
5474: <span><strong class="command">+=</strong></span> to ensure that
5475: we're appending to any pre-existing list of values. This
5476: variable should be set to the first version of the
5477: package that had an API change.
5478: </p></li>
5479: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5480: is the location of the <em class="replaceable"><code>pkg</code></em>
5481: pkgsrc directory.</p></li>
5482: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5483: (not shown above) controls whether we use
5484: <code class="varname">BUILD_DEPENDS</code> or
5485: <code class="varname">DEPENDS</code> to add the dependency on
5486: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5487: selected by setting
5488: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5489: to “<span class="quote">build</span>”. By default, the full dependency is
5490: used.</p></li>
5491: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5492: and
5493: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5494: (not shown above) are lists of subdirectories of
1.76 rillig 5495: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5496: to add to the header and library search paths. These
5497: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5498: respectively.</p></li>
5499: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5500: (not shown above) is the list of preprocessor flags to add
5501: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5502: configure and build phases. The “<span class="quote">-I</span>” option
5503: should be avoided and instead be handled using
5504: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5505: above.</p></li>
1.75 rillig 5506: </ul></div>
1.87 wiz 5507: <p>The following variables are all optionally defined within
5508: this second section (protected against multiple inclusion) and
5509: control which package files are symlinked into
5510: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5511: transformed during the symlinking:</p>
1.75 rillig 5512: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5513: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5514: (not shown above) is a shell glob pattern relative to
1.76 rillig 5515: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5516: to be symlinked into
1.76 rillig 5517: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5518: e.g. <code class="filename">include/*.h</code>.</p></li>
5519: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5520: (not shown above) is a shell pipeline that
5521: outputs to stdout a list of files relative to
5522: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5523: The resulting files are to be symlinked
5524: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5525: this takes the <code class="filename">+CONTENTS</code> of a
5526: <em class="replaceable"><code>pkg</code></em> and filters it through
5527: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5528: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5529: (not shown above) is a filter command that filters
1.76 rillig 5530: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5531: relative to
1.76 rillig 5532: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5533: on stdout. By default for overwrite packages,
5534: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5535: outputs the contents of the <code class="filename">include</code>
5536: and <code class="filename">lib</code> directories in the package
5537: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5538: it outputs any libtool archives in
1.87 wiz 5539: <code class="filename">lib</code> directories.</p></li>
1.95 tron 5540: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5541: (not shown above) is a list of sed arguments used to
5542: transform the name of the source filename into a
5543: destination filename, e.g. <span><strong class="command">-e
1.87 wiz 5544: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5545: </ul></div>
1.87 wiz 5546: <p>The last section includes any
5547: <code class="filename">buildlink3.mk</code> needed for
5548: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5549: Including these <code class="filename">buildlink3.mk</code> files
5550: means that the headers and libraries for these
5551: dependencies are also symlinked into
5552: <code class="filename">${BUILDLINK_DIR}</code>
5553: whenever the <em class="replaceable"><code>pkg</code></em>
5554: <code class="filename">buildlink3.mk</code>
5555: file is included.</p>
1.75 rillig 5556: </div>
5557: <div class="sect2" lang="en">
5558: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5559: <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 5560: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5561: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5562: after a package update is when the API or interface to the
1.87 wiz 5563: header files change.</p>
5564: <p>In this case,
5565: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5566: should be adjusted to require at least the new package
5567: version. In some cases, the packages that depend on this new
5568: version may need their <code class="varname">PKGREVISION</code>s
5569: increased and, if they have <code class="filename">buildlink3.mk</code>
5570: files, their
5571: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5572: adjusted, too. This is needed so pkgsrc will require the
5573: correct package dependency and not settle for an older one
5574: when building the source.</p>
5575: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5576: should be increased when the binary interface or sonames
5577: (major number of the library version) of any installed
5578: shared libraries change. This is needed so that binary
5579: packages made using it will require the correct package
5580: dependency and not settle for an older one which will not
1.87 wiz 5581: contain the necessary shared libraries.</p>
1.90 rillig 5582: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, “Handling dependencies”</a> for
1.75 rillig 5583: more information about dependencies on other packages,
5584: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5585: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5586: <p>Please take careful consideration before adjusting
5587: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5588: or
5589: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5590: as we don't want to cause unneeded package deletions and
5591: rebuilds. In many cases, new versions of packages work just
5592: fine with older dependencies.</p>
5593: <p>Also it is not needed to set
1.75 rillig 5594: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5595: when it is identical to
1.87 wiz 5596: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5597: </div>
5598: </div>
5599: <div class="sect1" lang="en">
5600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5601: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5602: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5603: coincide with headers and libraries present in the base system.
1.76 rillig 5604: Aside from a <code class="filename">buildlink3.mk</code> file, these
5605: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5606: file that includes the necessary checks to decide whether using
5607: the built-in software or the pkgsrc software is
1.87 wiz 5608: appropriate.</p>
5609: <p>The only requirements of a builtin.mk file for
5610: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5611: <div class="orderedlist"><ol type="1">
1.87 wiz 5612: <li><p>It should set
5613: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5614: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5615: after it is included.</p></li>
5616: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5617: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5618: which is already set before the
5619: <code class="filename">builtin.mk</code> file is included.</p></li>
5620: <li><p>It should be written to allow multiple inclusion. This
5621: is <span class="emphasis"><em>very</em></span> important and takes careful
5622: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5623: </ol></div>
5624: <div class="sect2" lang="en">
5625: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5626: <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 5627: <p>The following is the recommended template for builtin.mk
1.87 wiz 5628: files:</p>
1.75 rillig 5629: <pre class="programlisting">
1.87 wiz 5630: .if !defined(IS_BUILTIN.foo)
5631: #
5632: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5633: # genuinely exists in the system or not.
5634: #
5635: IS_BUILTIN.foo?= no
5636:
5637: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5638: # version can be determined.
5639: #
5640: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5641: BUILTIN_PKG.foo?= foo-1.0
5642: . endif
5643: .endif # IS_BUILTIN.foo
5644:
5645: .if !defined(USE_BUILTIN.foo)
5646: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5647: . if defined(BUILTIN_PKG.foo)
5648: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5649: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5650: USE_BUILTIN.foo!= \
5651: if ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}; then \
5652: ${ECHO} "yes"; \
5653: else \
5654: ${ECHO} "no"; \
5655: fi
5656: . endif
5657: . endfor
5658: . endif
5659: .endif # USE_BUILTIN.foo
5660:
5661: CHECK_BUILTIN.foo?= no
5662: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5663: #
5664: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5665: # "yes" or "no".
5666: #
5667: .endif # CHECK_BUILTIN.foo
5668: </pre>
5669: <p>The first section sets
5670: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5671: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5672: in the base system. This should not be a base system software
5673: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5674: it should only be “<span class="quote">yes</span>” if the actual package is
5675: included as part of the base system. This variable is only
5676: used internally within the <code class="filename">builtin.mk</code>
5677: file.</p>
5678: <p>The second section sets
5679: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5680: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5681: system if it exists (if
5682: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5683: is “<span class="quote">yes</span>”). This variable is only used internally
5684: within the <code class="filename">builtin.mk</code> file.</p>
5685: <p>The third section sets
5686: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5687: and is <span class="emphasis"><em>required</em></span> in all
5688: <code class="filename">builtin.mk</code> files. The code in this
5689: section must make the determination whether the built-in
5690: software is adequate to satisfy the dependencies listed in
5691: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5692: This is typically done by comparing
5693: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5694: against each of the dependencies in
5695: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5696: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5697: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5698: end of the <code class="filename">builtin.mk</code> file. Note that
5699: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5700: may be “<span class="quote">yes</span>” even if
5701: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5702: is “<span class="quote">no</span>” because we may make the determination
5703: that the built-in version of the software is similar enough to
5704: be used as a replacement.</p>
5705: <p>The last section is guarded by
5706: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5707: and includes code that uses the value of
5708: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5709: set in the previous section. This typically includes, e.g.,
5710: adding additional dependency restrictions and listing additional
5711: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5712: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5713: </div>
5714: <div class="sect2" lang="en">
5715: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5716: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5717: <p>When building packages, it's possible to choose whether to set
5718: a global preference for using either the built-in (native)
5719: version or the pkgsrc version of software to satisfy a
5720: dependency. This is controlled by setting
5721: <code class="varname">PREFER_PKGSRC</code> and
5722: <code class="varname">PREFER_NATIVE</code>. These variables take values
5723: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5724: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5725: use the pkgsrc versions of software, while
5726: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5727: built-in versions. Preferences are determined by the most
5728: specific instance of the package in either
5729: <code class="varname">PREFER_PKGSRC</code> or
5730: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5731: in neither or in both variables, then
5732: <code class="varname">PREFER_PKGSRC</code> has precedence over
5733: <code class="varname">PREFER_NATIVE</code>. For example, to require
5734: using pkgsrc versions of software for all but the most basic
5735: bits on a NetBSD system, you can set:</p>
5736: <pre class="programlisting">
5737: PREFER_PKGSRC= yes
5738: PREFER_NATIVE= getopt skey tcp_wrappers
5739: </pre>
5740: <p>A package <span class="emphasis"><em>must</em></span> have a
5741: <code class="filename">builtin.mk</code>
5742: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5743: otherwise it is simply ignored in that list.</p>
1.75 rillig 5744: </div>
5745: </div>
5746: </div>
5747: <div class="chapter" lang="en">
5748: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5749: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75 rillig 5750: <div class="toc">
5751: <p><b>Table of Contents</b></p>
5752: <dl>
1.90 rillig 5753: <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 5754: <dd><dl>
1.90 rillig 5755: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
5756: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75 rillig 5757: </dl></dd>
1.90 rillig 5758: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75 rillig 5759: <dd><dl>
1.90 rillig 5760: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5761: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
5762: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
5763: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
5764: </dl></dd>
5765: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
5766: <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>
5767: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
5768: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
5769: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
5770: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
5771: <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 5772: </dl>
5773: </div>
5774: <p>This chapter describes the framework known as
5775: <code class="literal">pkginstall</code>, whose key features are:</p>
5776: <div class="itemizedlist"><ul type="disc">
5777: <li><p>Generic installation and manipulation of directories and files
5778: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5779: <li><p>Automatic handling of configuration files during installation,
5780: provided that packages are correctly designed.</p></li>
5781: <li><p>Generation and installation of system startup scripts.</p></li>
5782: <li><p>Registration of system users and groups.</p></li>
5783: <li><p>Registration of system shells.</p></li>
5784: <li><p>Automatic updating of fonts databases.</p></li>
5785: </ul></div>
5786: <p>The following sections inspect each of the above points in detail.</p>
5787: <p>You may be thinking that many of the things described here could be
5788: easily done with simple code in the package's post-installation target
5789: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5790: as the code in them is only executed when building from source. Machines
5791: using binary packages could not benefit from it at all (as the code itself
5792: could be unavailable). Therefore, the only way to achieve any of the items
5793: described above is by means of the installation scripts, which are
5794: automatically generated by pkginstall.</p>
5795: <div class="sect1" lang="en">
5796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5797: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5798: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5799: of files and directories that belong to a package. The names used in it
1.76 rillig 5800: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5801: which means that it cannot register files outside this directory (absolute
5802: path names are not allowed). Despite this restriction, some packages need
5803: to install files outside this location; e.g., under
1.76 rillig 5804: <code class="filename">${VARBASE}</code> or
1.87 wiz 5805: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5806: is to create such files during installation time by using
5807: installation scripts.</p>
5808: <p>The generic installation scripts are shell scripts that can
5809: contain arbitrary code. The list of scripts to execute is taken from
5810: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5811: <code class="filename">INSTALL</code>. A similar variable exists for package
5812: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5813: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5814: commands, so they have the potential to create and manage files
5815: anywhere in the file system.</p>
5816: <p>Using these general installation files is not recommended, but
5817: may be needed in some special cases. One reason for avoiding them is
5818: that the user has to trust the packager that there is no unwanted or
5819: simply erroneous code included in the installation script. Also,
5820: previously there were many similar scripts for the same functionality,
5821: and fixing a common error involved finding and changing all of
5822: them.</p>
5823: <p>The pkginstall framework offers another, standardized way. It
5824: provides generic scripts to abstract the manipulation of such files
5825: and directories based on variables set in the package's
5826: <code class="filename">Makefile</code>. The rest of this section describes
5827: these variables.</p>
1.75 rillig 5828: <div class="sect2" lang="en">
5829: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5830: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5831: <p>The following variables can be set to request the creation of
5832: directories anywhere in the file system:</p>
5833: <div class="itemizedlist"><ul type="disc">
5834: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5835: contain a list of directories that should be created and should attempt
5836: to be destroyed by the installation scripts. The difference between
5837: the two is that the latter prompts the administrator to remove any
5838: directories that may be left after deinstallation (because they were
5839: not empty), while the former does not.</p></li>
5840: <li>
5841: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5842: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5843: which directories should be created and should attempt to be destroyed
5844: by the installation scripts. Each tuple holds the following values,
5845: separated by spaces: the directory name, its owner, its group and its
5846: numerical mode. For example:</p>
5847: <pre class="programlisting">
5848: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5849: </pre>
1.75 rillig 5850: <p>The difference between the two is exactly the same as their
5851: non-<code class="varname">PERMS</code> counterparts.</p>
5852: </li>
5853: </ul></div>
5854: </div>
5855: <div class="sect2" lang="en">
5856: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5857: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5858: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5859: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5860: To overcome this problem, the only solution is to extract the file in the
5861: known place (i.e., inside the installation prefix) and copy it to the
5862: appropriate location during installation (done by the installation scripts
5863: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5864: file</em></span> in the following paragraphs, which describe the variables
5865: that can be used to automatically and consistently handle files outside the
5866: installation prefix:</p>
5867: <div class="itemizedlist"><ul type="disc">
5868: <li>
5869: <p><code class="varname">CONF_FILES</code> and
5870: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5871: During installation time, the master file is copied to the target one
5872: if and only if the latter does not exist. Upon deinstallation, the
5873: target file is removed provided that it was not modified by the
5874: installation.</p>
5875: <p>The difference between the two is that the latter prompts the
5876: administrator to remove any files that may be left after
5877: deinstallation (because they were not empty), while the former does
5878: not.</p>
5879: </li>
5880: <li>
5881: <p><code class="varname">CONF_FILES_PERMS</code> and
5882: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5883: files as well as their target locations. For each of them, it also
5884: specifies their owner, their group and their numeric permissions, in
5885: this order. For example:</p>
5886: <pre class="programlisting">
5887: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5888: </pre>
1.75 rillig 5889: <p>The difference between the two is exactly the same as their
5890: non-<code class="varname">PERMS</code> counterparts.</p>
5891: </li>
5892: </ul></div>
5893: </div>
5894: </div>
5895: <div class="sect1" lang="en">
5896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5897: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75 rillig 5898: <p>Configuration files are special in the sense that they are installed
5899: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5900: need special treatment during installation (most of which is automated by
5901: pkginstall). The main concept you must bear in mind is that files marked
5902: as configuration files are automatically copied to the right place (somewhere
5903: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5904: and only if</em></span> they didn't exist before. Similarly, they will not
5905: be removed if they have local modifications. This ensures that
5906: administrators never lose any custom changes they may have made.</p>
5907: <div class="sect2" lang="en">
5908: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5909: <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 5910: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5911: specifies where configuration files shall be installed. Its contents are
5912: set based upon the following variables:</p>
5913: <div class="itemizedlist"><ul type="disc">
5914: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5915: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5916: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5917: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5918: Packages must not use it directly.</p></li>
5919: <li>
5920: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5921: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5922: for the package being built shall be installed. The definition of this
5923: variable only makes sense in the package's
1.76 rillig 5924: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5925: <p>As an example, consider the Apache package,
1.91 rillig 5926: <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 5927: configuration files under the
1.76 rillig 5928: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5929: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5930: Makefile.</p>
5931: </li>
5932: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5933: variable that holds this package's configuration directory (if
5934: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5935: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5936: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5937: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5938: directory where the configuration files for the package identified by
5939: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5940: </ul></div>
5941: <p>Based on the above variables, pkginstall determines the value of
5942: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5943: variable that can be used within a package to refer to its configuration
5944: directory. The algorithm used to set its value is basically the
5945: following:</p>
5946: <div class="orderedlist"><ol type="1">
5947: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
5948: its value is used.</p></li>
5949: <li><p>If the previous variable is not defined but
5950: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5951: <code class="filename">Makefile</code>, the resulting value is
5952: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 5953: <li><p>Otherwise, it is set to
1.76 rillig 5954: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5955: </ol></div>
1.76 rillig 5956: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90 rillig 5957: 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 5958: </div>
5959: <div class="sect2" lang="en">
5960: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5961: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5962: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5963: known place, you need to teach each package where it shall install its
5964: files. In some cases you will have to patch the package Makefiles to
5965: achieve it. If you are lucky, though, it may be as easy as passing an
5966: extra flag to the configuration script; this is the case of GNU Autoconf-
5967: generated files:</p>
5968: <pre class="programlisting">
5969: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5970: </pre>
1.75 rillig 5971: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5972: for</em></span> its configuration files, not where they will be originally
5973: installed (although the difference is never explicit,
5974: unfortunately).</p>
5975: </div>
5976: <div class="sect2" lang="en">
5977: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5978: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5979: <p>As said before, pkginstall automatically handles configuration files.
5980: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5981: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5982: directly</strong></span>. Bad news is that many software installation scripts
5983: will, out of the box, mess with the contents of that directory. So what is
5984: the correct procedure to fix this issue?</p>
5985: <p>You must teach the package (usually by manually patching it) to
5986: install any configuration files under the examples hierarchy,
1.76 rillig 5987: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5988: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5989: has the original copies available.</p>
5990: <p>Once the required configuration files are in place (i.e., under the
5991: examples hierarchy), the pkginstall framework can use them as master copies
5992: during the package installation to update what is in
1.76 rillig 5993: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5994: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90 rillig 5995: 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 5996: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 5997: <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 5998: <pre class="programlisting">
5999: EGDIR= ${PREFIX}/share/doc/mutt/samples
6000: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6001: </pre>
1.75 rillig 6002: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6003: package and has no meaning outside it.</p>
6004: </div>
6005: <div class="sect2" lang="en">
6006: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6007: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6008: <p>The automatic copying of config files can be toggled by setting the
6009: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6010: installation.</p>
6011: </div>
6012: </div>
6013: <div class="sect1" lang="en">
6014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6015: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75 rillig 6016: <p>System startup scripts are special files because they must be
6017: installed in a place known by the underlying OS, usually outside the
1.90 rillig 6018: 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 6019: can be used. However, pkginstall provides a special mechanism to handle
6020: these files.</p>
6021: <p>In order to provide system startup scripts, the package has
6022: to:</p>
6023: <div class="orderedlist"><ol type="1">
1.76 rillig 6024: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6025: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6026: <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 6027: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6028: <li>
6029: <p>Tell pkginstall to handle it, appending the name of the script,
6030: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6031: Continuing the previous example:</p>
6032: <pre class="programlisting">
6033: RCD_SCRIPTS+= cupsd
1.1 grant 6034: </pre>
1.75 rillig 6035: </li>
6036: </ol></div>
6037: <p>Once this is done, pkginstall will do the following steps for each
6038: script in an automated fashion:</p>
6039: <div class="orderedlist"><ol type="1">
6040: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6041: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6042: variable.</p></li>
6043: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6044: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6045: that this master file must be explicitly registered in the
1.76 rillig 6046: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6047: <li><p>Add code to the installation scripts to copy the startup script
6048: from the examples hierarchy into the system-wide startup scripts
6049: directory.</p></li>
6050: </ol></div>
6051: <div class="sect2" lang="en">
6052: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6053: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6054: <p>The automatic copying of config files can be toggled by setting the
6055: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6056: installation. Note that the scripts will be always copied inside the
1.76 rillig 6057: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6058: matter what the value of this variable is.</p>
6059: </div>
6060: </div>
6061: <div class="sect1" lang="en">
6062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6063: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75 rillig 6064: <p>If a package needs to create special users and/or groups during
6065: installation, it can do so by using the pkginstall framework.</p>
6066: <p>Users can be created by adding entries to the
6067: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6068: syntax:</p>
6069: <pre class="programlisting">
6070: user:group
1.1 grant 6071: </pre>
1.87 wiz 6072: <p>Further specification of user details may be done by setting
6073: per-user variables.
6074: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6075: numeric UID for the user.
6076: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6077: user's description or comment.
6078: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6079: user's home directory, and defaults to
6080: <code class="filename">/nonexistent</code> if not specified.
6081: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6082: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6083: not specified.</p>
1.75 rillig 6084: <p>Similarly, groups can be created by adding entries to the
6085: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6086: <pre class="programlisting">
6087: group
1.1 grant 6088: </pre>
1.93 rillig 6089: <p>The numeric GID of the group may be set by defining
1.75 rillig 6090: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6091: <p>If a package needs to create the users and groups at an earlier
6092: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6093: either <code class="literal">configure</code> or <code class="literal">build</code> to
6094: indicate the phase before which the users and groups are created. In
6095: this case, the numeric UIDs and GIDs of the created users and groups
6096: are automatically hardcoded into the final installation scripts.</p>
6097: </div>
6098: <div class="sect1" lang="en">
6099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6100: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75 rillig 6101: <p>Packages that install system shells should register them in the shell
1.76 rillig 6102: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6103: administrator. This must be done from the installation scripts to keep
6104: binary packages working on any system. pkginstall provides an easy way to
6105: accomplish this task.</p>
6106: <p>When a package provides a shell interpreter, it has to set the
6107: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6108: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6109: 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 6110: <pre class="programlisting">
6111: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6112: </pre>
1.75 rillig 6113: <div class="sect2" lang="en">
6114: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6115: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6116: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6117: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6118: environment variable to <code class="literal">NO</code>.</p>
6119: </div>
6120: </div>
6121: <div class="sect1" lang="en">
6122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6123: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75 rillig 6124: <p>Packages that install X11 fonts should update the database files
6125: that index the fonts within each fonts directory. This can easily be
6126: accomplished within the pkginstall framework.</p>
6127: <p>When a package installs X11 fonts, it must list the directories in
6128: which fonts are installed in the
6129: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6130: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6131: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6132: installation scripts to run the appropriate commands to update the fonts
6133: database files within each of those directories. For convenience, if the
6134: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6135: 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 6136: <pre class="programlisting">
6137: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6138: </pre>
1.75 rillig 6139: <div class="sect2" lang="en">
6140: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6141: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6142: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6143: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6144: environment variable to <code class="literal">NO</code>.</p>
6145: </div>
6146: </div>
6147: </div>
6148: <div class="chapter" lang="en">
6149: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6150: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75 rillig 6151: <div class="toc">
6152: <p><b>Table of Contents</b></p>
6153: <dl>
1.90 rillig 6154: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
6155: <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>
6156: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75 rillig 6157: </dl>
6158: </div>
6159: <p>Many packages have the ability to be built to support different
1.76 rillig 6160: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6161: in pkgsrc that provides generic handling of those options that
6162: determine different ways in which the packages can be built. It's
6163: possible for the user to specify exactly which sets of options will be
6164: built into a package or to allow a set of global default options
6165: apply.</p>
6166: <div class="sect1" lang="en">
6167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6168: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75 rillig 6169: <p>Global default options are listed in
6170: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6171: that should be built into every package if that option is supported.
1.76 rillig 6172: This variable should be set in <code class="filename">/etc/mk.conf</code>.</p>
1.75 rillig 6173: </div>
6174: <div class="sect1" lang="en">
6175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 6176: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code>
6177: </h2></div></div></div>
1.75 rillig 6178: <p>The following example shows how
1.76 rillig 6179: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6180: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6181: <code class="filename">Makefile</code>, or in a file,
6182: e.g. <code class="filename">options.mk</code>, that is included by the
6183: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6184: <pre class="programlisting">
6185: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6186: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6187: PKG_OPTIONS_OPTIONAL_GROUPS= database
6188: PKG_OPTIONS_GROUP.database= mysql pgsql
6189: PKG_SUGGESTED_OPTIONS= wibble-foo
6190: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6191: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
1.1 grant 6192:
1.75 rillig 6193: .include "../../mk/bsd.prefs.mk"
1.69 rillig 6194:
1.75 rillig 6195: # this package was previously named wibble2
6196: .if defined(PKG_OPTIONS.wibble2)
6197: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6198: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
1.78 rillig 6199: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
1.75 rillig 6200: .endif
1.69 rillig 6201:
1.75 rillig 6202: .include "../../mk/bsd.options.mk"
1.69 rillig 6203:
1.75 rillig 6204: # Package-specific option-handling
1.69 rillig 6205:
1.75 rillig 6206: ###
6207: ### FOO support
6208: ###
6209: .if !empty(PKG_OPTIONS:Mwibble-foo)
6210: CONFIGURE_ARGS+= --enable-foo
6211: .endif
1.69 rillig 6212:
1.75 rillig 6213: ###
6214: ### LDAP support
6215: ###
6216: .if !empty(PKG_OPTIONS:Mldap)
1.77 rillig 6217: . include "../../databases/openldap-client/buildlink3.mk"
6218: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
1.75 rillig 6219: .endif
1.69 rillig 6220:
1.75 rillig 6221: ###
6222: ### database support
6223: ###
6224: .if !empty(PKG_OPTIONS:Mmysql)
6225: . include "../../mk/mysql.buildlink3.mk"
6226: .endif
6227: .if !empty(PKG_OPTIONS:Mpgsql)
6228: . include "../../mk/pgsql.buildlink3.mk"
6229: .endif
6230: </pre>
6231: <p>The first section contains the information about which build
6232: options are supported by the package, and any default options settings
6233: if needed.</p>
6234: <div class="orderedlist"><ol type="1">
6235: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6236: <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
6237: options. It should be set to
1.78 rillig 6238: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6239: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6240: at the point where the options are processed.</p></li>
1.75 rillig 6241: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6242: build options supported by the package.</p></li>
6243: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6244: list of names of groups of mutually exclusive options. The options in
6245: each group are listed in
6246: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6247: The most specific setting of any option from the group takes
6248: precedence over all other options in the group. Options from the
6249: groups will be automatically added to
6250: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6251: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6252: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6253: packages will fail if no option from the group is
6254: selected.</p></li>
6255: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6256: of names of sets of options. At least one option from each set must
6257: be selected. The options in each set are listed in
6258: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6259: Options from the sets will be automatically added to
6260: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6261: fail if no option from the set is selected.</p></li>
6262: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6263: build options which are enabled by default.</p></li>
6264: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6265: of
6266: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.76 rillig 6267: pairs that map legacy <code class="filename">/etc/mk.conf</code> variables to
1.75 rillig 6268: their option counterparts. Pairs should be added with
6269: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6270: warning will be issued if the user uses a legacy
6271: variable.</p></li>
6272: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6273: of
6274: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6275: pairs that map options that have been renamed to their new
6276: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6277: the listing of global legacy options. A warning will be issued if
6278: the user uses a legacy option.</p></li>
6279: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6280: options implied by deprecated variables used. This can be used for
6281: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6282: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6283: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6284: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6285: a list of warnings about deprecated variables or options used, and
6286: what to use instead.</p></li>
6287: </ol></div>
6288: <p>A package should never modify
6289: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6290: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6291: To suggest a default set of options, use
6292: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6293: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6294: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6295: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6296: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6297: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6298: happen with platform-specific options if none of them is supported on
6299: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6300: empty list and the package is otherwise treated as not using the
6301: options framework.</p>
1.76 rillig 6302: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6303: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6304: build options, properly filtered to remove unsupported and duplicate
6305: options.</p>
6306: <p>The remaining sections contain the logic that is specific to
6307: each option. The correct way to check for an option is to check
6308: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6309: <pre class="programlisting">
6310: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6311: </pre>
6312: </div>
6313: <div class="sect1" lang="en">
6314: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6315: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75 rillig 6316: <p>Options that enable similar features in different packages (like
6317: optional support for a library) should use a common name in all
6318: packages that support it (like the name of the library). If another
6319: package already has an option with the same meaning, use the same
6320: name.</p>
6321: <p>Options that enable features specific to one package, where it's
6322: unlikely that another (unrelated) package has the same (or a similar)
6323: optional feature, should use a name prefixed with
6324: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6325: <p>If a group of related packages share an optional feature
6326: specific to that group, prefix it with the name of the
6327: “<span class="quote">main</span>” package
6328: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6329: <p>For new options, add a line to
1.76 rillig 6330: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6331: fields, separated by tab. The first field is the option name, the
6332: second its description. The description should be a whole sentence
6333: (starting with an uppercase letter and ending with a period) that
6334: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6335: support.</span>” The file is sorted by option names.</p>
6336: </div>
6337: </div>
6338: <div class="chapter" lang="en">
6339: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6340: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75 rillig 6341: <div class="toc">
6342: <p><b>Table of Contents</b></p>
6343: <dl>
1.90 rillig 6344: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
6345: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
6346: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
6347: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
6348: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6349: <dd><dl>
6350: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
6351: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
6352: </dl></dd>
6353: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6354: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6355: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6356: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6357: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6358: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6359: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6360: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6361: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6362: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6363: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
6364: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75 rillig 6365: </dl>
6366: </div>
6367: <div class="sect1" lang="en">
6368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6369: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75 rillig 6370: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6371: built. Building a package is separated into different
6372: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6373: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6374: described in the following sections. Each phase is splitted into
6375: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6376: containing phase, prefixed by one of <code class="varname">pre-</code>,
6377: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6378: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6379: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.75 rillig 6380: <p>The basic steps for building a program are always the same. First
1.87 wiz 6381: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6382: the local system and then extracted. After any pkgsrc-specific patches
6383: to compile properly are applied, the software can be configured, then
6384: built (usually by compiling), and finally the generated binaries, etc.
6385: can be put into place on the system.</p>
1.75 rillig 6386: </div>
6387: <div class="sect1" lang="en">
6388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6389: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75 rillig 6390: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6391: the next section, here's a brief discussion on where programs are
6392: installed, and which variables influence this.</p>
1.75 rillig 6393: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6394: where all files of the final program shall be installed. It is
6395: usually set to <code class="varname">LOCALBASE</code>
6396: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6397: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6398: <code class="varname">PREFIX</code> needs to be put
6399: into the various places in the program's source where paths to
1.90 rillig 6400: 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 6401: <p>When choosing which of these variables to use,
1.87 wiz 6402: follow the following rules:</p>
1.75 rillig 6403: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6404: <li><p><code class="varname">PREFIX</code> always points to the location
6405: where the current pkg will be installed. When referring to a
6406: pkg's own installation path, use
6407: “<span class="quote">${PREFIX}</span>”.</p></li>
6408: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6409: are installed. If you need to construct a -I or -L argument
6410: to the compiler to find includes and libraries installed by
6411: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6412: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6413: installed all packages in <code class="filename">/usr/local</code>. As
6414: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6415: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6416: <li><p><code class="varname">X11BASE</code> is where the actual X11
6417: distribution (from xsrc, etc.) is installed. When looking for
6418: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6419: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6420: <li>
6421: <p>X11-based packages are special in that they may be
6422: installed in either <code class="varname">X11BASE</code> or
6423: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6424: <p>Usually, X11 packages should be installed under
1.88 wiz 6425: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6426: will need to include
6427: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6428: request the presence of X11 and to get the right compilation
6429: flags.</p>
1.75 rillig 6430: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6431: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6432: files. These packages are special and they must be placed under
6433: <code class="varname">X11BASE</code>. To accomplish this, set either
6434: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6435: your package.</p>
1.75 rillig 6436: <p>Some notes: If you need
1.87 wiz 6437: to find includes or libraries installed by a pkg that has
6438: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6439: its pkg <code class="filename">Makefile</code>, you need to look in
6440: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6441: <code class="filename">${LOCALBASE}</code>. To force installation of
6442: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6443: <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 6444: is enabled by default.</p>
1.75 rillig 6445: </li>
1.88 wiz 6446: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6447: the installed location of an X11
6448: package. <code class="varname">X11PREFIX</code> will be set to
6449: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6450: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6451: installed.</p></li>
6452: <li>
6453: <p>If xpkgwedge is installed, it is possible to have some
6454: packages installed in <code class="varname">X11BASE</code> and some in
6455: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6456: installed package, the <code class="varname">EVAL_PREFIX</code>
6457: definition can be used. It takes pairs in the format
6458: “<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>
6459: variable <code class="varname">DIRNAME</code> will be set to the prefix
6460: of the installed package <package>, or
6461: “<span class="quote">${X11PREFIX}</span>” if the package is not
6462: installed.</p>
1.75 rillig 6463: <p>This is best illustrated by example.</p>
6464: <p>The following lines are taken from
1.87 wiz 6465: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6466: <pre class="programlisting">
1.87 wiz 6467: EVAL_PREFIX+= GTKDIR=gtk+
6468: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6469: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6470: CONFIGURE_ARGS+= --enable-multibyte
6471: </pre>
1.88 wiz 6472: <p>Specific defaults can be defined for the packages
6473: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6474: definition of the form:</p>
1.75 rillig 6475: <pre class="programlisting">
1.87 wiz 6476: GTKDIR_DEFAULT= ${LOCALBASE}
6477: </pre>
1.75 rillig 6478: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6479: to the first definition in
6480: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6481: </li>
1.76 rillig 6482: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87 wiz 6483: 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
6484: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6485: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6486: </ul></div>
6487: </div>
6488: <div class="sect1" lang="en">
6489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6490: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75 rillig 6491: <p>When building a package, a number of directories is used to store
1.87 wiz 6492: source files, temporary files, pkgsrc-internal files, and so on. These
6493: directories are explained here.</p>
1.75 rillig 6494: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6495: are two common base directories for these relative directories:
6496: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6497: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6498: inside the package itself.</p>
1.75 rillig 6499: <div class="variablelist"><dl>
6500: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6501: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6502: root directory. Generally, you don't need
6503: it.</p></dd>
1.75 rillig 6504: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6505: <dd><p>This is a pathname relative to
1.87 wiz 6506: <code class="varname">PKGSRCDIR</code> that points to the current
6507: package.</p></dd>
1.75 rillig 6508: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6509: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6510: where all work takes place. The distfiles are extracted to this
1.87 wiz 6511: directory. It also contains temporary directories and log files used by
6512: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6513: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6514: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6515: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6516: where the distfiles are extracted. It is usually a direct subdirectory
6517: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6518: that isn't hidden. This variable may be changed by a package
6519: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6520: </dl></div>
6521: </div>
6522: <div class="sect1" lang="en">
6523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6524: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75 rillig 6525: <p>You can run a particular phase by typing <span><strong class="command">make
1.87 wiz 6526: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6527: phase. This will automatically run all phases that are required for this
6528: phase. The default phase is <code class="varname">build</code>, that is, when you
6529: run <span><strong class="command">make</strong></span> without parameters in a package directory,
6530: the package will be built, but not installed.</p>
1.75 rillig 6531: </div>
6532: <div class="sect1" lang="en">
6533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6534: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6535: <p>The first step in building a package is to fetch the
1.88 wiz 6536: distribution files (distfiles) from the sites that are providing
6537: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6538: phase.</p>
1.81 rillig 6539: <div class="sect2" lang="en">
6540: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6541: <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 6542: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6543: defines all URLs from where the distfile, whose name is
6544: derived from the <code class="varname">DISTNAME</code> variable, is
6545: fetched. The more complicated cases are described
6546: below.</p>
6547: <p>The variable <code class="varname">DISTFILES</code> specifies
6548: the list of distfiles that have to be fetched. Its value
6549: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6550: so that most packages don't need to define it at all.
6551: <code class="varname">EXTRACT_SUFX</code> is
6552: <code class="literal">.tar.gz</code> by default, but can be changed
6553: freely. Note that if your package requires additional
6554: distfiles to the default one, you cannot just append the
6555: additional filenames using the <code class="literal">+=</code>
6556: operator, but you have write for example:</p>
1.81 rillig 6557: <pre class="programlisting">
1.88 wiz 6558: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6559: </pre>
6560: <p>Each distfile is fetched from a list of sites, usually
6561: <code class="varname">MASTER_SITES</code>. If the package has multiple
6562: <code class="varname">DISTFILES</code> or multiple
6563: <code class="varname">PATCHFILES</code> from different sites, you can
6564: set
6565: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6566: to the list of URLs where the file
6567: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6568: (including the suffix) can be found.</p>
6569: <pre class="programlisting">
6570: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6571: DISTFILES+= foo-file.tar.gz
6572: SITES.foo-file.tar.gz= \
6573: http://www.somewhere.com/somehow/ \
6574: http://www.somewhereelse.com/mirror/somehow/
6575: </pre>
1.81 rillig 6576: <p>When actually fetching the distfiles, each item from
1.88 wiz 6577: <code class="varname">MASTER_SITES</code> or
6578: <code class="varname">SITES.*</code> gets the name of each distfile
6579: appended to it, without an intermediate slash. Therefore,
6580: all site values have to end with a slash or other separator
6581: character. This allows for example to set
6582: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6583: that gets the name of the distfile as a parameter. In this
6584: case, the definition would look like:</p>
1.81 rillig 6585: <pre class="programlisting">
1.88 wiz 6586: MASTER_SITES= http://www.example.com/download.cgi?file=
6587: </pre>
1.81 rillig 6588: <p>There are some predefined values for
1.88 wiz 6589: <code class="varname">MASTER_SITES</code>, which can be used in
6590: packages. The names of the variables should speak for
6591: themselves.</p>
6592: <pre class="programlisting">
6593: ${MASTER_SITE_APACHE}
6594: ${MASTER_SITE_BACKUP}
6595: ${MASTER_SITE_CYGWIN}
6596: ${MASTER_SITE_DEBIAN}
6597: ${MASTER_SITE_FREEBSD}
6598: ${MASTER_SITE_FREEBSD_LOCAL}
1.93 rillig 6599: ${MASTER_SITE_GENTOO}
1.88 wiz 6600: ${MASTER_SITE_GNOME}
6601: ${MASTER_SITE_GNU}
6602: ${MASTER_SITE_GNUSTEP}
6603: ${MASTER_SITE_IFARCHIVE}
6604: ${MASTER_SITE_KDE}
6605: ${MASTER_SITE_MOZILLA}
6606: ${MASTER_SITE_MYSQL}
6607: ${MASTER_SITE_OPENOFFICE}
6608: ${MASTER_SITE_PERL_CPAN}
6609: ${MASTER_SITE_PGSQL}
6610: ${MASTER_SITE_R_CRAN}
6611: ${MASTER_SITE_SOURCEFORGE}
6612: ${MASTER_SITE_SOURCEFORGE_JP}
6613: ${MASTER_SITE_SUNSITE}
6614: ${MASTER_SITE_SUSE}
6615: ${MASTER_SITE_TEX_CTAN}
6616: ${MASTER_SITE_XCONTRIB}
6617: ${MASTER_SITE_XEMACS}
6618: </pre>
6619: <p>Some explanations for the less self-explaining ones:
6620: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.93 rillig 6621: 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
6622: 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 6623: <p>If you choose one of these predefined sites, you may
6624: want to specify a subdirectory of that site. Since these
6625: macros may expand to more than one actual site, you
6626: <span class="emphasis"><em>must</em></span> use the following construct to
6627: specify a subdirectory:</p>
1.81 rillig 6628: <pre class="programlisting">
1.88 wiz 6629: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6630: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6631: </pre>
1.81 rillig 6632: <p>Note the trailing slash after the subdirectory
1.88 wiz 6633: name.</p>
1.81 rillig 6634: </div>
6635: <div class="sect2" lang="en">
6636: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6637: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6638: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6639: all the distfiles exist in a local directory
1.93 rillig 6640: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6641: user). If the files do not exist, they are fetched using
6642: commands of the form</p>
1.75 rillig 6643: <pre class="programlisting">
1.88 wiz 6644: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6645: </pre>
6646: <p>where <code class="literal">${site}</code> varies through
6647: several possibilities in turn: first,
6648: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6649: sites specified in either <code class="varname">SITES.file</code> if
6650: defined, else <code class="varname">MASTER_SITES</code> or
6651: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6652: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6653: all except the first and the last can be optionally sorted
6654: by the user, via setting either
6655: <code class="varname">MASTER_SORT_RANDOM</code>, and
6656: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6657: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.81 rillig 6658: </div>
1.75 rillig 6659: </div>
6660: <div class="sect1" lang="en">
6661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6662: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6663: <p>After the distfile(s) are fetched, their checksum is
6664: generated and compared with the checksums stored in the
6665: distinfo file. If the checksums don't match, the build is
6666: aborted. This is to ensure the same distfile is used for
6667: building, and that the distfile wasn't changed, e.g. by some
6668: malign force, deliberately changed distfiles on the master
6669: distribution site or network lossage.</p>
1.75 rillig 6670: </div>
6671: <div class="sect1" lang="en">
6672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6673: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6674: <p>When the distfiles are present on the local system, they
1.88 wiz 6675: need to be extracted, as they usually come in the form of some
6676: compressed archive format.</p>
1.75 rillig 6677: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6678: extracted. If you only need some of them, you can set the
6679: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6680: files.</p>
6681: <p>Extracting the files is usually done by a little
1.93 rillig 6682: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6683: already knows how to extract various archive formats, so most
6684: likely you will not need to change anything here. But if you
6685: need, the following variables may help you:</p>
1.75 rillig 6686: <div class="variablelist"><dl>
6687: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6688: <dd><p>Use these variables to override the default
1.88 wiz 6689: options for an extract command, which are defined in
1.93 rillig 6690: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6691: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6692: <dd><p>This variable can be set to
1.93 rillig 6693: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
6694: default value), <code class="literal">pax</code>, or an
1.88 wiz 6695: absolute pathname pointing to the command with which tar
6696: archives should be
6697: extracted.</p></dd>
1.75 rillig 6698: </dl></div>
1.88 wiz 6699: <p>If the <code class="filename">extract</code> program doesn't
6700: serve your needs, you can also override the
6701: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6702: command used for extracting the files. This command is
6703: executed in the <code class="filename">${WRKSRC}</code>
6704: directory. During execution of this command, the shell
6705: variable <code class="varname">extract_file</code> holds the absolute
6706: pathname of the file that is going to be extracted.</p>
1.75 rillig 6707: <p>And if that still does not suffice, you can override the
1.88 wiz 6708: <code class="varname">do-extract</code> target in the package
6709: Makefile.</p>
1.75 rillig 6710: </div>
6711: <div class="sect1" lang="en">
6712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6713: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6714: <p>After extraction, all the patches named by the
1.88 wiz 6715: <code class="varname">PATCHFILES</code>, those present in the patches
6716: subdirectory of the package as well as in
6717: $LOCALPATCHES/$PKGPATH (e.g.
6718: <code class="filename">/usr/local/patches/graphics/png</code>) are
6719: applied. Patchfiles ending in <code class="filename">.Z</code> or
6720: <code class="filename">.gz</code> are uncompressed before they are
6721: applied, files ending in <code class="filename">.orig</code> or
6722: <code class="filename">.rej</code> are ignored. Any special options to
6723: <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 6724: <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 6725: <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
6726: it fail if the patches apply with some lines of fuzz. Please
6727: fix (regen) the patches so that they apply cleanly. The
6728: rationale behind this is that patches that don't apply cleanly
6729: may end up being applied in the wrong place, and cause severe
6730: harm there.</p>
1.75 rillig 6731: </div>
6732: <div class="sect1" lang="en">
6733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6734: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6735: <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 6736: </p>
1.75 rillig 6737: </div>
6738: <div class="sect1" lang="en">
6739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6740: <a name="build.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6741: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6742: linkers. The following variables can be used to tweak the
6743: wrappers.</p>
1.75 rillig 6744: <div class="variablelist"><dl>
6745: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6746: <dd><p>The command used to print progress
1.88 wiz 6747: messages. Does nothing by default. Set to
6748: <code class="literal">${ECHO}</code> to see the progress
6749: messages.</p></dd>
1.75 rillig 6750: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6751: <dd><p>This variable can be set to
1.88 wiz 6752: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6753: depending on whether you want additional information in the
6754: wrapper log file.</p></dd>
1.75 rillig 6755: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6756: <dd><p>This variable can be set to
1.88 wiz 6757: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6758: on whether the wrapper should use its cache, which will
6759: improve the speed. The default value is
6760: <code class="literal">yes</code>, but is forced to
6761: <code class="literal">no</code> if the platform does not support
6762: it.</p></dd>
1.75 rillig 6763: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6764: <dd><p>A list of reordering commands. A reordering
6765: command has the form
6766: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6767: It ensures that that
6768: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6769: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6770: </p></dd>
1.75 rillig 6771: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6772: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6773: investigate further]</p></dd>
1.75 rillig 6774: </dl></div>
6775: </div>
6776: <div class="sect1" lang="en">
6777: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6778: <a name="build.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6779: <p>Most pieces of software need information on the header
6780: files, system calls, and library routines which are available
6781: on the platform they run on. The process of determining this
6782: information is known as configuration, and is usually
6783: automated. In most cases, a script is supplied with the
6784: distfiles, and its invocation results in generation of header
6785: files, Makefiles, etc.</p>
6786: <p>If the package contains a configure script, this can be
6787: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6788: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6789: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6790: “<span class="quote">yes</span>” instead. What happens in the
6791: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6792: <pre class="programlisting">
6793: .for d in ${CONFIGURE_DIRS}
6794: cd ${WRKSRC} && cd ${d} && env ${CONFIGURE_ENV} \
6795: ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6796: .endfor
6797: </pre>
6798: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6799: “<span class="quote">.</span>”) is a list of pathnames relative to
6800: <code class="varname">WRKSRC</code>. In each of these directories, the
6801: configure script is run with the environment
6802: <code class="varname">CONFIGURE_ENV</code> and arguments
6803: <code class="varname">CONFIGURE_ARGS</code>. The variables
6804: <code class="varname">CONFIGURE_ENV</code>,
6805: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6806: “<span class="quote">./configure</span>”) and
6807: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6808: package.</p>
6809: <p>If the program uses an <code class="filename">Imakefile</code>
6810: for configuration, the appropriate steps can be invoked by
6811: setting <code class="varname">USE_IMAKE</code> to
6812: “<span class="quote">yes</span>”. (If you only want the package installed in
6813: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6814: <code class="varname">USE_X11BASE</code> instead.)</p>
1.75 rillig 6815: </div>
6816: <div class="sect1" lang="en">
6817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6818: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6819: <p>For building a package, a rough equivalent of the
6820: following code is executed.</p>
1.75 rillig 6821: <pre class="programlisting">
1.88 wiz 6822: .for d in ${BUILD_DIRS}
6823: cd ${WRKSRC} && cd ${d} && env ${MAKE_ENV} \
6824: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6825: -f ${MAKE_FILE} ${BUILD_TARGET}
6826: .endfor
6827: </pre>
6828: <p><code class="varname">BUILD_DIRS</code> (default:
6829: “<span class="quote">.</span>”) is a list of pathnames relative to
6830: <code class="varname">WRKSRC</code>. In each of these directories,
6831: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6832: <code class="varname">MAKE_ENV</code> and arguments
6833: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6834: <code class="varname">MAKE_ENV</code>,
6835: <code class="varname">BUILD_MAKE_FLAGS</code>,
6836: <code class="varname">MAKE_FILE</code> and
6837: <code class="varname">BUILD_TARGET</code> may all be changed by the
6838: package.</p>
1.75 rillig 6839: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6840: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6841: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6842: default value of <code class="varname">MAKE_FILE</code> is
6843: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6844: defaults to “<span class="quote">all</span>”.</p>
1.75 rillig 6845: </div>
6846: <div class="sect1" lang="en">
6847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6848: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6849: <p>[TODO]</p>
6850: </div>
6851: <div class="sect1" lang="en">
6852: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6853: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6854: <p>Once the build stage has completed, the final step is to
1.88 wiz 6855: install the software in public directories, so users can
6856: access the programs and files.</p>
1.75 rillig 6857: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6858: equivalent of the following code is executed. Additionally,
6859: before and after this code, much magic is performed to do
6860: consistency checks, registering the package, and so on.</p>
6861: <pre class="programlisting">
6862: .for d in ${INSTALL_DIRS}
6863: cd ${WRKSRC} && cd ${d} && env ${MAKE_ENV} \
6864: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6865: -f ${MAKE_FILE} ${BUILD_TARGET}
6866: .endfor
6867: </pre>
1.75 rillig 6868: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6869: <span class="emphasis"><em>build</em></span> phase.
6870: <code class="varname">INSTALL_DIRS</code> defaults to
6871: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
6872: is “<span class="quote">install</span>” by default, plus
6873: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
6874: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6875: defined.</p>
1.75 rillig 6876: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6877: variables are useful. They are all variations of the
6878: <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
6879: permissions preset. <code class="varname">INSTALL</code> is the plain
6880: install command. The specialized variants, together with their
6881: intended use, are:</p>
1.75 rillig 6882: <div class="variablelist"><dl>
6883: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6884: <dd><p>directories that contain
6885: binaries</p></dd>
1.75 rillig 6886: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6887: <dd><p>directories that contain
6888: scripts</p></dd>
1.75 rillig 6889: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6890: <dd><p>directories that contain shared and static
6891: libraries</p></dd>
1.75 rillig 6892: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6893: <dd><p>directories that contain data
6894: files</p></dd>
1.75 rillig 6895: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6896: <dd><p>directories that contain man
6897: pages</p></dd>
1.75 rillig 6898: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6899: <dd><p>binaries that can be stripped from debugging
6900: symbols</p></dd>
1.75 rillig 6901: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6902: <dd><p>binaries that cannot be
6903: stripped</p></dd>
1.75 rillig 6904: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6905: <dd><p>game
6906: binaries</p></dd>
1.75 rillig 6907: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6908: <dd><p>shared and static
6909: libraries</p></dd>
1.75 rillig 6910: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6911: <dd><p>data files</p></dd>
6912: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6913: <dd><p>data files for
6914: games</p></dd>
1.75 rillig 6915: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6916: <dd><p>man pages</p></dd>
6917: </dl></div>
6918: <p>Some other variables are:</p>
6919: <div class="variablelist"><dl>
6920: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6921: <dd><p>A list of directories relative to
1.88 wiz 6922: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6923: beginning of the <span class="emphasis"><em>install</em></span> phase. If
6924: this variable is set,
6925: <code class="varname">NO_MTREE</code>=“<span class="quote">yes</span>” is assumed,
6926: which means that the package claims to create all needed
6927: directories itself before installing files to it. Therefore
6928: this variable should only be set in
6929: <code class="filename">Makefile</code>s that are under control of the
6930: package's author. The directories are created with the
6931: correct ownership, depending on their
6932: name.</p></dd>
1.75 rillig 6933: </dl></div>
6934: </div>
6935: <div class="sect1" lang="en">
6936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6937: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6938: <p>Once the install stage has completed, a binary package of
6939: the installed files can be built. These binary packages can be
6940: used for quick installation without previous compilation, e.g. by
6941: the <span><strong class="command">make bin-install</strong></span> or by using
6942: <span><strong class="command">pkg_add</strong></span>.</p>
6943: <p>By default, the binary packages are created in
6944: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6945: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6946: one for each category in the <code class="varname">CATEGORIES</code>
6947: variable. <code class="varname">PACKAGES</code> defaults to
6948: <code class="filename">pkgsrc/packages</code>.</p>
6949: </div>
6950: <div class="sect1" lang="en">
6951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6952: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88 wiz 6953: <p>Once you're finished with a package, you can clean the work
6954: directory by running <span><strong class="command">make clean</strong></span>. If you want
6955: to clean the work directories of all dependencies too, use
6956: <span><strong class="command">make clean-depends</strong></span>.</p>
1.75 rillig 6957: </div>
6958: <div class="sect1" lang="en">
6959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6960: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75 rillig 6961: <div class="variablelist"><dl>
6962: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6963: <dd><p>For any of the main targets described in the
6964: previous section, two auxiliary targets exist with
1.87 wiz 6965: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
6966: prefix for the main target's name. These targets are
1.88 wiz 6967: invoked before and after the main target is called,
6968: allowing extra configuration or installation steps be
6969: performed from a package's Makefile, for example, which
6970: a program's configure script or install target
6971: omitted.</p></dd>
1.75 rillig 6972: <dt><span class="term">do-*</span></dt>
1.88 wiz 6973: <dd><p>Should one of the main targets do the wrong thing,
6974: and should there be no variable to fix this, you can
6975: redefine it with the do-* target. (Note that redefining
6976: the target itself instead of the do-* target is a bad
6977: idea, as the pre-* and post-* targets won't be called
6978: anymore, etc.) You will not usually need to do
6979: this.</p></dd>
1.75 rillig 6980: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6981: <dd>
6982: <p>If you did a <span><strong class="command">make install</strong></span> and
6983: you noticed some file was not installed properly, you
6984: can repeat the installation with this target, which will
6985: ignore the “<span class="quote">already installed</span>” flag.</p>
6986: <p>This is the default value of
6987: <code class="varname">DEPENDS_TARGET</code> except in the case of
6988: <span><strong class="command">make update</strong></span> and <span><strong class="command">make
6989: package</strong></span>, where the defaults are
6990: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
6991: respectively.</p>
6992: </dd>
1.75 rillig 6993: <dt><span class="term">deinstall</span></dt>
6994: <dd>
1.88 wiz 6995: <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
6996: current directory, effectively de-installing the
6997: package. The following variables can be used to tune the
6998: behaviour:</p>
1.75 rillig 6999: <div class="variablelist"><dl>
7000: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7001: <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>
7002: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7003: <dd><p>Remove all packages that require (depend on)
7004: the given package. This can be used to remove any
7005: packages that may have been pulled in by a given
7006: package, e.g. if <span><strong class="command">make deinstall
1.87 wiz 7007: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7008: <code class="filename">pkgsrc/x11/kde</code>, this is
7009: likely to remove whole KDE. Works by adding
7010: “<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>
7011: command line.</p></dd>
1.75 rillig 7012: </dl></div>
7013: </dd>
1.88 wiz 7014: <dt><span class="term">bin-install</span></dt>
7015: <dd><p>Install a binary package from local disk and via FTP
7016: from a list of sites (see the
7017: <code class="varname">BINPKG_SITES</code> variable), and do a
7018: <span><strong class="command">make package</strong></span> if no binary package is
7019: available anywhere. The arguments given to
7020: <span><strong class="command">pkg_add</strong></span> can be set via
7021: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7022: operation, etc.</p></dd>
1.75 rillig 7023: <dt><span class="term">update</span></dt>
7024: <dd>
1.88 wiz 7025: <p>This target causes the current package to be
7026: updated to the latest version. The package and all
7027: depending packages first get de-installed, then current
7028: versions of the corresponding packages get compiled and
7029: installed. This is similar to manually noting which
7030: packages are currently installed, then performing a
7031: series of <span><strong class="command">make deinstall</strong></span> and
7032: <span><strong class="command">make install</strong></span> (or whatever
7033: <code class="varname">UPDATE_TARGET</code> is set to) for these
7034: packages.</p>
7035: <p>You can use the “<span class="quote">update</span>” target to
7036: resume package updating in case a previous <span><strong class="command">make
7037: update</strong></span> was interrupted for some reason.
7038: However, in this case, make sure you don't call
7039: <span><strong class="command">make clean</strong></span> or otherwise remove the
7040: list of dependent packages in <code class="varname">WRKDIR</code>.
7041: Otherwise, you lose the ability to automatically update
7042: the current package along with the dependent packages
7043: you have installed.</p>
7044: <p>Resuming an interrupted <span><strong class="command">make
7045: update</strong></span> will only work as long as the package
7046: tree remains unchanged. If the source code for one of
7047: the packages to be updated has been changed, resuming
7048: <span><strong class="command">make update</strong></span> will most certainly
7049: fail!</p>
7050: <p>The following variables can be used either on the
7051: command line or in <code class="filename">/etc/mk.conf</code> to
7052: alter the behaviour of <span><strong class="command">make
7053: update</strong></span>:</p>
1.75 rillig 7054: <div class="variablelist"><dl>
7055: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7056: <dd><p>Install target to recursively use for the
7057: updated package and the dependent packages.
7058: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7059: set, “<span class="quote">install</span>” otherwise for
7060: <span><strong class="command">make update</strong></span>. Other good
7061: targets are “<span class="quote">package</span>” or
7062: “<span class="quote">bin-install</span>”. Do not set this to
7063: “<span class="quote">update</span>” or you will get stuck in an
7064: endless loop!</p></dd>
1.75 rillig 7065: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7066: <dd><p>Don't clean up after updating. Useful if
7067: you want to leave the work sources of the updated
7068: packages around for inspection or other purposes.
7069: Be sure you eventually clean up the source tree
7070: (see the “<span class="quote">clean-update</span>” target below)
7071: or you may run into troubles with old source code
7072: still lying around on your next
7073: <span><strong class="command">make</strong></span> or <span><strong class="command">make
7074: update</strong></span>.</p></dd>
1.75 rillig 7075: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7076: <dd><p>Deinstall each package before installing
7077: (making <code class="varname">DEPENDS_TARGET</code>). This
7078: may be necessary if the
7079: “<span class="quote">clean-update</span>” target (see below) was
7080: called after interrupting a running <span><strong class="command">make
7081: update</strong></span>.</p></dd>
1.75 rillig 7082: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7083: <dd><p>Allows you to disable recursion and hardcode
7084: the target for packages. The default is
7085: “<span class="quote">update</span>” for the update target,
7086: facilitating a recursive update of prerequisite
7087: packages. Only set
7088: <code class="varname">DEPENDS_TARGET</code> if you want to
7089: disable recursive updates. Use
7090: <code class="varname">UPDATE_TARGET</code> instead to just
7091: set a specific target for each package to be
7092: installed during <span><strong class="command">make update</strong></span>
7093: (see above).</p></dd>
1.75 rillig 7094: </dl></div>
7095: </dd>
7096: <dt><span class="term">clean-update</span></dt>
7097: <dd>
1.88 wiz 7098: <p>Clean the source tree for all packages that would
7099: get updated if <span><strong class="command">make update</strong></span> was called
7100: from the current directory. This target should not be
7101: used if the current package (or any of its depending
7102: packages) have already been de-installed (e.g., after
7103: calling <span><strong class="command">make update</strong></span>) or you may lose
7104: some packages you intended to update. As a rule of
7105: thumb: only use this target <span class="emphasis"><em>before</em></span>
7106: the first time you run <span><strong class="command">make update</strong></span>
7107: and only if you have a dirty package tree (e.g., if you
7108: used <code class="varname">NOCLEAN</code>).</p>
7109: <p>If you are unsure about whether your tree is
7110: clean, you can either perform a <span><strong class="command">make
7111: clean</strong></span> at the top of the tree, or use the
7112: following sequence of commands from the directory of the
7113: package you want to update (<span class="emphasis"><em>before</em></span>
7114: running <span><strong class="command">make update</strong></span> for the first
7115: time, otherwise you lose all the packages you wanted to
7116: update!):</p>
1.87 wiz 7117: <pre class="screen">
7118: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7119: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7120: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7121: </pre>
1.88 wiz 7122: <p>The following variables can be used either on the
7123: command line or in <code class="filename">/etc/mk.conf</code> to
7124: alter the behaviour of <span><strong class="command">make
7125: clean-update</strong></span>:</p>
1.75 rillig 7126: <div class="variablelist"><dl>
7127: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.88 wiz 7128: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
7129: reconstruct the list of directories to update for
7130: this package. Only use this if <span><strong class="command">make
7131: update</strong></span> successfully installed all
7132: packages you wanted to update. Normally, this is
7133: done automatically on <span><strong class="command">make
7134: update</strong></span>, but may have been suppressed by
7135: the <code class="varname">NOCLEAN</code> variable (see
7136: above).</p></dd>
1.75 rillig 7137: </dl></div>
7138: </dd>
1.88 wiz 7139: <dt><span class="term">replace</span></dt>
7140: <dd>
7141: <p>Update the installation of the current package. This
7142: differs from update in that it does not replace dependent
1.93 rillig 7143: 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 7144: target to work.</p>
7145: <p><span class="emphasis"><em>Be careful when using this
7146: target!</em></span> There are no guarantees that dependent
7147: packages will still work, in particular they will most
7148: certainly break if you <span><strong class="command">make replace</strong></span> a
7149: library package whose shared library major version changed
7150: between your installed version and the new one. For this
7151: reason, this target is not officially supported and only
7152: recommended for advanced users.</p>
7153: </dd>
1.75 rillig 7154: <dt><span class="term">info</span></dt>
7155: <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 7156: package. You can use this to check which version of a
7157: package is installed.</p></dd>
7158: <dt><span class="term">index</span></dt>
7159: <dd>
7160: <p>This is a top-level command, i.e. it should be used in
7161: the <code class="filename">pkgsrc</code> directory. It creates a
7162: database of all packages in the local pkgsrc tree, including
7163: dependencies, comment, maintainer, and some other useful
7164: information. Individual entries are created by running
7165: <span><strong class="command">make describe</strong></span> in the packages'
7166: directories. This index file is saved as
7167: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
7168: verbose format by running <span><strong class="command">make
7169: print-index</strong></span>. You can search in it with
7170: <span><strong class="command">make search
7171: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7172: extract a list of all packages that depend on a particular
7173: one by running <span><strong class="command">make show-deps
7174: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7175: <p>Running this command takes a very long time, some
7176: hours even on fast machines!</p>
7177: </dd>
1.75 rillig 7178: <dt><span class="term">readme</span></dt>
1.88 wiz 7179: <dd>
7180: <p>This target generates a
7181: <code class="filename">README.html</code> file, which can be
1.91 rillig 7182: 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 7183: contain references to any packages which are in the
7184: <code class="varname">PACKAGES</code> directory on the local
7185: host. The generated files can be made to refer to URLs
7186: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7187: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7188: wanted to generate <code class="filename">README.html</code>
7189: files which pointed to binary packages on the local
7190: machine, in the directory
7191: <code class="filename">/usr/packages</code>, set
7192: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7193: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7194: <code class="varname">${PACKAGES}</code> directory and its
7195: subdirectories will be searched for all the binary
7196: packages.</p>
7197: <p>The target can be run at the toplevel or in category
7198: directories, in which case it descends recursively.</p>
7199: </dd>
1.75 rillig 7200: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7201: <dd><p>This is a top-level command, run it in
7202: <code class="filename">pkgsrc</code>. Use this target to create a
7203: file <code class="filename">README-all.html</code> which contains a
7204: list of all packages currently available in the NetBSD
7205: Packages Collection, together with the category they belong
7206: to and a short description. This file is compiled from the
7207: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7208: to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
7209: readme</strong></span>.</p></dd>
1.75 rillig 7210: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7211: <dd><p>This is very much the same as the
7212: “<span class="quote">readme</span>” target (see above), but is to be
7213: used when generating a pkgsrc tree to be written to a
7214: CD-ROM. This target also produces
7215: <code class="filename">README.html</code> files, and can be made
7216: to refer to URLs based on
7217: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7218: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7219: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7220: <dd><p>This target shows which distfiles and patchfiles
7221: are needed to build the package
7222: (<code class="varname">ALLFILES</code>, which contains all
7223: <code class="varname">DISTFILES</code> and
1.87 wiz 7224: <code class="varname">PATCHFILES</code>, but not
7225: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7226: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7227: <dd><p>This target shows nothing if the package is not
7228: installed. If a version of this package is installed,
7229: but is not the version provided in this version of
7230: pkgsrc, then a warning message is displayed. This target
7231: can be used to show which of your installed packages are
7232: downlevel, and so the old versions can be deleted, and
7233: the current ones added.</p></dd>
1.75 rillig 7234: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7235: <dd><p>This target shows the directory in the pkgsrc
7236: hierarchy from which the package can be built and
7237: installed. This may not be the same directory as the one
7238: from which the package was installed. This target is
7239: intended to be used by people who may wish to upgrade
7240: many packages on a single host, and can be invoked from
7241: the top-level pkgsrc Makefile by using the
1.87 wiz 7242: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
1.75 rillig 7243: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7244: <dd><p>This target shows which installed packages match
7245: the current package's <code class="varname">DEPENDS</code>. Useful
7246: if out of date dependencies are causing build
7247: problems.</p></dd>
1.75 rillig 7248: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7249: <dd><p>After a package is installed, check all its
7250: binaries and (on ELF platforms) shared libraries to see
7251: if they find the shared libs they need. Run by default
7252: if <code class="varname">PKG_DEVELOPER</code> is set in
1.87 wiz 7253: <code class="filename">/etc/mk.conf</code>.</p></dd>
1.75 rillig 7254: <dt><span class="term">print-PLIST</span></dt>
7255: <dd>
7256: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7257: upgraded pkg, this prints out an attempt to generate a
7258: new <code class="filename">PLIST</code> from a <span><strong class="command">find
7259: -newer work/.extract_done</strong></span>. An attempt is made
7260: to care for shared libs etc., but it is
1.87 wiz 7261: <span class="emphasis"><em>strongly</em></span> recommended to review the
7262: result before putting it into
7263: <code class="filename">PLIST</code>. On upgrades, it's useful to
7264: diff the output of this command against an already
7265: existing <code class="filename">PLIST</code> file.</p>
1.88 wiz 7266: <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
7267: other methods that don't update file access times, be
7268: sure to add these files manually to your
1.87 wiz 7269: <code class="filename">PLIST</code>, as the “<span class="quote">find
7270: -newer</span>” command used by this target won't catch
7271: them!</p>
1.90 rillig 7272: <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 7273: information on this target.</p>
1.75 rillig 7274: </dd>
7275: <dt><span class="term">bulk-package</span></dt>
7276: <dd>
1.88 wiz 7277: <p>Used to do bulk builds. If an appropriate binary
7278: package already exists, no action is taken. If not, this
7279: target will compile, install and package it (and its
7280: depends, if <code class="varname">PKG_DEPENDS</code> is set
7281: properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, “Configuration”</a>).
7282: After creating the binary package, the sources, the
7283: just-installed package and its required packages are
7284: removed, preserving free disk space.</p>
7285: <p><span class="emphasis"><em>Beware that this target may deinstall
7286: all packages installed on a system!</em></span></p>
1.75 rillig 7287: </dd>
7288: <dt><span class="term">bulk-install</span></dt>
7289: <dd>
1.88 wiz 7290: <p>Used during bulk-installs to install required
7291: packages. If an up-to-date binary package is available,
7292: 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,
7293: <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87 wiz 7294: but the installed binary won't be removed.</p>
1.88 wiz 7295: <p>A binary package is considered
7296: “<span class="quote">up-to-date</span>” to be installed via
7297: <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>
7298: <div class="itemizedlist"><ul type="disc">
7299: <li><p>None of the package's files
7300: (<code class="filename">Makefile</code>, ...) were modified
7301: since it was built.</p></li>
7302: <li><p>None of the package's required (binary)
7303: packages were modified since it was built.</p></li>
1.75 rillig 7304: </ul></div>
1.88 wiz 7305: <p><span class="emphasis"><em>Beware that this target may deinstall
7306: all packages installed on a system!</em></span></p>
1.75 rillig 7307: </dd>
7308: </dl></div>
7309: </div>
7310: </div>
7311: <div class="chapter" lang="en">
7312: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7313: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7314: <div class="toc">
7315: <p><b>Table of Contents</b></p>
7316: <dl>
1.90 rillig 7317: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
7318: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
7319: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75 rillig 7320: </dl>
7321: </div>
1.87 wiz 7322: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7323: by pkgsrc and also for individual packages to define what commands
7324: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7325: or for later run-time of an installed packaged (such as
7326: <code class="varname">DEPENDS</code>).
7327: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7328: package will not be used.</p>
7329: <p>When building a package, the replacement tools are
1.75 rillig 7330: made available in a directory (as symlinks or wrapper scripts)
7331: that is early in the executable search path. Just like the buildlink
1.87 wiz 7332: system, this helps with consistent builds.</p>
7333: <p>A tool may be needed to help build a specific package. For example,
7334: perl, GNU make (gmake) or yacc may be needed.</p>
7335: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7336: tool may be inefficient for building a package with pkgsrc.
7337: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7338: yacc) or a better sed.</p>
7339: <p>The tools used by a package can be listed by running
7340: <span><strong class="command">make show-tools</strong></span>.</p>
1.75 rillig 7341: <div class="sect1" lang="en">
7342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7343: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7344: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7345: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75 rillig 7346: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
7347: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
7348: These can be seen by running:
1.87 wiz 7349: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7350: <p>If a package needs a specific program to build
1.75 rillig 7351: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7352: to define the tools needed.</p>
1.75 rillig 7353: </div>
7354: <div class="sect1" lang="en">
7355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7356: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7357: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7358: and not the native version for a build dependency.
7359: And the :run means that it is used for a
7360: run-time dependencies also (and becomes a DEPENDS).
7361: The default is a build dependency which can be set with
7362: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7363: and pkg-config:build.)</p>
1.75 rillig 7364: <pre class="programlisting">
7365: USE_TOOLS+= mktemp:pkgsrc
7366: USE_TOOLS+= gmake perl:run pkg-config
7367: </pre>
1.87 wiz 7368: <p>When using the tools framework, a
1.75 rillig 7369: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7370: which contains the full path to the appropriate tool. For example,
7371: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7372: on Linux systems.</p>
7373: <p>If you always need a pkgsrc version of the
1.75 rillig 7374: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7375: </p>
7376: </div>
7377: <div class="sect1" lang="en">
7378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7379: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7380: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7381: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7382: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7383: the name of the common tools. For example:</p>
7384: <pre class="programlisting">
7385: .if exists(/usr/bin/bzcat)
7386: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7387: .elif exists(/usr/bin/bzip2)
7388: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7389: .endif
1.69 rillig 7390:
1.75 rillig 7391: TOOLS_PLATFORM.true?= true # shell builtin
7392: </pre>
7393: </div>
7394: </div>
7395: <div class="chapter" lang="en">
7396: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7397: <a name="fixes"></a>Chapter 18. Making your package work</h2></div></div></div>
1.75 rillig 7398: <div class="toc">
7399: <p><b>Table of Contents</b></p>
7400: <dl>
1.90 rillig 7401: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75 rillig 7402: <dd><dl>
1.90 rillig 7403: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
7404: <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>
7405: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
7406: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
7407: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
7408: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
7409: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
7410: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
7411: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
7412: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
7413: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7414: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7415: </dl></dd>
7416: <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>
7417: <dd><dl>
7418: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7419: <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>
7420: </dl></dd>
7421: <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>
7422: <dd><dl>
7423: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
7424: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7425: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
7426: </dl></dd>
7427: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
7428: <dd><dl>
7429: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
7430: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
7431: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
7432: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
7433: </dl></dd>
7434: <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>
7435: <dd><dl>
7436: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
7437: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
7438: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7439: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
7440: </dl></dd>
7441: <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>
7442: <dd><dl>
7443: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
7444: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
7445: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
7446: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
7447: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
7448: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
7449: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
7450: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
7451: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
7452: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
7453: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
7454: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
7455: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
7456: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
7457: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
7458: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
7459: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 7460: emulation</a></span></dt>
1.90 rillig 7461: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
7462: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.75 rillig 7463: </dl></dd>
1.90 rillig 7464: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7465: </dl>
7466: </div>
7467: <div class="sect1" lang="en">
7468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7469: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75 rillig 7470: <div class="sect2" lang="en">
7471: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7472: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7473: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7474: different platforms. As a result, it is important to ensure,
7475: where possible, that packages in pkgsrc are portable. This
7476: chapter mentions some particular details you should pay
7477: attention to while working on pkgsrc.</p>
1.78 rillig 7478: </div>
7479: <div class="sect2" lang="en">
7480: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 7481: <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>
7482: </h3></div></div></div>
1.78 rillig 7483: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7484: variables in the file pointed to by <code class="varname">MAKECONF</code>,
7485: which is <code class="filename">/etc/mk.conf</code> by default. When you
7486: want to use those variables in the preprocessor directives of
7487: <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
7488: <code class="literal">.for</code>), you need to include the file
7489: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7490: loads the user preferences.</p>
1.78 rillig 7491: <p>But note that some variables may not be completely defined
1.87 wiz 7492: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7493: included, as they may contain references to variables that are
7494: not yet defined. In shell commands this is no problem, since
7495: variables are actually macros, which are only expanded when they
7496: are used. But in the preprocessor directives mentioned above and
7497: in dependency lines (of the form <code class="literal">target:
7498: dependencies</code>) the variables are expanded at load
7499: time.</p>
1.78 rillig 7500: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7501: <h3 class="title">Note</h3>
7502: <p>Currently there is no exhaustive list of all
1.87 wiz 7503: variables that tells you whether they can be used at load time
7504: or only at run time, but it is in preparation.</p>
1.78 rillig 7505: </div>
7506: </div>
7507: <div class="sect2" lang="en">
7508: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7509: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88 wiz 7510: <p>Occasionally, packages require interaction from the user,
7511: and this can be in a number of ways:</p>
1.78 rillig 7512: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7513: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7514: interaction such as entering username/password or accepting a
7515: license on a web page.</p></li>
1.88 wiz 7516: <li><p>When extracting the distfiles, some packages may ask for
7517: passwords.</p></li>
1.78 rillig 7518: <li><p>help to configure the package before it is built</p></li>
7519: <li><p>help during the build process</p></li>
7520: <li><p>help during the installation of a package</p></li>
7521: </ul></div>
1.88 wiz 7522: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7523: provided to notify the pkgsrc mechanism of an interactive stage
7524: which will be needed, and this should be set in the package's
7525: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7526: <pre class="programlisting">
1.87 wiz 7527: INTERACTIVE_STAGE= build
7528: </pre>
1.78 rillig 7529: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7530: <pre class="programlisting">
1.87 wiz 7531: INTERACTIVE_STAGE= configure install
7532: </pre>
1.88 wiz 7533: <p>The user can then decide to skip this package by setting the
7534: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7535: </div>
7536: <div class="sect2" lang="en">
7537: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7538: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.78 rillig 7539: <p>A package may be covered by a license which the user has
1.87 wiz 7540: or has not agreed to accept. For these cases, pkgsrc contains
7541: a mechanism to note that a package is covered by a particular
7542: license, and the package cannot be built unless the user has
7543: accepted the license. (Installation of binary packages are
7544: not currently subject to this mechanism.) Packages with
7545: licenses that are either Open Source according to the Open
7546: Source Initiative or Free according to the Free Software
7547: Foundation will not be marked with a license tag. Packages
7548: with licenses that have not been determined to meet either
7549: definition will be marked with a license tag referring to the
7550: license. This will prevent building unless pkgsrc is informed
7551: that the license is acceptable, and enables displaying the
7552: license.</p>
1.78 rillig 7553: <p>The license tag mechanism is intended to address
1.87 wiz 7554: copyright-related issues surrounding building, installing and
7555: using a package, and not to address redistribution issues (see
7556: <code class="varname">RESTRICTED</code> and
7557: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7558: definition of licenses for which tags are not needed implies
7559: that packages with redistribution restrictions should have
7560: tags.</p>
7561: <p>Denoting that a package is covered by a particular license
7562: is done by placing the license in
7563: <code class="filename">pkgsrc/licenses</code> and setting the
7564: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7565: 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 7566: <pre class="programlisting">
7567: LICENSE= xv-license
7568: </pre>
7569: <p>When trying to build, the user will get a notice that the
7570: package is covered by a license which has not been
7571: accepted:</p>
7572: <pre class="programlisting">
7573: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7574: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7575: ===> To view the license, enter "/usr/bin/make show-license".
7576: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7577: ===> ACCEPTABLE_LICENSES+=xv-license
7578: *** Error code 1
7579: </pre>
1.78 rillig 7580: <p>The license can be viewed with <span><strong class="command">make
1.87 wiz 7581: show-license</strong></span>, and if it is considered appropriate,
7582: the line printed above can be added to
7583: <code class="filename">/etc/mk.conf</code> to indicate acceptance of
7584: the particular license:</p>
1.78 rillig 7585: <pre class="programlisting">
1.87 wiz 7586: ACCEPTABLE_LICENSES+=xv-license
7587: </pre>
1.78 rillig 7588: <p>When adding a package with a new license, the license
1.87 wiz 7589: text should be added to <code class="filename">pkgsrc/licenses</code>
7590: for displaying. A list of known licenses can be seen in this
1.91 rillig 7591: directory.</p>
1.78 rillig 7592: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.87 wiz 7593: <code class="varname">LICENSE=no-commercial-use</code>, and similar
7594: language is deprecated because it does not crisply refer to
7595: a particular license text. Another problem with such usage
7596: is that it does not enable a user to denote acceptance of
7597: the license for a single package without accepting the same
7598: license text for another package. In particular, this can
7599: be inappropriate when e.g. one accepts a particular license to
7600: indicate to pkgsrc that a fee has been paid.</p>
1.75 rillig 7601: </div>
7602: <div class="sect2" lang="en">
7603: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7604: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7605: <p>Some licenses restrict how software may be re-distributed.
1.87 wiz 7606: In order to satisfy these restrictions, the package system
7607: defines five make variables that can be set to note these
7608: restrictions:</p>
1.75 rillig 7609: <div class="itemizedlist"><ul type="disc">
7610: <li>
7611: <p><code class="varname">RESTRICTED</code></p>
7612: <p>This variable should be set whenever a restriction
1.87 wiz 7613: exists (regardless of its kind). Set this variable to a
7614: string containing the reason for the restriction.</p>
1.75 rillig 7615: </li>
7616: <li>
7617: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7618: <p>Binaries may not be placed on CD-ROM. Set this
1.87 wiz 7619: variable to <code class="varname">${RESTRICTED}</code> whenever a
7620: binary package may not be included on a CD-ROM.</p>
1.75 rillig 7621: </li>
7622: <li>
7623: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7624: <p>Binaries may not be placed on an FTP server. Set
1.87 wiz 7625: this variable to <code class="varname">${RESTRICTED}</code>
1.93 rillig 7626: whenever a binary package may not be made available
1.87 wiz 7627: on the Internet.</p>
1.75 rillig 7628: </li>
7629: <li>
7630: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7631: <p>Distfiles may not be placed on CD-ROM. Set this
1.87 wiz 7632: variable to <code class="varname">${RESTRICTED}</code> if
7633: re-distribution of the source code or other distfile(s) is
7634: not allowed on CD-ROMs.</p>
1.75 rillig 7635: </li>
7636: <li>
7637: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7638: <p>Distfiles may not be placed on FTP. Set this variable
1.87 wiz 7639: to <code class="varname">${RESTRICTED}</code> if re-distribution of
7640: the source code or other distfile(s) via the Internet is not
7641: allowed. If this variable is not set, the distfile(s) will
7642: be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7643: </li>
7644: </ul></div>
7645: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87 wiz 7646: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7647: generic make variables to denote restrictions is deprecated,
7648: because they unconditionally prevent users from generating
7649: binary packages!</p>
1.75 rillig 7650: </div>
7651: <div class="sect2" lang="en">
7652: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7653: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7654: <p>Your package may depend on some other package being present
1.88 wiz 7655: - and there are various ways of expressing this dependency.
7656: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7657: <code class="varname">DEPENDS</code> definitions, the
7658: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7659: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7660: to handle dependencies, and which uses the variables named above.
1.90 rillig 7661: See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7662: <p>The basic difference between the two variables is as
1.87 wiz 7663: follows: The <code class="varname">DEPENDS</code> definition registers
7664: that pre-requisite in the binary package so it will be pulled in
7665: when the binary package is later installed, whilst the
7666: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7667: dependency that is only needed for building the package.</p>
1.75 rillig 7668: <p>This means that if you only need a package present whilst
1.87 wiz 7669: you are building, it should be noted as a
7670: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7671: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7672: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7673: <pre class="programlisting">
1.87 wiz 7674: <pre-req-package-name>:../../<category>/<pre-req-package>
7675: </pre>
1.75 rillig 7676: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7677: may include any of the wildcard version numbers recognized by
7678: <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 7679: <div class="orderedlist"><ol type="1">
7680: <li>
7681: <p>If your package needs another package's binaries or
1.87 wiz 7682: libraries to build or run, and if that package has a
7683: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7684: <pre class="programlisting">
1.87 wiz 7685: .include "../../graphics/jpeg/buildlink3.mk"
7686: </pre>
1.75 rillig 7687: </li>
7688: <li>
7689: <p>If your package needs to use another package to build
1.87 wiz 7690: itself and there is no <code class="filename">buildlink3.mk</code>
7691: file available, use the <code class="varname">BUILD_DEPENDS</code>
7692: definition:</p>
1.75 rillig 7693: <pre class="programlisting">
1.87 wiz 7694: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
7695: </pre>
1.75 rillig 7696: </li>
7697: <li>
7698: <p>If your package needs a library with which to link and
1.76 rillig 7699: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7700: available, this is specified using the
7701: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7702: <pre class="programlisting">
1.87 wiz 7703: DEPENDS+= xpm-3.4j:../../graphics/xpm
7704: </pre>
1.75 rillig 7705: <p>You can also use wildcards in package dependences:</p>
7706: <pre class="programlisting">
1.87 wiz 7707: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
7708: </pre>
1.75 rillig 7709: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7710: creating binary packages. The dependency is checked when
7711: installing the binary package and any package which matches
7712: the pattern will be used. Wildcard dependencies should be
7713: used with care.</p>
1.75 rillig 7714: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7715: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7716: such as “<span class="quote">tk-postgresql</span>” matching a
7717: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7718: <p>Wildcards can also be used to specify that a package
1.87 wiz 7719: will only build against a certain minimum version of a
7720: pre-requisite:</p>
1.75 rillig 7721: <pre class="programlisting">
1.87 wiz 7722: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
7723: </pre>
1.75 rillig 7724: <p>This means that the package will build against version
1.87 wiz 7725: 3.5.4 of the tiff library or newer. Such a dependency may
7726: be warranted if, for example, the API of the library has
7727: changed with version 3.5.4 and a package would not compile
7728: against an earlier version of tiff.</p>
1.75 rillig 7729: <p>Please note that such dependencies should only be
1.87 wiz 7730: updated if a package requires a newer pre-requisite, but
1.93 rillig 7731: not to denote recommendations such as
1.87 wiz 7732: ABI changes that do not prevent a package from building
7733: correctly. Such recommendations can be expressed using
7734: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7735: <pre class="programlisting">
1.87 wiz 7736: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
7737: </pre>
1.75 rillig 7738: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7739: line, this denotes that while a package will build against
7740: tiff>=3.5.4, at least version 3.6.1 is recommended.
7741: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7742: dependencies unless explicitly ignored (in which case a
7743: warning will be printed).</p>
1.75 rillig 7744: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7745: use the required <code class="varname">DEPENDS</code>, set
7746: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7747: it easier and faster to update packages built using pkgsrc,
7748: since older compatible dependencies can continue to be
7749: used. This is useful for people who watch their rebuilds
7750: very carefully; it is not very good as a general-purpose
7751: hammer. If you use it, you need to be mindful of possible
7752: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7753: <p>Packages that are built with recommendations ignored
1.87 wiz 7754: may not be uploaded to ftp.NetBSD.org by developers and
7755: should not be used across different systems that may have
7756: different versions of binary packages installed.</p>
1.75 rillig 7757: <p>For security fixes, please update the package
1.90 rillig 7758: 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 7759: information.</p>
1.75 rillig 7760: </li>
7761: <li>
7762: <p>If your package needs some executable to be able to run
1.87 wiz 7763: correctly and if there's no
7764: <code class="filename">buildlink3.mk</code> file, this is specified
7765: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 7766: <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 7767: be able to execute the latex binary from the teTeX package
7768: when it runs, and that is specified:</p>
1.75 rillig 7769: <pre class="programlisting">
1.87 wiz 7770: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
7771: </pre>
1.75 rillig 7772: <p>The comment about wildcard dependencies from previous
1.87 wiz 7773: paragraph applies here, too.</p>
1.75 rillig 7774: </li>
7775: </ol></div>
7776: <p>If your package needs files from another package to build,
1.87 wiz 7777: add the relevant distribution files to
7778: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 7779: 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 7780: (It relies on the jpeg sources being present in source form
7781: during the build.)</p>
1.88 wiz 7782: <p>Please also note the
7783: <code class="varname">BUILD_USES_GETTEXT_M4</code> definition, which is
7784: provided as convenience definition. It adds a build dependency on
7785: either an installed version of an older gettext package, or if it
1.91 rillig 7786: isn't, installs the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gettext-m4/README.html" target="_top"><code class="filename">devel/gettext-m4</code></a> package.</p>
1.75 rillig 7787: </div>
7788: <div class="sect2" lang="en">
7789: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7790: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7791: <p>Your package may conflict with other packages a user might
1.87 wiz 7792: already have installed on his system, e.g. if your package
1.88 wiz 7793: installs the same set of files as another package in the pkgsrc
7794: tree.</p>
1.75 rillig 7795: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7796: space-separated list of packages (including version string) your
7797: package conflicts with.</p>
1.91 rillig 7798: <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>
7799: 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 7800: install the same shared library, thus you set in
7801: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7802: <pre class="programlisting">
7803: CONFLICTS= Xaw-Xpm-[0-9]*
7804: </pre>
7805: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 7806: <pre class="programlisting">
1.87 wiz 7807: CONFLICTS= Xaw3d-[0-9]*
7808: </pre>
1.75 rillig 7809: <p>Packages will automatically conflict with other packages
1.87 wiz 7810: with the name prefix and a different version
7811: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
7812: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 7813: </div>
7814: <div class="sect2" lang="en">
7815: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7816: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7817: <p>There are several reasons why a package might be
1.88 wiz 7818: instructed to not build under certain circumstances. If the
1.87 wiz 7819: package builds and runs on most platforms, the exceptions
7820: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7821: the package builds and runs on a small handful of platforms,
7822: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
7823: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7824: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7825: (OS-version-platform) that can use glob-style
7826: wildcards.</p>
1.88 wiz 7827: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 7828: 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 7829: backwards compatible with other versions of the OS, and should be
7830: uploaded to a version specific directory on the FTP server. Mark
7831: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
7832: “<span class="quote">yes</span>”. This variable is not currently used by any of
7833: the package system internals, but may be used in the
7834: future.</p>
1.75 rillig 7835: <p>If the package should be skipped (for example, because it
1.87 wiz 7836: provides functionality already provided by the system), set
1.88 wiz 7837: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7838: the package should fail because some preconditions are not met,
7839: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7840: message.</p>
1.75 rillig 7841: </div>
7842: <div class="sect2" lang="en">
7843: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7844: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7845: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7846: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7847: be set in the package Makefile. This will be carried into any
7848: binary package that is made from this pkgsrc entry. A
7849: “<span class="quote">preserved</span>” package will
7850: 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
7851: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 7852: </div>
7853: <div class="sect2" lang="en">
7854: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7855: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7856: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7857: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
7858: and after committing that file, use <span><strong class="command">make upload</strong></span>
7859: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 7860: <p>After fixing the vulnerability by a patch, its
1.87 wiz 7861: <code class="varname">PKGREVISION</code> should be increased (this
7862: is of course not necessary if the problem is fixed by using
7863: a newer release of the software).</p>
1.75 rillig 7864: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7865: branch, be sure to submit a pullup request!</p>
1.75 rillig 7866: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7867: semi-automatically by a weekly cron job.</p>
1.75 rillig 7868: </div>
7869: <div class="sect2" lang="en">
7870: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7871: <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 7872: <p>When making fixes to an existing package it can be useful
1.87 wiz 7873: to change the version number in <code class="varname">PKGNAME</code>. To
7874: avoid conflicting with future versions by the original author, a
7875: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
7876: on package versions by setting <code class="varname">PKGREVISION=1</code>
7877: (2, ...). The “<span class="quote">nb</span>” is treated like a
7878: “<span class="quote">.</span>” by the package tools. e.g.</p>
7879: <pre class="programlisting">
7880: DISTNAME= foo-17.42
7881: PKGREVISION= 9
7882: </pre>
1.75 rillig 7883: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 7884: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
7885: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
7886: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7887: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7888: <p>When a new release of the package is released, the
1.87 wiz 7889: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7890: minor release of the above package, things should be like:</p>
1.75 rillig 7891: <pre class="programlisting">
1.87 wiz 7892: DISTNAME= foo-17.43
7893: </pre>
7894: <p><code class="varname">PKGREVISION</code> should be incremented for any
7895: non-trivial change in the resulting binary package. Without a
7896: <code class="varname">PKGREVISION</code> bump, someone with the previous
7897: version installed has no way of knowing that their package is out
7898: of date. Thus, changes without increasing
7899: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7900: trivial that no reasonable person would want to upgrade", and this
7901: is the rough test for when increasing
7902: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7903: changes that do not merit increasing
7904: <code class="varname">PKGREVISION</code> are:</p>
7905: <pre class="programlisting">
7906: Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
7907: or comments in Makefile.
7908: Changing build variables if the resulting binary package is the same.
7909: Changing <code class="filename">DESCR</code>.
7910: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.
7911: </pre>
7912: <p>Examples of changes that do merit an increase to
7913: <code class="varname">PKGREVISION</code> include:</p>
7914: <pre class="programlisting">
7915: Security fixes
7916: Changes or additions to a patch file
7917: Changes to the <code class="filename">PLIST</code>
7918: </pre>
1.78 rillig 7919: <p>PKGREVISION must also be incremented when dependencies have ABI
7920: changes.</p>
1.75 rillig 7921: </div>
1.79 rillig 7922: <div class="sect2" lang="en">
7923: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7924: <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 7925: <p>When you want to replace the same text in multiple files
1.87 wiz 7926: or when the replacement text varies, patches alone cannot help.
7927: This is where the SUBST framework comes in. It provides an
7928: easy-to-use interface for replacing text in files.
7929: Example:</p>
7930: <pre class="programlisting">
7931: SUBST_CLASSES+= fix-paths
7932: SUBST_STAGE.fix-paths= pre-configure
7933: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7934: SUBST_FILES.fix-paths= src/*.c
7935: SUBST_FILES.fix-paths+= scripts/*.sh
7936: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7937: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7938: </pre>
1.79 rillig 7939: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 7940: that are used to identify the different SUBST blocks that are
7941: defined. The SUBST framework is heavily used by pkgsrc, so it is
7942: important to always use the <code class="literal">+=</code> operator with
7943: this variable. Otherwise some substitutions may be
7944: skipped.</p>
1.79 rillig 7945: <p>The remaining variables of each SUBST block are
1.87 wiz 7946: parameterized with the identifier from the first line
7947: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7948: parameters to a function call.</p>
1.79 rillig 7949: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 7950: which the replacement will take place. All combinations of
7951: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7952: <code class="literal">post-</code> together with a phase name are
7953: possible, though only few are actually used. Most commonly used
7954: are <code class="literal">post-patch</code> and
7955: <code class="literal">pre-configure</code>. Of these two,
7956: <code class="literal">pre-configure</code> should be preferred because
7957: then it is possible to run <span><strong class="command">bmake patch</strong></span> and
7958: have the state after applying the patches but before making any
7959: other changes. This is especially useful when you are debugging
7960: a package in order to create new patches for it. Similarly,
7961: <code class="literal">post-build</code> is preferred over
7962: <code class="literal">pre-install</code>, because the install phase should
7963: generally be kept as simple as possible. When you use
7964: <code class="literal">post-build</code>, you have the same files in the
7965: working directory that will be installed later, so you can check
7966: if the substitution has succeeded.</p>
1.79 rillig 7967: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 7968: that is printed just before the substitution is done.</p>
1.79 rillig 7969: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 7970: globbing patterns that specifies the files in which the
7971: substitution will take place. The patterns are interpreted
7972: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 7973: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87 wiz 7974: <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
7975: command should be prefixed with <code class="literal">-e</code>, so that
7976: all SUBST blocks look uniform.</p>
1.79 rillig 7977: <p>There are some more variables, but they are so seldomly
1.87 wiz 7978: used that they are only documented in the
7979: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 7980: </div>
1.75 rillig 7981: </div>
7982: <div class="sect1" lang="en">
7983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7984: <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 7985: <div class="sect2" lang="en">
7986: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7987: <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 7988: <p>If you need to download from a dynamic URL you can set
1.87 wiz 7989: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
7990: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7991: with the name of each file to download as an argument, expecting
7992: it to output the URL of the directory from which to download
1.91 rillig 7993: 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 7994: example of this usage.</p>
1.75 rillig 7995: <p>If the download can't be automated, because the user must
1.87 wiz 7996: submit personal information to apply for a password, or must pay
7997: for the source, or whatever, you can set
7998: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7999: displayed to the user before aborting the build. Example:</p>
8000: <pre class="programlisting">
8001: FETCH_MESSAGE= "Please download the files"
8002: FETCH_MESSAGE+= " "${DISTFILES:Q}
8003: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8004: </pre>
1.75 rillig 8005: </div>
8006: <div class="sect2" lang="en">
8007: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8008: <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 8009: <p>Sometimes authors of a software package make some
1.87 wiz 8010: modifications after the software was released, and they put up a
8011: new distfile without changing the package's version number. If a
8012: package is already in pkgsrc at that time, the checksum will
8013: no longer match. The contents of the new distfile should be
8014: compared against the old one before changing anything, to make
8015: sure the distfile was really updated on purpose, and that
8016: no trojan horse or so crept in.
8017: Then, the correct way to work around this is to
8018: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8019: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8020: <code class="varname">DISTFILES</code> and
1.93 rillig 8021: <code class="varname">PATCHFILES</code> for this package will be put in that
1.87 wiz 8022: subdirectory of the local distfiles directory. In case this
8023: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8024: including the <code class="filename">nbX</code> suffix) or a date stamp
8025: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8026: Do not forget regenerating the <code class="filename">distinfo</code> file
8027: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8028: path in the filenames.
8029: Furthermore, a mail to the package's authors seems appropriate
8030: telling them that changing distfiles after releases without
8031: changing the file names is not good practice.</p>
1.75 rillig 8032: </div>
8033: </div>
8034: <div class="sect1" lang="en">
8035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8036: <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 8037: <div class="sect2" lang="en">
8038: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8039: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8040: <p>pkgsrc supports many different machines, with different
1.87 wiz 8041: object formats like a.out and ELF, and varying abilities to do
8042: shared library and dynamic loading at all. To accompany this,
8043: varying commands and options have to be passed to the
8044: compiler, linker, etc. to get the Right Thing, which can be
8045: pretty annoying especially if you don't have all the machines
8046: at your hand to test things. The
1.91 rillig 8047: <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 8048: can help here, as it just “<span class="quote">knows</span>” how to build
8049: both static and dynamic libraries from a set of source files,
8050: thus being platform-independent.</p>
8051: <p>Here's how to use libtool in a package in seven simple
8052: steps:</p>
1.75 rillig 8053: <div class="orderedlist"><ol type="1">
8054: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8055: Makefile.</p></li>
1.75 rillig 8056: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8057: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8058: add it to the definition of <code class="varname">CC</code>, if only
8059: libraries are being built in a given Makefile. This one command
8060: will build both PIC and non-PIC library objects, so you need not
8061: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8062: <li>
8063: <p>For the linking of the library, remove any
1.87 wiz 8064: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8065: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8066: <pre class="programlisting">
1.87 wiz 8067: ${LIBTOOL} --mode=link ${CC} -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} \
8068: -rpath ${PREFIX}/lib -version-info major:minor
8069: </pre>
1.75 rillig 8070: <p>Note that the library is changed to have a
1.87 wiz 8071: <code class="filename">.la</code> extension, and the objects are
8072: changed to have a <code class="filename">.lo</code>
8073: extension. Change <code class="varname">OBJS</code> as
8074: necessary. This automatically creates all of the
8075: <code class="filename">.a</code>,
8076: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8077: necessary) in the build directory. Be sure to include
8078: “<span class="quote">-version-info</span>”, especially when major and
8079: minor are zero, as libtool will otherwise strip off the
8080: shared library version.</p>
1.75 rillig 8081: <p>From the libtool manual:</p>
8082: <pre class="programlisting">
1.87 wiz 8083: So, libtool library versions are described by three integers:
1.69 rillig 8084:
1.87 wiz 8085: CURRENT
8086: The most recent interface number that this library implements.
1.69 rillig 8087:
1.87 wiz 8088: REVISION
8089: The implementation number of the CURRENT interface.
1.69 rillig 8090:
1.87 wiz 8091: AGE
8092: The difference between the newest and oldest interfaces that
8093: this library implements. In other words, the library implements
8094: all the interface numbers in the range from number `CURRENT -
8095: AGE' to `CURRENT'.
1.1 grant 8096:
1.87 wiz 8097: If two libraries have identical CURRENT and AGE numbers, then the
8098: dynamic linker chooses the library with the greater REVISION number.
8099: </pre>
1.75 rillig 8100: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8101: different results for a.out and ELF (excluding symlinks)
8102: in only one case. An ELF library of the form
8103: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8104: will have a symlink of
8105: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8106: on an a.out platform. This is handled
8107: automatically.</p>
1.75 rillig 8108: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8109: directory of the library being built.</p>
1.76 rillig 8110: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8111: <code class="filename">.la</code> file, the other files will be
8112: added automatically.</p>
1.75 rillig 8113: </li>
8114: <li>
1.76 rillig 8115: <p>When linking shared object (<code class="filename">.so</code>)
1.87 wiz 8116: 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
8117: shared libraries, use “<span class="quote">-module
8118: -avoid-version</span>” to prevent them getting version
8119: tacked on.</p>
1.76 rillig 8120: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8121: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8122: </li>
8123: <li>
8124: <p>When linking programs that depend on these libraries
1.87 wiz 8125: <span class="emphasis"><em>before</em></span> they are installed, preface
8126: 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}
8127: --mode=link</span>”, and it will find the correct
8128: libraries (static or shared), but please be aware that
8129: libtool will not allow you to specify a relative path in
8130: -L (such as “<span class="quote">-L../somelib</span>”), because it
8131: expects you to change that argument to be the
8132: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8133: <pre class="programlisting">
1.87 wiz 8134: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8135: </pre>
1.75 rillig 8136: <p>should be changed to:</p>
8137: <pre class="programlisting">
1.87 wiz 8138: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8139: </pre>
1.75 rillig 8140: <p>and it will do the right thing with the libraries.</p>
8141: </li>
8142: <li>
8143: <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 8144: 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}
8145: --mode=install</span>”, and change the library name to
8146: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8147: <pre class="programlisting">
1.87 wiz 8148: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
8149: </pre>
1.76 rillig 8150: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8151: shared library, any needed symlinks, and run
8152: <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 8153: </li>
1.76 rillig 8154: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8155: the <code class="filename">.la</code>
8156: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8157: </ol></div>
8158: </div>
8159: <div class="sect2" lang="en">
8160: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8161: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8162: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8163: package Makefile. This will override the package's own libtool
8164: in most cases. For older libtool using packages, libtool is
8165: made by ltconfig script during the do-configure step; you can
8166: check the libtool script location by doing <span><strong class="command">make
8167: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8168: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8169: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8170: default, it is set to “<span class="quote">libtool */libtool
8171: */*/libtool</span>”. If this does not match the location of the
8172: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8173: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8174: libraries built and installed, then use
8175: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8176: <p>If your package makes use of the platform-independent library
1.87 wiz 8177: for loading dynamic shared objects, that comes with libtool
8178: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8179: <p>Some packages use libtool incorrectly so that the package
8180: may not work or build in some circumstances. Some of the more
8181: common errors are:</p>
1.75 rillig 8182: <div class="itemizedlist"><ul type="disc">
8183: <li>
8184: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8185: executable or library. This in itself isn't a problem if one of two things
8186: has been done:</p>
1.75 rillig 8187: <div class="orderedlist"><ol type="1">
8188: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8189: <code class="filename">libfoo.la</code>, not
8190: <code class="filename">foo.la</code></p></li>
1.75 rillig 8191: <li><p>The -dlopen option is used when linking an executable.</p></li>
8192: </ol></div>
8193: </li>
8194: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8195: The function lt_dlinit() should be called and the macro
8196: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8197: executables.</p></li>
1.75 rillig 8198: </ul></div>
8199: </div>
8200: <div class="sect2" lang="en">
8201: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8202: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8203: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8204: to regenerate the configure script and Makefile.in makefile
8205: templates, then they should be executed in a pre-configure
8206: target.</p>
1.75 rillig 8207: <p>For packages that need only autoconf:</p>
8208: <pre class="programlisting">
1.87 wiz 8209: AUTOCONF_REQD= 2.50 # if default version is not good enough
8210: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8211: ...
1.1 grant 8212:
1.87 wiz 8213: pre-configure:
8214: cd ${WRKSRC}; autoconf
1.1 grant 8215:
1.87 wiz 8216: ...
8217: </pre>
1.75 rillig 8218: <p>and for packages that need automake and autoconf:</p>
8219: <pre class="programlisting">
1.87 wiz 8220: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8221: USE_TOOLS+= automake # use "automake14" for automake-1.4
8222: ...
8223:
8224: pre-configure:
8225: cd ${WRKSRC}; \
8226: aclocal; autoheader; \
8227: automake -a --foreign -i; autoconf
1.1 grant 8228:
1.87 wiz 8229: ...
8230: </pre>
1.75 rillig 8231: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8232: require GNU Make.</p>
1.75 rillig 8233: <p>There are times when the configure process makes
1.87 wiz 8234: additional changes to the generated files, which then causes
8235: the build process to try to re-execute the automake sequence.
8236: This is prevented by touching various files in the configure
8237: stage. If this causes problems with your package you can set
8238: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8239: Makefile.</p>
1.75 rillig 8240: </div>
8241: </div>
8242: <div class="sect1" lang="en">
8243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8244: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87 wiz 8245: <div class="sect2" lang="en">
8246: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8247: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8248: <p>Compilers for the C, C++, and Fortran languages comes with
8249: the NetBSD base system. By default, pkgsrc assumes that a package
8250: is written in C and will hide all other compilers (via the wrapper
1.90 rillig 8251: framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8252: <p>To declare which language's compiler a package needs, set
8253: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8254: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8255: “<span class="quote">fortran</span>” (and any combination). The default is
8256: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8257: written in C++, usually need a C compiler for the configure
8258: phase.</p>
8259: </div>
8260: <div class="sect2" lang="en">
8261: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8262: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87 wiz 8263: <p>If a program is written in Java, use the Java framework in
8264: pkgsrc. The package must include
8265: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8266: provides the following variables:</p>
8267: <div class="itemizedlist"><ul type="disc">
8268: <li><p><code class="varname">USE_JAVA</code> defines if a build
8269: dependency on the JDK is added. If
8270: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8271: there is only a runtime dependency on the JDK. The default is
8272: “<span class="quote">yes</span>”, which also adds a build dependency on the
8273: JDK.</p></li>
8274: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8275: a package needs a Java2 implementation. The supported values
8276: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8277: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8278: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8279: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8280: above. This variable is not set by default.</p></li>
8281: </ul></div>
8282: </div>
8283: <div class="sect2" lang="en">
8284: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8285: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8286: <p>If your package contains interpreted perl scripts, add
8287: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8288: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8289: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8290: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8291: that you want adjusted. Every occurrence of
8292: <code class="filename">*/bin/perl</code> will be replaced with the full
8293: path to the perl executable.</p>
8294: <p>If a particular version of perl is needed, set the
8295: <code class="varname">PERL5_REQD</code> variable to the version number. The
8296: default is “<span class="quote">5.0</span>”.</p>
1.90 rillig 8297: <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 8298: about handling perl modules.</p>
8299: </div>
8300: <div class="sect2" lang="en">
8301: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8302: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8303: <p>Currently, there is no special handling for other languages
8304: in pkgsrc. If a compiler package provides a
8305: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8306: just add a (build) dependency on the appropriate compiler
8307: package.</p>
8308: </div>
8309: </div>
8310: <div class="sect1" lang="en">
8311: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8312: <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 8313: <p>The most common failures when building a package are that
8314: some platforms do not provide certain header files, functions or
8315: libraries, or they provide the functions in a library that the
8316: original package author didn't know. To work around this, you
8317: can rewrite the source code in most cases so that it does not
8318: use the missing functions or provides a replacement function.</p>
8319: <div class="sect2" lang="en">
8320: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8321: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8322: <p>If a package already comes with a GNU configure script, the
8323: preferred way to fix the build failure is to change the
8324: configure script, not the code. In the other cases, you can
8325: utilize the C preprocessor, which defines certain macros
8326: depending on the operating system and hardware architecture it
8327: compiles for. These macros can be queried using for example
8328: <code class="varname">#if defined(__i386)</code>. Almost every operating
8329: system, hardware architecture and compiler has its own macro.
8330: For example, if the macros <code class="varname">__GNUC__</code>,
8331: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8332: are all defined, you know that you are using NetBSD on an i386
8333: compatible CPU, and your compiler is GCC.</p>
8334: <p>The list of the following macros for hardware and
8335: operating system depends on the compiler that is used. For
8336: example, if you want to conditionally compile code on Solaris,
8337: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8338: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8339: <div class="sect3" lang="en">
8340: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8341: <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 8342: <p>To distinguish between 4.4 BSD-derived systems and the
8343: rest of the world, you should use the following code.</p>
8344: <pre class="programlisting">
8345: #include <sys/param.h>
8346: #if (defined(BSD) && BSD >= 199306)
8347: /* BSD-specific code goes here */
8348: #else
8349: /* non-BSD-specific code goes here */
8350: #endif
8351: </pre>
1.77 rillig 8352: <p>If this distinction is not fine enough, you can also test
8353: for the following macros.</p>
1.75 rillig 8354: <pre class="programlisting">
8355: FreeBSD __FreeBSD__
8356: DragonFly __DragonFly__
8357: Interix __INTERIX
8358: Linux linux, __linux, __linux__
8359: NetBSD __NetBSD__
8360: OpenBSD __OpenBSD__
8361: Solaris sun, __sun
8362: </pre>
8363: </div>
8364: <div class="sect3" lang="en">
8365: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8366: <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 8367: <pre class="programlisting">
8368: i386 i386, __i386, __i386__
8369: MIPS __mips
8370: SPARC sparc, __sparc
8371: </pre>
8372: </div>
8373: <div class="sect3" lang="en">
8374: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8375: <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 8376: <pre class="programlisting">
8377: GCC __GNUC__ (major version), __GNUC_MINOR__
8378: SunPro __SUNPRO_C (0x570 for version 5.7)
1.81 rillig 8379: SunPro C++ __SUNPRO_CC (0x580 for version 5.8)
1.75 rillig 8380: </pre>
8381: </div>
8382: </div>
1.78 rillig 8383: <div class="sect2" lang="en">
8384: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8385: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8386: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8387: combinations of compiler version and architecture and almost
8388: always relation to optimisation being enabled. Common symptoms
8389: are gcc internal errors or never finishing compiling a
1.78 rillig 8390: file.</p>
8391: <p>Typically, a workaround involves testing the
8392: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8393: optimisation for that combination of file,
8394: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8395: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8396: number of examples.</p>
8397: </div>
8398: <div class="sect2" lang="en">
8399: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8400: <a name="undefined-reference"></a>18.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.92 rillig 8401: <p>This error message often means that a package did not
1.78 rillig 8402: link to a shared library it needs. The following functions are
8403: known to cause this error message over and over.</p>
8404: <div class="informaltable">
8405: <a name="undefined-reference-functions"></a><table border="1">
8406: <colgroup>
8407: <col>
8408: <col>
8409: <col>
8410: </colgroup>
8411: <thead><tr>
8412: <th>Function</th>
8413: <th>Library</th>
8414: <th>Affected platforms</th>
8415: </tr></thead>
8416: <tbody>
8417: <tr>
8418: <td>accept, bind, connect</td>
8419: <td>-lsocket</td>
8420: <td>Solaris</td>
8421: </tr>
8422: <tr>
8423: <td>crypt</td>
8424: <td>-lcrypt</td>
8425: <td>DragonFly, NetBSD</td>
8426: </tr>
8427: <tr>
8428: <td>dlopen, dlsym</td>
8429: <td>-ldl</td>
8430: <td>Linux</td>
8431: </tr>
8432: <tr>
8433: <td>gethost*</td>
8434: <td>-lnsl</td>
8435: <td>Solaris</td>
8436: </tr>
8437: <tr>
8438: <td>inet_aton</td>
8439: <td>-lresolv</td>
8440: <td>Solaris</td>
8441: </tr>
8442: <tr>
8443: <td>nanosleep, sem_*, timer_*</td>
8444: <td>-lrt</td>
8445: <td>Solaris</td>
8446: </tr>
8447: <tr>
8448: <td>openpty</td>
8449: <td>-lutil</td>
8450: <td>Linux</td>
8451: </tr>
8452: </tbody>
8453: </table>
8454: </div>
8455: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8456: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8457: -l<em class="replaceable"><code>foo</code></em></code> to the package
8458: <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
8459: bmake</strong></span>.</p>
1.92 rillig 8460: <div class="sect3" lang="en">
8461: <div class="titlepage"><div><div><h4 class="title">
8462: <a name="undefined-reference-sunpro"></a>18.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
8463: <p>When you are using the SunPro compiler, there is another
8464: possibility. That compiler cannot handle the following code:</p>
8465: <pre class="programlisting">
8466: extern int extern_func(int);
1.93 rillig 8467:
1.92 rillig 8468: static inline int
8469: inline_func(int x)
8470: {
8471: return extern_func(x);
8472: }
1.93 rillig 8473:
1.92 rillig 8474: int main(void)
8475: {
8476: return 0;
8477: }
8478: </pre>
8479: <p>It generates the code for <code class="function">inline_func</code> even if
8480: that function is never used. This code then refers to
8481: <code class="function">extern_func</code>, which can usually not be resolved. To
8482: solve this problem you can try to tell the package to disable inlining
8483: of functions.</p>
8484: </div>
1.87 wiz 8485: </div>
8486: <div class="sect2" lang="en">
8487: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8488: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8489: <p>Sometimes packages fail to build because the compiler runs
8490: into an operating system specific soft limit. With the
8491: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8492: to unlimit the resources. Currently, the allowed values are
8493: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8494: Setting this variable is similar to running the shell builtin
8495: <span><strong class="command">ulimit</strong></span> command to raise the maximum data
8496: segment size or maximum stack size of a process, respectively, to
8497: their hard limits.</p>
1.78 rillig 8498: </div>
1.75 rillig 8499: </div>
8500: <div class="sect1" lang="en">
8501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8502: <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 8503: <div class="sect2" lang="en">
8504: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8505: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78 rillig 8506: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87 wiz 8507: with some operating systems cannot create more than one
8508: directory at a time. As such, you should call
8509: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8510: <pre class="programlisting">
8511: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8512: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8513: </pre>
1.78 rillig 8514: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8515: dir2</code></span>” to the
8516: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8517: automatically do the right thing.</p>
1.75 rillig 8518: </div>
8519: <div class="sect2" lang="en">
8520: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8521: <a name="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8522: <p>In general, documentation should be installed into
1.87 wiz 8523: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8524: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8525: includes the version number of the package).</p>
1.84 wiz 8526: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8527: directory where HTML documentation is installed with the
8528: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8529: is needed because otherwise the documentation ends up in
8530: <code class="filename">${PREFIX}/share/doc/html</code> or other
8531: places.</p>
8532: <p>An exception to the above is that library API documentation
1.91 rillig 8533: 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 8534: browsers (devhelp) should be left at their default location, which
8535: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8536: documentation can be recognized from files ending in
8537: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8538: (It is also acceptable to install such files in
8539: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8540: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8541: <code class="filename">.devhelp*</code> file must be directly in that
8542: directory then, no additional subdirectory level is allowed in
8543: this case. This is usually achieved by using
8544: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8545: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8546: though.)</p>
1.75 rillig 8547: </div>
8548: <div class="sect2" lang="en">
8549: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8550: <a name="installing-score-files"></a>18.6.3. Installing score files</h3></div></div></div>
1.75 rillig 8551: <p>Certain packages, most of them in the games category, install
1.87 wiz 8552: a score file that allows all users on the system to record their
8553: highscores. In order for this to work, the binaries need to be
8554: installed setgid and the score files owned by the appropriate
8555: group and/or owner (traditionally the "games" user/group). The
8556: following variables, documented in more detail in
8557: <code class="filename">mk/defaults/mk.conf</code>, control this
8558: behaviour: <code class="varname">SETGIDGAME</code>,
8559: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8560: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8561: <p>Note that per default, setgid installation of games is
1.87 wiz 8562: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8563: the other variables accordingly.</p>
1.75 rillig 8564: <p>A package should therefor never hard code file ownership or
1.87 wiz 8565: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8566: <code class="varname">INSTALL_GAME_DATA</code> to set these
8567: correctly.</p>
1.75 rillig 8568: </div>
8569: <div class="sect2" lang="en">
8570: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8571: <a name="hardcoded-paths"></a>18.6.4. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8572: <p>Your package may also contain scripts with hardcoded paths to
8573: other interpreters besides (or as well as) perl. To correct the
8574: full pathname to the script interpreter, you need to set the
8575: following definitions in your <code class="filename">Makefile</code> (we
8576: shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
8577: <pre class="programlisting">
8578: REPLACE_INTERPRETER+= tcl
8579: REPLACE.tcl.old= .*/bin/tclsh
8580: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8581: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8582: # relative to ${WRKSRC}, just as in REPLACE_PERL
8583: </pre>
1.75 rillig 8584: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8585: <h3 class="title">Note</h3>
8586: <p>Before March 2006, these variables were called
1.87 wiz 8587: <code class="varname">_REPLACE.*</code> and
8588: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8589: </div>
8590: </div>
8591: <div class="sect2" lang="en">
8592: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8593: <a name="perl-modules"></a>18.6.5. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8594: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8595: the Makefile fragment
8596: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
8597: <span><strong class="command">do-configure</strong></span> target for the standard perl
8598: configuration for such modules as well as various hooks to tune
8599: this configuration. See comments in this file for
8600: details.</p>
1.75 rillig 8601: <p>Perl5 modules will install into different places depending
1.87 wiz 8602: on the version of perl used during the build process. To
8603: address this, pkgsrc will append lines to the
8604: <code class="filename">PLIST</code> corresponding to the files listed in
8605: the installed <code class="filename">.packlist</code> file generated by
8606: most perl5 modules. This is invoked by defining
8607: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8608: paths to packlist files, e.g.:</p>
1.75 rillig 8609: <pre class="programlisting">
1.87 wiz 8610: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8611: </pre>
1.75 rillig 8612: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8613: <code class="varname">PERL5_SITEARCH</code>, and
8614: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8615: in which perl5 modules may be installed, and may be used by
8616: perl5 packages that don't have a packlist. These three
8617: variables are also substituted for in the
8618: <code class="filename">PLIST</code>.</p>
1.75 rillig 8619: </div>
8620: <div class="sect2" lang="en">
8621: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8622: <a name="faq.info-files"></a>18.6.6. Packages installing info files</h3></div></div></div>
1.75 rillig 8623: <p>Some packages install info files or use the
1.87 wiz 8624: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8625: commands. <code class="varname">INFO_FILES</code> should be defined in
8626: the package Makefile so that <code class="filename">INSTALL</code> and
8627: <code class="filename">DEINSTALL</code> scripts will be generated to
8628: handle registration of the info files in the Info directory
8629: file. The “<span class="quote">install-info</span>” command used for the info
8630: files registration is either provided by the system, or by a
8631: special purpose package automatically added as dependency if
8632: needed.</p>
1.75 rillig 8633: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8634: <code class="filename">${PREFIX}</code> where info files are primarily
8635: located. <code class="varname">PKGINFODIR</code> defaults to
8636: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8637: <p>The info files for the package should be listed in the
1.87 wiz 8638: package <code class="filename">PLIST</code>; however any split info files
8639: need not be listed.</p>
1.75 rillig 8640: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8641: at build time must add “<span class="quote">makeinfo</span>” to
8642: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8643: version of the “<span class="quote">makeinfo</span>” command is needed it
8644: should be noted with the <code class="varname">TEXINFO_REQD</code>
8645: variable in the package <code class="filename">Makefile</code>. By
8646: default, a minimum version of 3.12 is required. If the system
8647: does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
8648: does not match the required minimum, a build dependency on the
1.91 rillig 8649: <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 8650: be added automatically.</p>
1.75 rillig 8651: <p>The build and installation process of the software provided
1.87 wiz 8652: by the package should not use the
8653: <span><strong class="command">install-info</strong></span> command as the registration of
8654: info files is the task of the package
8655: <code class="filename">INSTALL</code> script, and it must use the
8656: appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75 rillig 8657: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87 wiz 8658: overriding scripts for the <span><strong class="command">install-info</strong></span> and
8659: <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
8660: in <code class="varname">PATH</code>.</p>
1.75 rillig 8661: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87 wiz 8662: no effect except the logging of a message. The script overriding
8663: <span><strong class="command">makeinfo</strong></span> logs a message and according to the
8664: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
8665: <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8666: </div>
8667: <div class="sect2" lang="en">
8668: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8669: <a name="manpages"></a>18.6.7. Packages installing man pages</h3></div></div></div>
1.81 rillig 8670: <p>All packages that install manual pages should install them
1.87 wiz 8671: into the same directory, so that there is one common place to look
8672: for them. In pkgsrc, this place is
8673: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8674: should be used in packages. The default for
8675: <code class="varname">PKGMANDIR</code> is
8676: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8677: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8678: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8679: <h3 class="title">Note</h3>
1.87 wiz 8680: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8681: is far from complete.</p>
1.75 rillig 8682: </div>
1.81 rillig 8683: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8684: <code class="filename">man/</code> as the top level directory for the man
8685: page file entries, and the pkgsrc framework will convert as
8686: needed. In all other places, the correct
8687: <code class="varname">PKGMANDIR</code> must be used.</p>
8688: <p>Packages that are
8689: configured with <code class="varname">GNU_CONFIGURE</code> set as
8690: “<span class="quote">yes</span>”, by default will use the
8691: <code class="filename">./configure</code>
8692: --mandir switch to set where the man pages should be installed.
8693: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8694: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8695: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8696: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8697: to “<span class="quote">no</span>”.
8698: Or if the <code class="filename">./configure</code> script uses
8699: a non-standard use of --mandir, you can set
8700: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90 rillig 8701: <p>See <a href="#manpage-compression" title="12.5. Man page compression">Section 12.5, “Man page compression”</a> for
1.87 wiz 8702: information on installation of compressed manual pages.</p>
1.75 rillig 8703: </div>
8704: <div class="sect2" lang="en">
8705: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8706: <a name="gconf2-data-files"></a>18.6.8. Packages installing GConf2 data files</h3></div></div></div>
1.87 wiz 8707: <p>If a package installs <code class="filename">.schemas</code> or
8708: <code class="filename">.entries</code> files, used by GConf2,
8709: you need to take some extra steps to make sure they get registered
8710: in the database:</p>
1.75 rillig 8711: <div class="orderedlist"><ol type="1">
1.76 rillig 8712: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87 wiz 8713: instead of its <code class="filename">buildlink3.mk</code> file. This
8714: takes care of rebuilding the GConf2 database at installation and
8715: deinstallation time, and tells the package where to install
8716: GConf2 data files using some standard configure arguments. It
8717: also disallows any access to the database directly from the
8718: package.</p></li>
1.75 rillig 8719: <li><p>Ensure that the package installs its
1.87 wiz 8720: <code class="filename">.schemas</code> files under
8721: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8722: installed under <code class="filename">${PREFIX}/etc</code>, you will
8723: need to manually patch the package.</p></li>
1.75 rillig 8724: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8725: directory, as they will be handled automatically. See
1.90 rillig 8726: <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 8727: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87 wiz 8728: your <code class="filename">Makefile</code> with a list of all
8729: <code class="filename">.schemas</code> files installed by the package, if
8730: any. Names must not contain any directories in them.</p></li>
1.75 rillig 8731: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87 wiz 8732: your <code class="filename">Makefile</code> with a
8733: list of all <code class="filename">.entries</code> files installed by the
8734: package, if any. Names must not contain any directories in
8735: them.</p></li>
1.75 rillig 8736: </ol></div>
8737: </div>
8738: <div class="sect2" lang="en">
8739: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8740: <a name="scrollkeeper-data-files"></a>18.6.9. Packages installing scrollkeeper data files</h3></div></div></div>
1.87 wiz 8741: <p>If a package installs <code class="filename">.omf</code> files, used by
8742: scrollkeeper, you need to take some extra steps to make sure they
8743: get registered in the database:</p>
1.75 rillig 8744: <div class="orderedlist"><ol type="1">
8745: <li><p>Include
1.87 wiz 8746: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
8747: instead of its <code class="filename">buildlink3.mk</code> file. This
8748: takes care of rebuilding the scrollkeeper database at
8749: installation and deinstallation time, and disallows any access
8750: to it directly from the package.</p></li>
1.75 rillig 8751: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 8752: <code class="filename">libdata/scrollkeeper</code> directory, as they
8753: will be handled automatically.</p></li>
1.76 rillig 8754: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87 wiz 8755: the PLIST. It will be handled by scrollkeeper.</p></li>
1.75 rillig 8756: </ol></div>
8757: </div>
8758: <div class="sect2" lang="en">
8759: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8760: <a name="x11-fonts"></a>18.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8761: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8762: the fonts database in the directory where they get installed at
8763: installation and deinstallation time. This can be automatically
8764: done by using the pkginstall framework.</p>
1.75 rillig 8765: <p>You can list the directories where fonts are installed in the
1.87 wiz 8766: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8767: variables, where <em class="replaceable"><code>type</code></em> can be one of
8768: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
8769: Also make sure that the database file
8770: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8771: <p>Note that you should not create new directories for fonts;
1.87 wiz 8772: instead use the standard ones to avoid that the user needs to
8773: manually configure his X server to find them.</p>
1.75 rillig 8774: </div>
8775: <div class="sect2" lang="en">
8776: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8777: <a name="gtk2-modules"></a>18.6.11. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8778: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8779: take some extra steps to get them registered in the GTK2 database
8780: properly:</p>
1.75 rillig 8781: <div class="orderedlist"><ol type="1">
8782: <li><p>Include
1.87 wiz 8783: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8784: <code class="filename">buildlink3.mk</code> file. This takes care of
8785: rebuilding the database at installation and deinstallation time.</p></li>
8786: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
8787: your package installs GTK2 immodules.</p></li>
8788: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
8789: GTK2 loaders.</p></li>
1.75 rillig 8790: <li>
1.87 wiz 8791: <p>Patch the package to not touch any of the GTK2
8792: databases directly. These are:</p>
1.75 rillig 8793: <div class="itemizedlist"><ul type="disc">
1.76 rillig 8794: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8795: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8796: </ul></div>
8797: </li>
1.87 wiz 8798: <li><p>Check the <code class="filename">PLIST</code> and remove
8799: any entries under the <code class="filename">libdata/gtk-2.0</code>
8800: directory, as they will be handled automatically.</p></li>
1.75 rillig 8801: </ol></div>
8802: </div>
8803: <div class="sect2" lang="en">
8804: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8805: <a name="sgml-xml-data"></a>18.6.12. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8806: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8807: registered in system-wide catalogs (like DTDs, sub-catalogs,
8808: etc.), you need to take some extra steps:</p>
1.75 rillig 8809: <div class="orderedlist"><ol type="1">
8810: <li><p>Include
1.87 wiz 8811: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8812: your <code class="filename">Makefile</code>, which takes care of
8813: registering those files in system-wide catalogs at
8814: installation and deinstallation time.</p></li>
1.75 rillig 8815: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 8816: any SGML catalogs installed by the package.</p></li>
1.75 rillig 8817: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 8818: any XML catalogs installed by the package.</p></li>
1.75 rillig 8819: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 8820: to be added to the SGML catalog. These come in groups of
8821: three strings; see xmlcatmgr(1) for more information
8822: (specifically, arguments recognized by the 'add' action).
8823: Note that you will normally not use this variable.</p></li>
1.75 rillig 8824: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 8825: to be added to the XML catalog. These come in groups of three
8826: strings; see xmlcatmgr(1) for more information (specifically,
8827: arguments recognized by the 'add' action). Note that you will
8828: normally not use this variable.</p></li>
1.75 rillig 8829: </ol></div>
8830: </div>
8831: <div class="sect2" lang="en">
8832: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8833: <a name="mime-database"></a>18.6.13. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 8834: <p>If a package provides extensions to the MIME database by
1.87 wiz 8835: installing <code class="filename">.xml</code> files inside
8836: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8837: need to take some extra steps to ensure that the database is kept
8838: consistent with respect to these new files:</p>
1.75 rillig 8839: <div class="orderedlist"><ol type="1">
8840: <li><p>Include
1.87 wiz 8841: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8842: (avoid using the <code class="filename">buildlink3.mk</code> file from
8843: this same directory, which is reserved for inclusion from
8844: other <code class="filename">buildlink3.mk</code> files). It takes
8845: care of rebuilding the MIME database at installation and
8846: deinstallation time, and disallows any access to it directly
8847: from the package.</p></li>
1.75 rillig 8848: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 8849: <code class="filename">share/mime</code> directory,
8850: <span class="emphasis"><em>except</em></span> for files saved under
8851: <code class="filename">share/mime/packages</code>. The former are
8852: handled automatically by
8853: the update-mime-database program, but the latter are
8854: package-dependent and must be removed by the package that
8855: installed them in the first place.</p></li>
1.76 rillig 8856: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 8857: from the PLIST. They will be handled by the shared-mime-info
8858: package.</p></li>
1.75 rillig 8859: </ol></div>
8860: </div>
8861: <div class="sect2" lang="en">
8862: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8863: <a name="intltool"></a>18.6.14. Packages using intltool</h3></div></div></div>
1.93 rillig 8864: <p>If a package uses intltool during its build, add
8865: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 8866: which forces it to use the intltool package provided by pkgsrc,
8867: instead of the one bundled with the distribution file.</p>
1.75 rillig 8868: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 8869: latest available version; this way, the package benefits of any
8870: bug fixes that may have appeared since it was released.</p>
1.75 rillig 8871: </div>
8872: <div class="sect2" lang="en">
8873: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8874: <a name="startup-scripts"></a>18.6.15. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 8875: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 8876: the startup directory by default, but you can enable it, by adding
8877: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
8878: <code class="filename">/etc/mk.conf</code>. This option will copy the scripts
8879: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8880: it will automatically remove the scripts when the package is
8881: deinstalled.</p>
1.75 rillig 8882: </div>
8883: <div class="sect2" lang="en">
8884: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8885: <a name="tex-packages"></a>18.6.16. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 8886: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 8887: the <code class="filename">ls-R</code> database of the tree needs to be
8888: updated.</p>
1.75 rillig 8889: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8890: <h3 class="title">Note</h3>
8891: <p>Except the main TeX packages such as teTeX-texmf,
1.87 wiz 8892: packages should install files
8893: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
8894: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75 rillig 8895: </div>
8896: <div class="orderedlist"><ol type="1">
8897: <li><p>Include
1.87 wiz 8898: <code class="filename">../../print/teTeX/module.mk</code> instead
8899: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
8900: takes care of rebuilding the <code class="filename">ls-R</code>
8901: database at installation and deinstallation time.</p></li>
1.75 rillig 8902: <li>
8903: <p>If your package installs files into a texmf
1.87 wiz 8904: tree other than the one
8905: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
8906: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
8907: trees that need database update.</p>
1.75 rillig 8908: <p>If your package also installs font map files that need
1.87 wiz 8909: to be registered using <span><strong class="command">updmap</strong></span>,
8910: set <code class="varname">TEX_FONTMAPS</code> to the list of all
8911: such font map files. Then <span><strong class="command">updmap</strong></span> will
8912: be run automatically at installation/deinstallation to
8913: enable/disable font map files for TeX output
8914: drivers.</p>
1.75 rillig 8915: </li>
1.76 rillig 8916: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 8917: databases are included in <code class="filename">PLIST</code>, as
8918: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 8919: </ol></div>
8920: </div>
1.85 jmmv 8921: <div class="sect2" lang="en">
8922: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8923: <a name="emulation-packages"></a>18.6.17. Packages supporting running binaries in
1.87 wiz 8924: emulation</h3></div></div></div>
8925: <p>There are some packages that provide libraries and
8926: executables for running binaries from a one operating system
8927: on a different one (if the latter supports it). One example
8928: is running Linux binaries on NetBSD.</p>
1.91 rillig 8929: <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 8930: helps in extracting and packaging Linux rpm packages.</p>
8931: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
8932: avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
8933: if all libraries for each installed executable can be found by
8934: the dynamic linker. Since the standard dynamic linker is run,
8935: this fails for emulation packages, because the libraries used
8936: by the emulation are not in the standard directories.</p>
8937: </div>
8938: <div class="sect2" lang="en">
8939: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8940: <a name="hicolor-theme"></a>18.6.18. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 8941: <p>If a package installs images under the
1.87 wiz 8942: <code class="filename">share/icons/hicolor</code> and/or updates the
8943: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8944: database, you need to take some extra steps to make sure that the
8945: shared theme directory is handled appropriately and that the cache
8946: database is rebuilt:</p>
1.85 jmmv 8947: <div class="orderedlist"><ol type="1">
8948: <li><p>Include
1.87 wiz 8949: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
8950: <li><p>Check the <code class="filename">PLIST</code> and remove the
8951: entry that refers to the theme cache.</p></li>
1.85 jmmv 8952: <li><p>Ensure that the PLIST does not remove the shared icon
8953: directories from the <code class="filename">share/icons/hicolor</code>
8954: hierarchy because they will be handled automatically.</p></li>
8955: </ol></div>
8956: <p>The best way to verify that the PLIST is correct with
8957: respect to the last two points is to regenerate it using
8958: <span><strong class="command">make print-PLIST</strong></span>.</p>
8959: </div>
8960: <div class="sect2" lang="en">
8961: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8962: <a name="desktop-files"></a>18.6.19. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 8963: <p>If a package installs <code class="filename">.desktop</code> files
8964: under <code class="filename">share/applications</code> and these include
8965: MIME information, you need to take extra steps to ensure that they
8966: are registered into the MIME database:</p>
8967: <div class="orderedlist"><ol type="1">
8968: <li><p>Include
8969: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
8970: <li><p>Check the PLIST and remove the entry that refers to the
8971: <code class="filename">share/applications/mimeinfo.cache</code> file.
8972: It will be handled automatically.</p></li>
8973: </ol></div>
8974: <p>The best way to verify that the PLIST is correct with
8975: respect to the last point is to regenerate it using <span><strong class="command">make
8976: print-PLIST</strong></span>.</p>
1.75 rillig 8977: </div>
8978: </div>
1.87 wiz 8979: <div class="sect1" lang="en">
8980: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8981: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 8982: <p>In some cases one does not have the time to solve a problem
8983: immediately. There are currently two ways to declare that one knows
8984: that a package has problems.</p>
8985: <div class="itemizedlist"><ul type="disc">
8986: <li><p>The first way is to plainly mark it as broken. For
8987: this, one just sets the variable <code class="varname">BROKEN</code> to the
8988: reason why the package is broken (similar to the
8989: <code class="varname">RESTRICTED</code> variable). A user trying to build
8990: the package will immediately be shown this message, and the build
8991: will not be even tried.</p></li>
8992: <li><p>After each pkgsrc freeze period (a time when the
8993: tree is stabilized and a new pkgsrc branch is cut), the packages
8994: that were not building in the official branch build on the latest
8995: NetBSD release will be marked as broken on that branch. This is
8996: done by setting the <code class="varname">BROKEN_IN</code> variable to the
8997: branch name (or appending the branch name to it). If a user tries
8998: to build such a package and the build fails, the user gets a
8999: message that says that the package was broken on the respective
9000: branch(es).</p></li>
9001: </ul></div>
9002: <p>Both types of packages are removed from pkgsrc in irregular
9003: intervals.</p>
9004: </div>
1.75 rillig 9005: </div>
9006: <div class="chapter" lang="en">
9007: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9008: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88 wiz 9009: <p>To check out all the gotchas when building a package, here are
9010: the steps that I do in order to get a package working. Please note
9011: this is basically the same as what was explained in the previous
9012: sections, only with some debugging aids.</p>
1.75 rillig 9013: <div class="itemizedlist"><ul type="disc">
1.88 wiz 9014: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=1</code> in
9015: <code class="filename">/etc/mk.conf</code></p></li>
1.75 rillig 9016: <li>
1.91 rillig 9017: <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 9018: create a directory for a new package, change into it, then run
9019: <span><strong class="command">url2pkg</strong></span>:</p>
1.75 rillig 9020: <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>
9021: <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>
9022: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9023: </li>
1.76 rillig 9024: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9025: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87 wiz 9026: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75 rillig 9027: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9028: configure step to the package's
9029: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 9030: <li>
9031: <p>Make the package compile, doing multiple rounds of</p>
9032: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9033: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9034: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9035: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9036: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9037: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9038: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9039: <p>Doing this step as non-root user will ensure that no files
9040: are modified that shouldn't be, especially during the build
9041: phase. <span><strong class="command">mkpatches</strong></span>,
9042: <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91 rillig 9043: 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 9044: package.</p>
1.75 rillig 9045: </li>
1.88 wiz 9046: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90 rillig 9047: necessary; see <a href="#components.Makefile" title="10.1. Makefile">Section 10.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.75 rillig 9048: <li>
1.76 rillig 9049: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9050: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9051: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9052: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9053: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9054: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9055: <p>You usually need to be <code class="username">root</code> to do
9056: this. Look if there are any files left:</p>
1.75 rillig 9057: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9058: <p>If this reveals any files that are missing in
1.88 wiz 9059: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9060: </li>
9061: <li>
1.88 wiz 9062: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9063: package again and make a binary package:</p>
1.75 rillig 9064: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9065: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9066: </li>
9067: <li>
9068: <p>Delete the installed package:</p>
1.88 wiz 9069: <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 9070: </li>
9071: <li>
1.88 wiz 9072: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
9073: command, which shouldn't find anything now:</p>
1.75 rillig 9074: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9075: </li>
9076: <li>
9077: <p>Reinstall the binary package:</p>
1.93 rillig 9078: <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 9079: </li>
1.88 wiz 9080: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9081: <li>
1.91 rillig 9082: <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 9083: reports:</p>
1.75 rillig 9084: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9085: </li>
1.90 rillig 9086: <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 9087: </ul></div>
9088: </div>
9089: <div class="chapter" lang="en">
9090: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9091: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75 rillig 9092: <div class="toc">
9093: <p><b>Table of Contents</b></p>
9094: <dl>
1.90 rillig 9095: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
9096: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9097: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
9098: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
9099: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
9100: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9101: </dl>
9102: </div>
9103: <div class="sect1" lang="en">
9104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9105: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9106: <p>Our policy is that we accept binaries only from pkgsrc
9107: developers to guarantee that the packages don't contain any
9108: trojan horses etc. This is not to annoy anyone but rather to
9109: protect our users! You're still free to put up your home-made
9110: binary packages and tell the world where to get them. NetBSD
9111: developers doing bulk builds and wanting to upload them please
9112: 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>
9113: </div>
9114: <div class="sect1" lang="en">
9115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9116: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9117: <p>First, check that your package is complete, compiles and
1.90 rillig 9118: runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75 rillig 9119: 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 9120: archive that contains all files that make up the package.
1.87 wiz 9121: Finally, send this package to the pkgsrc bug tracking system,
9122: 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
9123: that, go to the web page
9124: <a href="http://www.NetBSD.org/Misc/send-pr.html" target="_top">http://www.NetBSD.org/Misc/send-pr.html</a>,
9125: which contains some instructions and a link to a form, where you
9126: can submit packages.</p>
9127: <p>In the form of the problem report, the category should be
9128: “<span class="quote">pkg</span>”, the synopsis should include the package name
9129: and version number, and the description field should contain a
9130: short description of your package (contents of the COMMENT
9131: variable or DESCR file are OK). The uuencoded package data should
9132: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9133: <p>If you want to submit several packages, please send a
9134: separate PR for each one, it's easier for us to track things
9135: that way.</p>
9136: <p>Alternatively, you can also import new packages into
9137: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
9138: homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9139: for details.</p>
9140: </div>
9141: <div class="sect1" lang="en">
9142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9143: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9144: <p>Please note all package additions, updates, moves, and
1.93 rillig 9145: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9146: important to keep this file up to date and conforming to the
9147: existing format, because it will be used by scripts to
9148: automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9149: sites. Additionally, check the
1.76 rillig 9150: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9151: for the package you updated or removed, in case it was mentioned
9152: there.</p>
9153: <p>When the <code class="varname">PKGREVISION</code> of a package is
9154: bumped, the change should appear in
1.93 rillig 9155: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9156: related or otherwise relevant. Mass bumps that result from a
9157: dependency being updated should not be mentioned. In all other
9158: cases it's the developer's decision.</p>
9159: <p>There is a make target that helps in creating proper
1.93 rillig 9160: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span><strong class="command">make
1.75 rillig 9161: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9162: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9163: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9164: file is up-to-date (to avoid having to resolve conflicts later-on)
9165: and then to <span><strong class="command">cd</strong></span> to the package directory. For
9166: package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
9167: For new packages, or package moves or removals, set the
9168: <code class="varname">CTYPE</code> variable on the command line to "Added",
9169: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.76 rillig 9170: in <code class="filename">/etc/mk.conf</code> if your local login name is
1.75 rillig 9171: not the same as your NetBSD login name. Don't forget to commit
1.93 rillig 9172: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75 rillig 9173: </div>
9174: <div class="sect1" lang="en">
9175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9176: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9177: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9178: access to the pkgsrc repository. Please remember that cvs
9179: imports files relative to the current working directory, and that
9180: the pathname that you
9181: give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
9182: to place the files in the repository. Newly created packages should be
9183: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9184: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9185: <pre class="programlisting">
9186: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9187: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
9188: </pre>
1.87 wiz 9189: <p>Remember to move the directory from which you imported out of
1.75 rillig 9190: the way, or cvs will complain the next time you “<span class="quote">cvs
9191: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9192: package to the category's <code class="filename">Makefile</code>.</p>
9193: <p>The commit message of the initial import should include part of the
1.76 rillig 9194: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9195: what the package is/does.</p>
9196: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9197: add</span>” because the former gets everything with a single command,
1.87 wiz 9198: and provides a consistent tag.</p>
1.75 rillig 9199: </div>
9200: <div class="sect1" lang="en">
9201: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9202: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9203: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9204: changes between old and new versions into the commit log when updating
1.87 wiz 9205: a package. There are various reasons for this:</p>
1.75 rillig 9206: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9207: <li><p>A URL is volatile, and can change over time. It may go away completely
9208: or its information may be overwritten by newer information.</p></li>
9209: <li><p>Having the change information between old and new versions in our CVS
9210: repository is very useful for people who use either cvs or anoncvs.</p></li>
9211: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9212: repository is very useful for people who read the pkgsrc-changes mailing
9213: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9214: the package.</p></li>
1.75 rillig 9215: </ul></div>
1.87 wiz 9216: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9217: has been released, it should not automatically be upgraded in the CVS
9218: repository. We prefer to be conservative in the packages that are
9219: included in pkgsrc - development or beta packages are not really the
9220: best thing for most places in which pkgsrc is used. Please use your
9221: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9222: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9223: </div>
9224: <div class="sect1" lang="en">
9225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9226: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75 rillig 9227: <div class="orderedlist"><ol type="1">
9228: <li><p>Make a copy of the directory somewhere else.</p></li>
9229: <li>
9230: <p>Remove all CVS dirs.</p>
1.87 wiz 9231: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9232: <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 9233: <p>and use that for further work.</p>
1.75 rillig 9234: </li>
9235: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9236: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9237: instead of “<span class="quote">../../category/package</span>”.</p></li>
9238: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
9239: place.</p></li>
9240: <li>
9241: <p>Check if any package depends on it:
9242: </p>
9243: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9244: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9245: </li>
9246: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
9247: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9248: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9249: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9250: <li>
9251: <p>Commit the changed and removed files:</p>
9252: <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 9253: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9254: </li>
9255: </ol></div>
9256: </div>
9257: </div>
9258: <div class="chapter" lang="en">
9259: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9260: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9261: <p>This section contains the answers to questions that may
9262: arise when you are writing a package. If you don't find your
9263: question answered here, first have a look in the other chapters,
9264: and if you still don't have the answer, ask on the
9265: <code class="literal">pkgsrc-users</code> mailing list.</p>
9266: <div class="qandaset">
9267: <dl>
1.93 rillig 9268: <dt>21.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9269: MAKEFLAGS, .MAKEFLAGS and
9270: MAKE_FLAGS?</a>
9271: </dt>
1.93 rillig 9272: <dt>21.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9273: MAKE, GMAKE and
9274: MAKE_PROGRAM?</a>
9275: </dt>
1.93 rillig 9276: <dt>21.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9277: CC, PKG_CC and
9278: PKGSRC_COMPILER?</a>
9279: </dt>
1.93 rillig 9280: <dt>21.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9281: BUILDLINK_LDFLAGS,
9282: BUILDLINK_LDADD and
9283: BUILDLINK_LIBS?</a>
9284: </dt>
1.93 rillig 9285: <dt>21.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9286: VARNAME=BUILDLINK_PREFIX.foo
9287: say it's empty?</a>
9288: </dt>
1.93 rillig 9289: <dt>21.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9290: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9291: don't understand the := inside
9292: it.</a>
9293: </dt>
1.93 rillig 9294: <dt>21.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9295: developers?</a>
9296: </dt>
1.93 rillig 9297: <dt>21.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9298: documentation?</a>
9299: </dt>
1.92 rillig 9300: <dt>21.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
9301: do?</a>
9302: </dt>
1.75 rillig 9303: </dl>
9304: <table border="0" summary="Q and A Set">
9305: <col align="left" width="1%">
9306: <tbody>
9307: <tr class="question">
9308: <td align="left" valign="top">
1.96 ! rillig 9309: <a name="devfaq.makeflags"></a><a name="id2685982"></a><b>21.1.</b>
1.75 rillig 9310: </td>
9311: <td align="left" valign="top"><p>What is the difference between
9312: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9313: <code class="varname">MAKE_FLAGS</code>?</p></td>
9314: </tr>
9315: <tr class="answer">
1.91 rillig 9316: <td align="left" valign="top"></td>
1.75 rillig 9317: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9318: 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
9319: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9320: the <code class="varname">MAKE_PROGRAM</code> when building the
9321: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9322: </tr>
9323: <tr class="question">
9324: <td align="left" valign="top">
1.96 ! rillig 9325: <a name="devfaq.make"></a><a name="id2686021"></a><b>21.2.</b>
1.75 rillig 9326: </td>
9327: <td align="left" valign="top"><p>What is the difference between
9328: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9329: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9330: </tr>
9331: <tr class="answer">
1.91 rillig 9332: <td align="left" valign="top"></td>
1.75 rillig 9333: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9334: <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
9335: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9336: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9337: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9338: Make program that is used for building the
9339: package.</p></td>
9340: </tr>
9341: <tr class="question">
9342: <td align="left" valign="top">
1.96 ! rillig 9343: <a name="devfaq.cc"></a><a name="id2686061"></a><b>21.3.</b>
1.75 rillig 9344: </td>
9345: <td align="left" valign="top"><p>What is the difference between
9346: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9347: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9348: </tr>
9349: <tr class="answer">
1.91 rillig 9350: <td align="left" valign="top"></td>
1.75 rillig 9351: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9352: compiler, which can be configured by the pkgsrc user.
9353: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9354: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9355: path to a compiler, but the type of compiler that should be
1.76 rillig 9356: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9357: information about the latter variable.</p></td>
9358: </tr>
9359: <tr class="question">
9360: <td align="left" valign="top">
1.96 ! rillig 9361: <a name="devfaq.bl3flags"></a><a name="id2686101"></a><b>21.4.</b>
1.75 rillig 9362: </td>
9363: <td align="left" valign="top"><p>What is the difference between
9364: <code class="varname">BUILDLINK_LDFLAGS</code>,
9365: <code class="varname">BUILDLINK_LDADD</code> and
9366: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9367: </tr>
9368: <tr class="answer">
1.91 rillig 9369: <td align="left" valign="top"></td>
1.75 rillig 9370: <td align="left" valign="top"><p>[FIXME]</p></td>
9371: </tr>
9372: <tr class="question">
9373: <td align="left" valign="top">
1.96 ! rillig 9374: <a name="devfaq.bl3prefix"></a><a name="id2686121"></a><b>21.5.</b>
1.75 rillig 9375: </td>
9376: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
9377: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9378: say it's empty?</p></td>
9379: </tr>
9380: <tr class="answer">
1.91 rillig 9381: <td align="left" valign="top"></td>
1.75 rillig 9382: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9383: available in the “<span class="quote">wrapper</span>” phase and later. To
9384: “<span class="quote">simulate</span>” the wrapper phase, append
9385: <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
9386: command.</p></td>
9387: </tr>
1.78 rillig 9388: <tr class="question">
9389: <td align="left" valign="top">
1.96 ! rillig 9390: <a name="devfaq.master_sites"></a><a name="id2686151"></a><b>21.6.</b>
1.78 rillig 9391: </td>
9392: <td align="left" valign="top"><p>What does
9393: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9394: don't understand the <code class="literal">:=</code> inside
9395: it.</p></td>
9396: </tr>
9397: <tr class="answer">
1.91 rillig 9398: <td align="left" valign="top"></td>
1.78 rillig 9399: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9400: assignment operator, like you might expect at first sight.
9401: Instead, it is a degenerate form of
9402: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9403: 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
9404: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9405: case of <code class="varname">MASTER_SITE_*</code>,
9406: <em class="replaceable"><code>old_string</code></em> is the empty string and
9407: <em class="replaceable"><code>new_string</code></em> is
9408: <code class="literal">package/</code>. That's where the
9409: <code class="literal">:</code> and the <code class="literal">=</code> fall
9410: together.</p></td>
9411: </tr>
9412: <tr class="question">
9413: <td align="left" valign="top">
1.96 ! rillig 9414: <a name="devfaq.mailinglists"></a><a name="id2686296"></a><b>21.7.</b>
1.78 rillig 9415: </td>
9416: <td align="left" valign="top"><p>Which mailing lists are there for package
9417: developers?</p></td>
9418: </tr>
9419: <tr class="answer">
1.91 rillig 9420: <td align="left" valign="top"></td>
1.78 rillig 9421: <td align="left" valign="top"><div class="variablelist"><dl>
9422: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
9423: <dd><p>This is a list for technical discussions related
9424: to pkgsrc development, e.g. soliciting feedback for changes to
9425: pkgsrc infrastructure, proposed new features, questions related
9426: to porting pkgsrc to a new platform, advice for maintaining a
9427: package, patches that affect many packages, help requests moved
9428: from pkgsrc-users when an infrastructure bug is found,
9429: etc.</p></dd>
9430: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
9431: <dd><p>All bug reports in category "pkg" sent with
9432: <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
9433: directly; use one of the other mailing
9434: lists.</p></dd>
9435: </dl></div></td>
9436: </tr>
1.80 rillig 9437: <tr class="question">
9438: <td align="left" valign="top">
1.96 ! rillig 9439: <a name="devfaq.documentation"></a><a name="id2686334"></a><b>21.8.</b>
1.80 rillig 9440: </td>
9441: <td align="left" valign="top"><p>Where is the pkgsrc
9442: documentation?</p></td>
9443: </tr>
9444: <tr class="answer">
1.91 rillig 9445: <td align="left" valign="top"></td>
1.80 rillig 9446: <td align="left" valign="top">
9447: <p>There are many places where you can find
9448: documentation about pkgsrc:</p>
9449: <div class="itemizedlist"><ul type="disc">
9450: <li><p>The pkgsrc guide (this document) is a collection
9451: of chapters that explain large parts of pkgsrc, but some
9452: chapters tend to be outdated. Which ones they are is hard to
9453: say.</p></li>
9454: <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
9455: about certain features, announcements of new parts of the pkgsrc
9456: infrastructure and sometimes even announcements that a certain
9457: feature has been marked as obsolete. The benefit here is that
9458: each message has a date appended to it.</p></li>
9459: <li><p>Many of the files in the
9460: <code class="filename">mk/</code> directory start with a comment that
9461: describes the purpose of the file and how it can be used by the
1.92 rillig 9462: pkgsrc user and package authors. An easy way to find this
9463: documentation is to run <span><strong class="command">bmake
9464: help</strong></span>.</p></li>
1.80 rillig 9465: <li><p>The CVS log messages are a rich source of
9466: information, but they tend to be highly abbreviated, especially
9467: for actions that occur often. Some contain a detailed
9468: description of what has changed, but they are geared towards the
9469: other pkgsrc developers, not towards an average pkgsrc user.
9470: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9471: don't know what has been before, these messages may not be worth
9472: too much to you.</p></li>
9473: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9474: documented</span>”, that is the documentation exists only in the
9475: mind of the developer who wrote the code. To get this
1.93 rillig 9476: information, use the <span><strong class="command">cvs annotate</strong></span> command
1.80 rillig 9477: to see who has written it and ask on the
9478: <code class="literal">tech-pkg</code> mailing list, so that others can
9479: find your questions later (see above). To be sure that the
9480: developer in charge reads the mail, you may CC him or
9481: her.</p></li>
9482: </ul></div>
9483: </td>
9484: </tr>
1.92 rillig 9485: <tr class="question">
9486: <td align="left" valign="top">
1.96 ! rillig 9487: <a name="devfaq.too-much-time"></a><a name="id2686396"></a><b>21.9.</b>
1.92 rillig 9488: </td>
9489: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9490: do?</p></td>
9491: </tr>
9492: <tr class="answer">
9493: <td align="left" valign="top"></td>
9494: <td align="left" valign="top">
1.93 rillig 9495: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9496: anyway.</p>
9497: <div class="itemizedlist"><ul type="disc">
9498: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
9499: <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
9500: will tell you about newer versions of installed packages that are
9501: available, but not yet updated in pkgsrc.</p></li>
9502: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
9503: — it contains a list of suggested new packages and a list of
9504: cleanups and enhancements for pkgsrc that would be nice to
9505: have.</p></li>
9506: <li><p>Review packages for which review was requested on
9507: the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9508: mailing list.</p></li>
9509: </ul></div>
9510: </td>
9511: </tr>
1.75 rillig 9512: </tbody>
9513: </table>
9514: </div>
9515: </div>
1.85 jmmv 9516: <div class="chapter" lang="en">
9517: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9518: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9519: <div class="toc">
9520: <p><b>Table of Contents</b></p>
9521: <dl>
1.90 rillig 9522: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9523: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9524: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9525: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 9526: </dl>
9527: </div>
9528: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
9529: site</a>:</p>
9530: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9531: environment, an intuitive and attractive desktop for users, and the
9532: GNOME development platform, an extensive framework for building
9533: applications that integrate into the rest of the desktop.</p></blockquote></div>
9534: <p>pkgsrc provides a seamless way to automatically build and install
9535: a complete GNOME environment <span class="emphasis"><em>under many different
9536: platforms</em></span>. We can say with confidence that pkgsrc is one of
9537: the most advanced build and packaging systems for GNOME due to its
9538: included technologies buildlink3, the wrappers and tools framework and
9539: automatic configuration file management. Lots of efforts are put into
9540: achieving a completely clean deinstallation of installed software
9541: components.</p>
9542: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9543: the above also means that great efforts are put into making GNOME work
9544: under this operating system. Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9545: pkgsrc as its preferred packaging system, contributing lots of
9546: portability fixes to make GNOME build and install under it.</p>
9547: <p>This chapter is aimed at pkgsrc developers and other people
9548: interested in helping our GNOME porting and packaging efforts. It
9549: provides instructions on how to manage the existing packages and some
9550: important information regarding their internals.</p>
9551: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9552: <h3 class="title">We need your help!</h3>
9553: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9554: and GNOME and are willing to learn new exciting stuff, please jump
9555: straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9556: work</a> list! There is still a long way to go to get a
9557: fully-functional GNOME desktop under NetBSD and we need your help to
9558: achieve it!</p>
9559: </div>
9560: <div class="sect1" lang="en">
9561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9562: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85 jmmv 9563: <p>pkgsrc includes three GNOME-related meta packages:</p>
9564: <div class="itemizedlist"><ul type="disc">
1.91 rillig 9565: <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 9566: the core GNOME desktop environment. It only includes the necessary
9567: bits to get it to boot correctly, although it may lack important
9568: functionality for daily operation. The idea behind this package is
9569: to let end users build their own configurations on top of this one,
9570: first installing this meta package to achieve a functional setup and
9571: then adding individual applications.</p></li>
1.91 rillig 9572: <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 9573: complete installation of the GNOME platform and desktop as defined
9574: by the GNOME project; this is based on the components distributed in
9575: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9576: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9577: official FTP server. Developer-only tools found in those
9578: directories are not installed unless required by some other
9579: component to work properly. Similarly, packages from the bindings
9580: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9581: in unless required as a dependency for an end-user component. This
1.91 rillig 9582: 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>
9583: <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 9584: Installs all the tools required to build a GNOME component when
9585: fetched from the CVS repository. These are required to let the
9586: <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
9587: </ul></div>
9588: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9589: sorted in a way that eases updates: a package may depend on other
9590: packages listed before it but not on any listed after it. It is very
9591: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9592: change it to alphabetical sorting!</em></span></p>
9593: </div>
9594: <div class="sect1" lang="en">
9595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9596: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9597: <p>Almost all GNOME applications are written in C and use a common
9598: set of tools as their build system. Things get different with the new
9599: bindings to other languages (such as Python), but the following will
9600: give you a general idea on the minimum required tools:</p>
9601: <div class="itemizedlist"><ul type="disc">
9602: <li>
9603: <p>Almost all GNOME applications use the GNU Autotools as their
9604: build system. As a general rule you will need to tell this to your
9605: package:</p>
9606: <pre class="programlisting">GNU_CONFIGURE=yes
9607: USE_LIBTOOL=yes
9608: USE_TOOLS+=gmake</pre>
9609: </li>
9610: <li>
9611: <p>If the package uses pkg-config to detect dependencies, add this
9612: tool to the list of required utilities:</p>
9613: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9614: <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 9615: the end of the build process to ensure that you did not miss to
9616: specify any dependency in your package and that the version
9617: requirements are all correct.</p>
9618: </li>
1.93 rillig 9619: <li><p>If the package uses intltool, be sure to add
9620: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9621: to handle dependencies and to force the package to use the latest
9622: available version.</p></li>
9623: <li>
9624: <p>If the package uses gtk-doc (a documentation generation
9625: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9626: tool is rather big and the distfile should come with pregenerated
9627: documentation anyway; if it does not, it is a bug that you ought to
9628: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9629: the default):</p>
9630: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9631: <p>The default location of installed HTML files
9632: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9633: and should not be changed unless the package insists on installing
9634: them somewhere else. Otherwise programs as
9635: <span><strong class="command">devhelp</strong></span> will not be able to open them. You can
9636: do that with an entry similar to:</p>
9637: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9638: </li>
9639: </ul></div>
9640: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9641: files under the installation prefix to maintain databases. In this
9642: context, shared means that those exact same directories and files are
9643: used among several different packages, leading to conflicts in the
9644: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9645: handle the most common cases, so you have to forget about using
9646: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9647: omitting shared files from them. If you find yourself doing those,
9648: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9649: <p>The following table lists the common situations that result in
9650: using shared directories or files. For each of them, the appropriate
9651: solution is given. After applying the solution be sure to
9652: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9653: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
9654: <div class="table">
1.90 rillig 9655: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9656: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9657: <colgroup>
9658: <col>
9659: <col>
9660: </colgroup>
9661: <thead><tr>
9662: <th>If the package...</th>
9663: <th>Then...</th>
9664: </tr></thead>
9665: <tbody>
9666: <tr>
9667: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.90 rillig 9668: <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 9669: </tr>
9670: <tr>
9671: <td>Installs icons under the
9672: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9673: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.90 rillig 9674: <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 9675: </tr>
9676: <tr>
9677: <td>Installs files under
9678: <code class="filename">share/mime/packages</code>.</td>
1.90 rillig 9679: <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 9680: </tr>
9681: <tr>
9682: <td>Installs <code class="filename">.desktop</code> files under
9683: <code class="filename">share/applications</code> and these include MIME
9684: information.</td>
1.90 rillig 9685: <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 9686: </tr>
9687: </tbody>
1.91 rillig 9688: </table></div>
1.85 jmmv 9689: </div>
1.91 rillig 9690: <br class="table-break">
1.85 jmmv 9691: </div>
9692: <div class="sect1" lang="en">
9693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9694: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9695: <p>When seeing GNOME as a whole, there are two kinds of
9696: updates:</p>
9697: <div class="variablelist"><dl>
9698: <dt><span class="term">Major update</span></dt>
9699: <dd>
9700: <p>Given that there is still a very long way for GNOME 3 (if it
9701: ever appears), we consider a major update one that goes from a
9702: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9703: where <code class="literal">Y</code> is even and greater than
9704: <code class="literal">X</code>. These are hard to achieve because they
9705: introduce lots of changes in the components' code and almost all
9706: GNOME distfiles are updated to newer versions. Some of them can
9707: even break API and ABI compatibility with the previous major
9708: version series. As a result, the update needs to be done all at
9709: once to minimize breakage.</p>
9710: <p>A major update typically consists of around 80 package
9711: updates and the addition of some new ones.</p>
9712: </dd>
9713: <dt><span class="term">Minor update</span></dt>
9714: <dd>
9715: <p>We consider a minor update one that goes from a
9716: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9717: one where <code class="literal">Y</code> is greater than
9718: <code class="literal">X</code>. These are easy to achieve because they do
9719: not update all GNOME components, can be done in an incremental way
9720: and do not break API nor ABI compatibility.</p>
9721: <p>A minor update typically consists of around 50 package
9722: updates, although the numbers here may vary a lot.</p>
9723: </dd>
9724: </dl></div>
9725: <p>In order to update the GNOME components in pkgsrc to a new stable
9726: release (either major or minor), the following steps should be
9727: followed:</p>
9728: <div class="orderedlist"><ol type="1">
9729: <li>
9730: <p>Get a list of all the tarballs that form the new release by
9731: using the following commands. These will leave the full list of the
9732: components's distfiles into the <code class="filename">list.txt</code>
9733: file:</p>
1.88 wiz 9734: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9735: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9736: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9737: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9738: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9739: awk '{ print $9 }' >>list.txt</code></strong></pre>
9740: </li>
9741: <li><p>Open each meta package's <code class="filename">Makefile</code> and
9742: bump their version to the release you are updating them to. The
9743: three meta packages should be always consistent with versioning.
9744: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9745: in them.</p></li>
9746: <li>
9747: <p>For each meta package, update all its
9748: <code class="varname">DEPENDS</code> lines to match the latest versions as
9749: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9750: newer version (even if found in the FTP) because the meta packages
9751: are supposed to list the exact versions that form a specific GNOME
9752: release. Exceptions are permitted here if a newer version solves a
9753: serious issue in the overall desktop experience; these typically
9754: come in the form of a revision bump in pkgsrc, not in newer versions
9755: from the developers.</p>
9756: <p>Packages not listed in the <code class="filename">list.txt</code> file
9757: should be updated to the latest version available (if found in
9758: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 9759: 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 9760: </li>
9761: <li>
9762: <p>Generate a patch from the modified meta packages and extract the
9763: list of "new" lines. This will provide you an outline on what
9764: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9765: <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 9766: </li>
9767: <li><p>For major desktop updates it is recommended to zap all your
9768: installed packages and start over from scratch at this point.</p></li>
9769: <li><p>Now comes the longest step by far: iterate over the contents
9770: of <code class="filename">todo.txt</code> and update the packages listed in
9771: it in order. For major desktop updates none of these should be
1.93 rillig 9772: committed until the entire set is completed because there are chances
1.85 jmmv 9773: of breaking not-yet-updated packages.</p></li>
9774: <li><p>Once the packages are up to date and working, commit them to
9775: the tree one by one with appropriate log messages. At the end,
9776: commit the three meta package updates and all the corresponding
9777: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9778: <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>
9779: </ol></div>
9780: </div>
9781: <div class="sect1" lang="en">
9782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9783: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 9784: <p>GNOME is a very big component in pkgsrc which approaches 100
9785: packages. Please, it is very important that you always, always,
9786: <span class="strong"><strong>always</strong></span> feed back any portability
1.93 rillig 9787: 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 9788: their attention on portability issues and to ensure that future versions
9789: can be built out-of-the box on NetBSD. The less custom patches in
9790: pkgsrc, the easier further updates are. Those developers in charge of
9791: issuing major GNOME updates will be grateful if you do that.</p>
9792: <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
9793: Bugzilla</a>. Not all components use these to track bugs, but most
9794: of them do. Do not be short on your reports: always provide detailed
9795: explanations of the current failure, how it can be improved to achieve
9796: maximum portability and, if at all possible, provide a patch against CVS
9797: head. The more verbose you are, the higher chances of your patch being
9798: accepted.</p>
9799: <p>Also, please avoid using preprocessor magic to fix portability
9800: issues. While the FreeBSD GNOME people are doing a great job in porting
9801: GNOME to their operating system, the official GNOME sources are now
9802: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9803: and similar macros. This hurts portability. Please see our patching
1.93 rillig 9804: guidelines (<a href="#components.patches.guidelines" title="10.3.4. Patching guidelines">Section 10.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 9805: details.</p>
9806: </div>
9807: </div>
1.75 rillig 9808: </div>
9809: <div class="part" lang="en">
9810: <div class="titlepage"><div><div><h1 class="title">
9811: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
9812: <div class="partintro" lang="en">
9813: <div></div>
9814: <p>This part of the guide deals with everything
9815: from the infrastructure that is behind the interfaces described
9816: in the developer's guide. A casual package maintainer should not
9817: need anything from this part.</p>
9818: <div class="toc">
9819: <p><b>Table of Contents</b></p>
9820: <dl>
1.90 rillig 9821: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 9822: <dd><dl>
1.90 rillig 9823: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
9824: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
9825: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75 rillig 9826: <dd><dl>
1.90 rillig 9827: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
9828: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75 rillig 9829: </dl></dd>
1.90 rillig 9830: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
9831: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 9832: <dd><dl>
1.90 rillig 9833: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
9834: <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 9835: </dl></dd>
1.90 rillig 9836: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81 rillig 9837: <dd><dl>
1.90 rillig 9838: <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>
9839: <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 9840: </dl></dd>
9841: </dl></dd>
1.90 rillig 9842: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 9843: <dd><dl>
1.90 rillig 9844: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
9845: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
9846: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 9847: <dd><dl>
1.90 rillig 9848: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
9849: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 9850: </dl></dd>
9851: </dl></dd>
1.90 rillig 9852: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 9853: <dd><dl>
1.90 rillig 9854: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
9855: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 9856: </dl></dd>
9857: </dl>
9858: </div>
9859: </div>
9860: <div class="chapter" lang="en">
9861: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9862: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 9863: <div class="toc">
9864: <p><b>Table of Contents</b></p>
9865: <dl>
1.90 rillig 9866: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
9867: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
9868: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 9869: <dd><dl>
1.90 rillig 9870: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
9871: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 9872: </dl></dd>
1.90 rillig 9873: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
9874: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 9875: <dd><dl>
1.90 rillig 9876: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
9877: <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 9878: </dl></dd>
1.90 rillig 9879: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 9880: <dd><dl>
1.90 rillig 9881: <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>
9882: <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 9883: </dl></dd>
9884: </dl>
9885: </div>
9886: <p>The pkgsrc infrastructure consists of many small Makefile
9887: fragments. Each such fragment needs a properly specified
9888: interface. This chapter explains how such an interface looks
9889: like.</p>
9890: <div class="sect1" lang="en">
9891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9892: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 9893: <p>Whenever a variable is defined in the pkgsrc
9894: infrastructure, the location and the way of definition provide
9895: much information about the intended use of that variable.
9896: Additionally, more documentation may be found in a header
9897: comment or in this pkgsrc guide.</p>
9898: <p>A special file is
9899: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9900: variables that are intended to be user-defined. They are either
9901: defined using the <code class="literal">?=</code> operator or they are
9902: left undefined because defining them to anything would
9903: effectively mean “<span class="quote">yes</span>”. All these variables may be
9904: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9905: file.</p>
9906: <p>Outside this file, the following conventions apply:
9907: Variables that are defined using the <code class="literal">?=</code>
9908: operator may be overridden by a package.</p>
9909: <p>Variables that are defined using the <code class="literal">=</code>
9910: operator may be used read-only at run-time.</p>
9911: <p>Variables whose name starts with an underscore must not be
9912: accessed outside the pkgsrc infrastructure at all. They may
9913: change without further notice.</p>
9914: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9915: <h3 class="title">Note</h3>
9916: <p>These conventions are currently not applied
9917: consistently to the complete pkgsrc
9918: infrastructure.</p>
9919: </div>
9920: </div>
9921: <div class="sect1" lang="en">
9922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9923: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 9924: <p>All variables that contain lists of things should default
9925: to being empty. Two examples that do not follow this rule are
9926: <code class="varname">USE_LANGUAGES</code> and
9927: <code class="varname">DISTFILES</code>. These variables cannot simply be
9928: modified using the <code class="literal">+=</code> operator in package
9929: <code class="filename">Makefile</code>s (or other files included by
9930: them), since there is no guarantee whether the variable is
9931: already set or not, and what its value is. In the case of
9932: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
9933: the default value and just define it as in the following
9934: example.</p>
9935: <pre class="programlisting">
9936: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9937: </pre>
9938: <p>Because of the selection of this default value, the same
9939: value appears in many package Makefiles. Similarly for
9940: <code class="varname">USE_LANGUAGES</code>, but in this case the default
9941: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
9942: doesn't stand out. Nevertheless it is mentioned in many
9943: files.</p>
9944: </div>
9945: <div class="sect1" lang="en">
9946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9947: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75 rillig 9948: <div class="sect2" lang="en">
9949: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9950: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75 rillig 9951: <p>Variable evaluation takes place either at load time or at
9952: runtime, depending on the context in which they occur. The
9953: contexts where variables are evaluated at load time are:</p>
9954: <div class="itemizedlist"><ul type="disc">
9955: <li><p>The right hand side of the <code class="literal">:=</code>
9956: and <code class="literal">!=</code> operators,</p></li>
9957: <li><p>Make directives like <code class="literal">.if</code> or
9958: <code class="literal">.for</code>,</p></li>
9959: <li><p>Dependency lines.</p></li>
9960: </ul></div>
9961: <p>A special exception are references to the iteration
9962: variables of <code class="literal">.for</code> loops, which are expanded
9963: inline, no matter in which context they appear.</p>
9964: <p>As the values of variables may change during load time,
9965: care must be taken not to evaluate them by accident. Typical
9966: examples for variables that should not be evaluated at load time
9967: are <code class="varname">DEPENDS</code> and
9968: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9969: clear, here is an example:</p>
9970: <pre class="programlisting">
9971: CONFIGURE_ARGS= # none
9972: CFLAGS= -O
9973: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 9974:
1.75 rillig 9975: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 9976:
1.75 rillig 9977: CFLAGS+= -Wall
9978: </pre>
9979: <p>This code shows how the use of the <code class="literal">:=</code>
9980: operator can quickly lead to unexpected results. The first
9981: paragraph is fairly common code. The second paragraph evaluates
9982: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9983: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9984: <code class="literal">-Wall</code> is appended to the
9985: <code class="varname">CFLAGS</code>, but this addition will not appear in
9986: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9987: paragraphs from above typically occur in completely unrelated
9988: files.</p>
9989: </div>
9990: <div class="sect2" lang="en">
9991: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9992: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75 rillig 9993: <p>After all the files have been loaded, the values of the
9994: variables cannot be changed anymore. Variables that are used in
9995: the shell commands are expanded at this point.</p>
9996: </div>
9997: </div>
9998: <div class="sect1" lang="en">
9999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10000: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10001: <p>There are many ways in which the definition and use of a
10002: variable can be restricted in order to detect bugs and
10003: violations of the (mostly unwritten) policies. See the
10004: <code class="literal">pkglint</code> developer's documentation for further
10005: details.</p>
10006: </div>
10007: <div class="sect1" lang="en">
10008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10009: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10010: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10011: of the following classes. Cases where a file falls into more
10012: than one class should be avoided as it often leads to subtle
10013: bugs.</p>
10014: <div class="sect2" lang="en">
10015: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10016: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10017: <p>In a traditional imperative programming language some of
1.76 rillig 10018: the <code class="filename">.mk</code> files could be described as
1.89 rillig 10019: procedures. They take some input parameters and—after
10020: inclusion—provide a result in output parameters. Since all
1.76 rillig 10021: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10022: care must be taken not to use parameter names that have already
10023: another meaning. For example, <code class="varname">PKGNAME</code> is a
10024: bad choice for a parameter name.</p>
10025: <p>Procedures are completely evaluated at preprocessing time.
10026: That is, when calling a procedure all input parameters must be
10027: completely resolvable. For example,
10028: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10029: parameter since it is very likely that further text will be
10030: added after calling the procedure, which would effectively apply
10031: the procedure to only a part of the variable. Also, references
10032: to other variables wit will be modified after calling the
10033: procedure.</p>
10034: <p>A procedure can declare its output parameters either as
10035: suitable for use in preprocessing directives or as only
10036: available at runtime. The latter alternative is for variables
10037: that contain references to other runtime variables.</p>
10038: <p>Procedures shall be written such that it is possible to
10039: call the procedure more than once. That is, the file must not
10040: contain multiple-inclusion guards.</p>
10041: <p>Examples for procedures are
1.76 rillig 10042: <code class="filename">mk/bsd.options.mk</code> and
10043: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10044: that the parameters are evaluated at load time, they should be
10045: assigned using the <code class="literal">:=</code> operator, which should
10046: be used only for this purpose.</p>
10047: </div>
10048: <div class="sect2" lang="en">
10049: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10050: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10051: <p>Action files take some input parameters and may define
10052: runtime variables. They shall not define loadtime variables.
10053: There are action files that are included implicitly by the
10054: pkgsrc infrastructure, while other must be included
10055: explicitly.</p>
10056: <p>An example for action files is
1.76 rillig 10057: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10058: </div>
10059: </div>
1.81 rillig 10060: <div class="sect1" lang="en">
10061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10062: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10063: <p>Package <code class="filename">Makefile</code>s usually consist of
10064: a set of variable definitions, and include the file
10065: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10066: Before that, they may also include various other
10067: <code class="filename">*.mk</code> files if they need to query the
10068: availability of certain features like the type of compiler or
10069: the X11 implementation. Due to the heavy use of preprocessor
10070: directives like <code class="literal">.if</code> and
10071: <code class="literal">.for</code>, the order in which the files are loaded
10072: matters.</p>
10073: <p>This section describes at which point the various files
10074: are loaded and gives reasons for that order.</p>
10075: <div class="sect2" lang="en">
10076: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10077: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code>
10078: </h3></div></div></div>
10079: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10080: is to define some essential variables like
10081: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10082: <code class="varname">MACHINE_ARCH</code>.</p>
10083: <p>Then, the user settings are loaded from the file specified
10084: in <code class="varname">MAKECONF</code>. If the bmake command from pkgsrc
10085: is used, <code class="varname">MAKECONF</code> defaults to
10086: <code class="filename"><em class="replaceable"><code>${prefix}</code></em>/etc/mk.conf</code>.
10087: 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
10088: <code class="filename">/etc/mk.conf</code>. After that, those variables
10089: that have not been overridden by the user are loaded from
10090: <code class="filename">mk/defaults/mk.conf</code>.</p>
10091: <p>After the user settings, the system settings and platform
10092: settings are loaded, which may override the user
10093: settings.</p>
10094: <p>Then, the tool definitions are loaded. The tool wrappers
10095: are not yet in effect. This only happens when building a
10096: package, so the proper variables must be used instead of the
10097: direct tool names.</p>
10098: <p>As the last steps, some essential variables from the
10099: wrapper and the package system flavor are loaded, as well as the
10100: variables that have been cached in earlier phases of a package
10101: build.</p>
10102: </div>
10103: <div class="sect2" lang="en">
10104: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10105: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code>
10106: </h3></div></div></div>
1.81 rillig 10107: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10108: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10109: loaded, which fill default values for those variables that have
1.93 rillig 10110: not been defined by the package. These variables may later
1.81 rillig 10111: be used even in unrelated files.</p>
10112: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10113: provides the target <code class="literal">error-check</code> that is added
10114: as a special dependency to all other targets that use
10115: <code class="varname">DELAYED_ERROR_MSG</code> or
10116: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10117: <p>Then, the package-specific hacks from
10118: <code class="filename">hacks.mk</code> are included.</p>
10119: <p>Then, various other files follow. Most of them don't have
10120: any dependencies on what they need to have included before or
10121: after them, though some do.</p>
10122: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10123: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10124: restricts the use of these variables to all the files that have
10125: been included before. Appearances in later files will be
10126: silently ignored.</p>
10127: <p>Then, the files for the main targets are included, in the
10128: order of later execution, though the actual order should not
10129: matter.</p>
10130: <p>At last, some more files are included that don't set any
10131: interesting variables but rather just define make targets to be
10132: executed.</p>
10133: </div>
10134: </div>
1.75 rillig 10135: </div>
10136: <div class="chapter" lang="en">
10137: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10138: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75 rillig 10139: <div class="toc">
10140: <p><b>Table of Contents</b></p>
10141: <dl>
1.90 rillig 10142: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10143: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10144: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10145: <dd><dl>
1.90 rillig 10146: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10147: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10148: </dl></dd>
10149: </dl>
10150: </div>
10151: <p>The pkgsrc infrastructure consists of a large codebase,
10152: and there are many corners where every little bit of a file is
10153: well thought out, making pkgsrc likely to fail as soon as
10154: anything is changed near those parts. To prevent most changes
10155: from breaking anything, a suite of regression tests should go
10156: along with every important part of the pkgsrc infrastructure.
10157: This chapter describes how regression tests work in pkgsrc and
10158: how you can add new tests.</p>
10159: <div class="sect1" lang="en">
10160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10161: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10162: <p></p>
10163: </div>
10164: <div class="sect1" lang="en">
10165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10166: <a name="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10167: <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 10168: provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
10169: can simply run that command, which will run all tests in the
1.76 rillig 10170: <code class="filename">regress</code> category.</p>
1.75 rillig 10171: </div>
10172: <div class="sect1" lang="en">
10173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10174: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10175: <p>Every directory in the <code class="filename">regress</code>
10176: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10177: is considered a regression test. This file is a shell program
10178: that is included by the <span><strong class="command">pkg_regress</strong></span> command.
10179: The following functions can be overridden to suit your
10180: needs.</p>
10181: <div class="sect2" lang="en">
10182: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10183: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10184: <p>These functions do not take any parameters. They are all
10185: called in “<span class="quote">set -e</span>” mode, so you should be careful
10186: to check the exitcodes of any commands you run in the
10187: test.</p>
10188: <div class="variablelist"><dl>
10189: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10190: <dd><p>This function prepares the environment for the
10191: test. By default it does nothing.</p></dd>
10192: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10193: <dd><p>This function runs the actual test. By default,
10194: it calls <code class="varname">TEST_MAKE</code> with the arguments
10195: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10196: error messages into the file
10197: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10198: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10199: <dd><p>This function is run after the test and is
10200: typically used to compare the actual output from the one that is
10201: expected. It can make use of the various helper functions from
10202: the next section.</p></dd>
10203: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10204: <dd><p>This function cleans everything up after the
10205: test has been run. By default it does nothing.</p></dd>
10206: </dl></div>
10207: </div>
10208: <div class="sect2" lang="en">
10209: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10210: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10211: <div class="variablelist"><dl>
10212: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10213: <dd><p>This function compares the exitcode of the
10214: <span><strong class="command">do_test()</strong></span> function with its first parameter.
10215: If they differ, the test will fail.</p></dd>
10216: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10217: <dd><p>This function checks for each of its parameters
10218: if the output from <span><strong class="command">do_test()</strong></span> matches the
10219: extended regular expression. If it does not, the test will
10220: fail.</p></dd>
10221: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10222: <dd><p>This function checks for each of its parameters
10223: if the output from <span><strong class="command">do_test()</strong></span> does
10224: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10225: If any of the regular expressions matches, the test will
10226: fail.</p></dd>
10227: </dl></div>
10228: </div>
10229: </div>
10230: </div>
10231: <div class="chapter" lang="en">
10232: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10233: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10234: <div class="toc">
10235: <p><b>Table of Contents</b></p>
10236: <dl>
1.90 rillig 10237: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10238: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10239: </dl>
10240: </div>
10241: <p>The pkgsrc system has already been ported to many
10242: operating systems, hardware architectures and compilers. This
10243: chapter explains the necessary steps to make pkgsrc even more
10244: portable.</p>
10245: <div class="sect1" lang="en">
10246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10247: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10248: <p>To port pkgsrc to a new operating system (called
10249: <code class="literal">MyOS</code> in this example), you need to touch the
10250: following files:</p>
10251: <div class="variablelist"><dl>
1.93 rillig 10252: <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 10253: <dd><p>This file contains some basic definitions, for
10254: example the name of the C
10255: compiler.</p></dd>
1.76 rillig 10256: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10257: <dd><p>Insert code that defines the variables
10258: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10259: <code class="varname">LOWER_OS_VERSION</code>,
10260: <code class="varname">LOWER_VENDOR</code>,
10261: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10262: <code class="varname">APPEND_ELF</code>, and the other variables that
10263: appear in this file.</p></dd>
1.93 rillig 10264: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10265: <dd><p>This file contains the platform-specific
10266: definitions that are used by pkgsrc. Start by copying one of the
10267: other files and edit it to your
10268: needs.</p></dd>
1.93 rillig 10269: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10270: <dd><p>This file contains a list of directories,
10271: together with their permission bits and ownership. These
10272: directories will be created automatically with every package
10273: that does not explicitly set <code class="varname">NO_MTREE</code>. There
10274: have been some discussions about whether this file is needed at
10275: all, but with no result.</p></dd>
1.93 rillig 10276: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10277: <dd><p>Just copy one of the pre-existing x11.dist files
10278: to your
1.76 rillig 10279: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10280: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10281: <dd><p>On some operating systems, the tools that are
10282: provided with the base system are not good enough for pkgsrc.
10283: 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
10284: narrow limit on the line length they can process. Therefore
10285: pkgsrc brings its own tools, which can be enabled
10286: here.</p></dd>
1.93 rillig 10287: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10288: <dd><p>This file defines the paths to all the tools
10289: that are needed by one or the other package in pkgsrc, as well
10290: as by pkgsrc itself. Find out where these tools are on your
10291: platform and add them.</p></dd>
10292: </dl></div>
10293: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10294: <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 10295: </div>
10296: <div class="sect1" lang="en">
10297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10298: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10299: <p>TODO</p>
10300: </div>
10301: </div>
10302: </div>
10303: <div class="appendix" lang="en">
10304: <div class="titlepage"><div><div><h2 class="title">
10305: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10306: <div class="toc">
10307: <p><b>Table of Contents</b></p>
10308: <dl>
10309: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10310: <dd><dl>
10311: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10312: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10313: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10314: <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>
10315: </dl></dd>
10316: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10317: </dl>
10318: </div>
10319: <p>We checked to find a piece of software that wasn't in the packages
10320: collection, and picked GNU bison. Quite why someone would want to have
10321: <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
10322: present in the tree is beyond us, but it's useful for the purposes of
10323: this exercise.</p>
10324: <div class="sect1" lang="en">
10325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10326: <a name="example-files"></a>A.1. files</h2></div></div></div>
10327: <div class="sect2" lang="en">
10328: <div class="titlepage"><div><div><h3 class="title">
10329: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10330: <pre class="programlisting">
1.51 rillig 10331: # $NetBSD$
10332: #
1.1 grant 10333:
1.51 rillig 10334: DISTNAME= bison-1.25
10335: CATEGORIES= devel
10336: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10337:
1.51 rillig 10338: MAINTAINER= thorpej@NetBSD.org
10339: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10340: COMMENT= GNU yacc clone
1.1 grant 10341:
1.51 rillig 10342: GNU_CONFIGURE= yes
10343: INFO_FILES= bison.info
1.1 grant 10344:
1.51 rillig 10345: .include "../../mk/bsd.pkg.mk"
1.1 grant 10346: </pre>
1.75 rillig 10347: </div>
10348: <div class="sect2" lang="en">
10349: <div class="titlepage"><div><div><h3 class="title">
10350: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10351: <pre class="programlisting">
1.51 rillig 10352: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.75 rillig 10353: 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
1.51 rillig 10354: of the NetBSD source tree is beyond me.
1.1 grant 10355: </pre>
1.75 rillig 10356: </div>
10357: <div class="sect2" lang="en">
10358: <div class="titlepage"><div><div><h3 class="title">
10359: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10360: <pre class="programlisting">
1.51 rillig 10361: @comment $NetBSD$
10362: bin/bison
10363: man/man1/bison.1.gz
10364: share/bison.simple
10365: share/bison.hairy
1.1 grant 10366: </pre>
1.75 rillig 10367: </div>
10368: <div class="sect2" lang="en">
10369: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10370: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
10371: </h3></div></div></div>
1.75 rillig 10372: <p>The NetBSD package system comes with
1.91 rillig 10373: <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 10374: which helps to check the contents of these
10375: files. After installation it is quite easy to use, just change to the
10376: directory of the package you wish to examine and execute
10377: <span><strong class="command">pkglint</strong></span>:</p>
10378: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10379: looks fine.</pre>
10380: <p>Depending on the supplied command line arguments (see pkglint(1)),
10381: more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
10382: -Wall</strong></span> for a very thorough check.</p>
10383: </div>
10384: </div>
10385: <div class="sect1" lang="en">
10386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10387: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10388: <p>Create the directory where the package lives,
10389: plus any auxiliary directories:</p>
10390: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10391: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10392: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10393: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10394: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90 rillig 10395: <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 10396: then continue with fetching the distfile:</p>
10397: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10398: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10399: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10400: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10401: ftp: Error retrieving file: 500 Internal error
10402:
10403: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10404: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10405: ftp: Error retrieving file: 500 Internal error
10406:
10407: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10408: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10409: Successfully retrieved file.</pre>
10410: <p>Generate the checksum of the distfile into
1.76 rillig 10411: <code class="filename">distinfo</code>:</p>
1.88 wiz 10412: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10413: <p>Now compile:</p>
10414: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10415: >> Checksum OK for bison-1.25.tar.gz.
10416: ===> Extracting for bison-1.25
10417: ===> Patching for bison-1.25
10418: ===> Ignoring empty patch directory
10419: ===> Configuring for bison-1.25
10420: creating cache ./config.cache
10421: checking for gcc... cc
10422: checking whether we are using GNU C... yes
10423: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10424: checking how to run the C preprocessor... cc -E
10425: checking for minix/config.h... no
10426: checking for POSIXized ISC... no
10427: checking whether cross-compiling... no
10428: checking for ANSI C header files... yes
10429: checking for string.h... yes
10430: checking for stdlib.h... yes
10431: checking for memory.h... yes
10432: checking for working const... yes
10433: checking for working alloca.h... no
10434: checking for alloca... yes
10435: checking for strerror... yes
10436: updating cache ./config.cache
10437: creating ./config.status
10438: creating Makefile
10439: ===> Building for bison-1.25
10440: 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
10441: 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
10442: 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
10443: 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
10444: 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 10445: 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 10446: 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
10447: 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
10448: 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
10449: 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
10450: 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
10451: 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
10452: 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
10453: 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
10454: 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
10455: 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
10456: 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
10457: 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
10458: 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
10459: 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
10460: 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
10461: 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
10462: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10463: rm -f bison.s1
1.75 rillig 10464: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10465: <p>Everything seems OK, so install the files:</p>
10466: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10467: >> Checksum OK for bison-1.25.tar.gz.
10468: ===> Installing for bison-1.25
10469: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10470: rm -f /usr/pkg/bin/bison
10471: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10472: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10473: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10474: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10475: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10476: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10477: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10478: ===> Registering installation for bison-1.25</pre>
10479: <p>You can now use bison, and also - if you decide so - remove it with
10480: <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
10481: binary package, do this now:</p>
10482: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10483: >> Checksum OK for bison-1.25.tar.gz.
10484: ===> Building package for bison-1.25
10485: Creating package bison-1.25.tgz
10486: Registering depends:.
1.75 rillig 10487: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10488: <p>Now that you don't need the source and object files
10489: any more, clean up:</p>
10490: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10491: ===> Cleaning for bison-1.25</pre>
10492: </div>
10493: </div>
10494: <div class="appendix" lang="en">
10495: <div class="titlepage"><div><div><h2 class="title">
10496: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10497: <div class="toc">
10498: <p><b>Table of Contents</b></p>
10499: <dl>
10500: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10501: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10502: </dl>
10503: </div>
10504: <div class="sect1" lang="en">
10505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10506: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10507: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10508: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10509: => figlet221.tar.gz doesn't seem to exist on this system.
10510: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10511: => [172219 bytes]
10512: Connected to ftp.plig.net.
10513: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10514: 331 Guest login ok, send your complete e-mail address as password.
10515: 230-You are user #5 of 500 simultaneous users allowed.
10516: 230-
1.68 rillig 10517: 230- ___ _ _ _
10518: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10519: 230- | _| _| . |_| . | | | . |_| . | _| . |
10520: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10521: 230- |_| |_| |___| |___|
10522: 230-
10523: 230-** Welcome to ftp.plig.org **
10524: 230-
10525: 230-Please note that all transfers from this FTP site are logged. If you
10526: 230-do not like this, please disconnect now.
10527: 230-
10528: 230-This arhive is available via
10529: 230-
10530: 230-HTTP: http://ftp.plig.org/
10531: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10532: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10533: 230-
10534: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10535: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10536: 230-
10537: 230-
10538: 230 Logged in anonymously.
10539: Remote system type is UNIX.
10540: Using binary mode to transfer files.
10541: 200 Type okay.
10542: 250 "/pub" is new cwd.
10543: 250-"/pub/figlet" is new cwd.
10544: 250-
10545: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10546: 250-
1.75 rillig 10547: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10548: 250-
10549: 250-The official FIGlet web page is:
1.75 rillig 10550: 250- http://www.figlet.org/
1.1 grant 10551: 250-
10552: 250-If you have questions, please mailto:info@figlet.org. If you want to
10553: 250-contribute a font or something else, you can email us.
1.68 rillig 10554: 250
1.1 grant 10555: 250 "/pub/figlet/program" is new cwd.
10556: 250 "/pub/figlet/program/unix" is new cwd.
10557: local: figlet221.tar.gz remote: figlet221.tar.gz
10558: 502 Unimplemented command.
10559: 227 Entering Passive Mode (195,40,6,41,246,104)
10560: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10561: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10562: 226 Transfer completed.
10563: 172219 bytes received in 00:02 (75.99 KB/s)
10564: 221 Goodbye.
10565: => Checksum OK for figlet221.tar.gz.
10566: ===> Extracting for figlet-2.2.1nb2
10567: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10568: ===> Patching for figlet-2.2.1nb2
10569: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10570: ===> Overriding tools for figlet-2.2.1nb2
10571: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10572: ===> Configuring for figlet-2.2.1nb2
10573: ===> Building for figlet-2.2.1nb2
10574: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10575: chmod a+x figlet
10576: gcc -O2 -o chkfont chkfont.c
10577: => Unwrapping files-to-be-installed.
1.14 xtraeme 10578: <code class="prompt">#</code>
1.75 rillig 10579: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10580: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10581: ===> Installing for figlet-2.2.1nb2
10582: install -d -o root -g wheel -m 755 /usr/pkg/bin
10583: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10584: mkdir -p /usr/pkg/share/figlet
10585: cp figlet /usr/pkg/bin
10586: cp chkfont /usr/pkg/bin
10587: chmod 555 figlist showfigfonts
10588: cp figlist /usr/pkg/bin
10589: cp showfigfonts /usr/pkg/bin
10590: cp fonts/*.flf /usr/pkg/share/figlet
10591: cp fonts/*.flc /usr/pkg/share/figlet
10592: cp figlet.6 /usr/pkg/man/man6
10593: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10594: <code class="prompt">#</code></pre>
10595: </div>
10596: <div class="sect1" lang="en">
10597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10598: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10599: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10600: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10601: ===> Packaging figlet-2.2.1nb2
10602: ===> Building binary package for figlet-2.2.1nb2
10603: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10604: Using SrcDir value of /usr/pkg
1.68 rillig 10605: Registering depends:.
1.75 rillig 10606: <code class="prompt">#</code></pre>
10607: </div>
10608: </div>
10609: <div class="appendix" lang="en">
10610: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10611: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10612: <div class="toc">
10613: <p><b>Table of Contents</b></p>
10614: <dl>
10615: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10616: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10617: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10618: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10619: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
10620: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 rillig 10621: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10622: source packages</a></span></dt>
10623: </dl>
10624: </div>
10625: <p>As in other big projects, the directory layout of pkgsrc
10626: is quite complex for newbies. This chapter explains where you
10627: find things on the FTP server. The base directory on
1.89 rillig 10628: <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>.
10629: On other servers it may be different, but inside this directory,
10630: everything should look the same, no matter on which server you
10631: are. This directory contains some subdirectories, which are
10632: explained below.</p>
1.76 rillig 10633: <div class="sect1" lang="en">
10634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10635: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
10636: <p>For those who only want to manage binary packages on
10637: systems other than NetBSD, we provide the package management
10638: tools in a separate, small tar file.</p>
10639: </div>
10640: <div class="sect1" lang="en">
10641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10642: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10643: <p>The directory <code class="filename">distfiles</code> contains lots
10644: of archive files from all pkgsrc packages, which are mirrored
10645: here. The subdirectories are called after their package names
10646: and are used when the distributed files have names that don't
10647: explicitly contain a version number or are otherwise too generic
10648: (for example <code class="filename">release.tar.gz</code>).</p>
10649: </div>
10650: <div class="sect1" lang="en">
10651: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10652: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10653: <p>This directory is currently not in use.</p>
10654: </div>
10655: <div class="sect1" lang="en">
10656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10657: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10658: <p>This directory contains things that individual pkgsrc
10659: developers find worth publishing.</p>
10660: </div>
10661: <div class="sect1" lang="en">
10662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10663: <a name="ftp-packages"></a>C.5. <code class="filename">packages*</code>: Binary packages</h2></div></div></div>
10664: <p>These directories contain binary packages. Those
10665: directories that have a branch name
10666: (200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>)
10667: contain packages from that particular branch. The directory
10668: <code class="filename">packages</code> contains binary packages from
10669: pkgsrc-current. (However, this does not necessarily mean that
10670: the packages are still current anymore.)</p>
10671: <p>Below the <code class="filename">packages*</code> directories are
10672: directories that distinguish the packages by operating system
10673: and version, the next directory level specifies the hardware
10674: architecture.</p>
10675: <p>In each of the platform-specific directories, there is a
10676: whole binary packages collection. It has a directory called
10677: <code class="filename">All</code> which contains all binary packages.
10678: Besides that, there are various category directories that
10679: contain symbolic links to the real binary packages.</p>
10680: </div>
10681: <div class="sect1" lang="en">
10682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10683: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
1.93 rillig 10684: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10685: source packages</h2></div></div></div>
10686: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
10687: that is the files that define how to create binary packages from
10688: source archives.</p>
10689: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10690: snapshot of the CVS repository, which is updated regularly. The
10691: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10692: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10693: <p>In the directories for the quarterly branches, there is an
10694: additional file called
10695: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10696: which contains the state of pkgsrc when it was branched.</p>
10697: </div>
1.75 rillig 10698: </div>
10699: <div class="appendix" lang="en">
10700: <div class="titlepage"><div><div><h2 class="title">
10701: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
10702: <div class="toc">
10703: <p><b>Table of Contents</b></p>
10704: <dl>
1.79 rillig 10705: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10706: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10707: </dl>
10708: </div>
1.79 rillig 10709: <p>This section contains information on editing the pkgsrc
10710: guide itself.</p>
1.75 rillig 10711: <div class="sect1" lang="en">
10712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10713: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10714: <p>The pkgsrc guide's source code is stored in
10715: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10716: are created from it:</p>
10717: <div class="itemizedlist"><ul type="disc">
10718: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10719: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10720: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/</a></p></li>
10721: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</a>:
10722: The PDF version of the pkgsrc guide.</p></li>
10723: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</a>:
10724: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10725: </ul></div>
10726: </div>
10727: <div class="sect1" lang="en">
10728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10729: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10730: <p>The procedure to edit the pkgsrc guide is:</p>
10731: <div class="procedure"><ol type="1">
10732: <li><p>Make sure you have the packages needed to
1.83 wiz 10733: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 10734: 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
10735: 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 10736: PostScript and PDF versions. You will need both packages
10737: installed, to make sure documentation is consistent across all
10738: formats.</p></li>
10739: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
10740: right directory. All further steps will take place
10741: here.</p></li>
10742: <li><p>Edit the XML file(s) in
10743: <code class="filename">files/</code>.</p></li>
10744: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
10745: guide for valid XML and to build the final output files. If you
10746: get any errors at this stage, you can just edit the files, as
10747: there are only symbolic links in the working directory, pointing
10748: to the files in <code class="filename">files/</code>.</p></li>
10749: <li><p><span><strong class="command">(cd files && cvs
10750: commit)</strong></span></p></li>
10751: <li><p>Run <span><strong class="command">bmake clean && bmake</strong></span> to
10752: regenerate the output files with the proper RCS
10753: Ids.</p></li>
1.91 rillig 10754: <li>
10755: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
10756: commit the files in both <code class="filename">pkgsrc/doc</code> and
10757: <code class="filename">htdocs</code>.</p>
10758: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10759: <h3 class="title">Note</h3>
10760: <p>If you have added, removed or renamed some chapters,
1.83 wiz 10761: you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
10762: <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91 rillig 10763: directory.</p>
10764: </div>
10765: </li>
1.79 rillig 10766: </ol></div>
1.75 rillig 10767: </div>
10768: </div>
10769: </div></body>
1.1 grant 10770: </html>
CVSweb <webmaster@jp.NetBSD.org>