Annotation of pkgsrc/doc/pkgsrc.html, revision 1.98
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>
1.97 rillig 69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 70: </dl></dd>
71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
72: <dd><dl>
73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
75: </dl></dd>
76: </dl></dd>
77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
78: <dd><dl>
1.82 rillig 79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
82: <dd><dl>
83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 90: </dl></dd>
91: </dl></dd>
92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
93: <dd><dl>
94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 104: </dl></dd>
105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
106: <dd><dl>
107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
110: </dl></dd>
111: </dl></dd>
112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
113: <dd><dl>
114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 116: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 117: <dd><dl>
1.89 rillig 118: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
119: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
120: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 121: </dl></dd>
1.78 rillig 122: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
123: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 124: </dl></dd>
125: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
126: <dd><dl>
127: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
128: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
129: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
130: <dd><dl>
131: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
132: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
133: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
134: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
135: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
136: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
137: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
138: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
139: </dl></dd>
140: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
142: </dl></dd>
1.90 rillig 143: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
1.75 rillig 144: <dd><dl>
1.91 rillig 145: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90 rillig 146: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
147: </dl></dd>
148: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
149: <dd><dl>
150: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
151: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
152: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
153: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
154: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
155: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
156: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
157: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
158: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
159: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
160: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 161: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
164: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
165: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
166: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
167: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 169: </dl></dd>
170: </dl></dd>
171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
172: <dd><dl>
1.90 rillig 173: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 174: <dd><dl>
175: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
176: <dd><dl>
177: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
178: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
179: </dl></dd>
180: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
181: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
182: </dl></dd>
1.90 rillig 183: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 184: <dd><dl>
1.90 rillig 185: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
186: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
187: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
188: <dd><dl>
1.93 rillig 189: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
190: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
191: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
192: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
193: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 194: </dl></dd>
195: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
196: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
197: <dd><dl>
198: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
199: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
200: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
201: </dl></dd>
202: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
203: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
204: </dl></dd>
205: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
206: <dd><dl>
1.97 rillig 207: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
208: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
209: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
210: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
211: <dd><dl>
212: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
213: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
214: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
215: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
216: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90 rillig 217: </dl></dd>
218: </dl></dd>
219: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
220: <dd><dl>
221: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
222: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
223: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
224: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
225: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
226: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
227: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
228: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
229: </dl></dd>
230: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
231: <dd><dl>
232: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
233: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
234: <dd><dl>
235: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
236: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
237: </dl></dd>
238: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
239: <dd><dl>
240: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
241: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
242: </dl></dd>
243: </dl></dd>
244: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
245: <dd><dl>
246: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
247: <dd><dl>
248: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
249: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
250: </dl></dd>
251: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
252: <dd><dl>
253: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
254: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
255: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
256: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
257: </dl></dd>
258: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
259: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
260: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
261: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
262: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
263: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
264: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
265: </dl></dd>
266: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
267: <dd><dl>
268: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
269: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
270: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
271: </dl></dd>
272: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
273: <dd><dl>
274: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
275: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
276: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
277: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
278: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
279: <dd><dl>
280: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
281: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
282: </dl></dd>
283: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
284: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
285: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
286: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
287: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
288: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
289: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
294: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
295: </dl></dd>
296: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
297: <dd><dl>
298: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
299: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
300: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 301: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90 rillig 302: </dl></dd>
303: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
304: <dd><dl>
305: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
306: <dd><dl>
307: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
308: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
309: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
310: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
311: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
312: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
313: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
314: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
315: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
316: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
317: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
318: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
319: </dl></dd>
320: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
321: <dd><dl>
322: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
323: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
324: </dl></dd>
325: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
326: <dd><dl>
327: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
328: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
329: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
330: </dl></dd>
331: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
332: <dd><dl>
333: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
334: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
335: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
336: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
337: </dl></dd>
338: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
339: <dd><dl>
340: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
341: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
342: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
343: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
344: </dl></dd>
345: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
346: <dd><dl>
347: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
348: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
349: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
350: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
351: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
352: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
353: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
354: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
355: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
356: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
357: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
358: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
359: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
360: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
361: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
362: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
363: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 364: emulation</a></span></dt>
1.90 rillig 365: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
366: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77 rillig 367: </dl></dd>
1.90 rillig 368: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 369: </dl></dd>
1.90 rillig 370: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
371: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 372: <dd><dl>
1.90 rillig 373: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
374: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
375: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
376: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
377: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
378: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
379: </dl></dd>
380: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
381: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
382: <dd><dl>
383: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
384: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
385: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
386: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 387: </dl></dd>
1.75 rillig 388: </dl></dd>
389: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
390: <dd><dl>
1.90 rillig 391: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 392: <dd><dl>
1.90 rillig 393: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
394: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
395: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 396: <dd><dl>
1.90 rillig 397: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
398: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 399: </dl></dd>
1.90 rillig 400: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
401: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 402: <dd><dl>
1.90 rillig 403: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
404: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 405: </dl></dd>
1.90 rillig 406: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 407: <dd><dl>
1.90 rillig 408: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
409: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 410: </dl></dd>
411: </dl></dd>
1.90 rillig 412: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 413: <dd><dl>
1.90 rillig 414: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
415: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
416: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 417: <dd><dl>
1.90 rillig 418: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
419: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 420: </dl></dd>
421: </dl></dd>
1.90 rillig 422: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 423: <dd><dl>
1.90 rillig 424: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
425: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 426: </dl></dd>
427: </dl></dd>
428: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
429: <dd><dl>
430: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
431: <dd><dl>
432: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
433: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
434: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
435: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
436: </dl></dd>
437: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
438: </dl></dd>
439: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
440: <dd><dl>
441: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
442: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
443: </dl></dd>
1.76 rillig 444: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
445: <dd><dl>
446: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
447: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
448: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
449: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
450: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
451: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 rillig 452: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 453: source packages</a></span></dt>
454: </dl></dd>
1.75 rillig 455: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
456: <dd><dl>
1.79 rillig 457: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 458: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
459: </dl></dd>
460: </dl>
461: </div>
1.82 rillig 462: <div class="list-of-tables">
463: <p><b>List of Tables</b></p>
464: <dl>
465: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
466: </dt>
467: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
468: </dt>
1.90 rillig 469: <dt>10.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 470: </dt>
1.90 rillig 471: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 472: </dt>
1.82 rillig 473: </dl>
474: </div>
1.75 rillig 475: <div class="chapter" lang="en">
476: <div class="titlepage"><div><div><h2 class="title">
477: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
478: <div class="toc">
479: <p><b>Table of Contents</b></p>
480: <dl>
481: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 482: <dd><dl>
483: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
484: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
485: </dl></dd>
1.75 rillig 486: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
487: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 488: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 489: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
490: </dl>
491: </div>
492: <div class="sect1" lang="en">
493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
494: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 495: <p>There is a lot of software freely available for Unix-based
496: systems, which is usually available in form of the source code. Before
497: such software can be used, it needs to be configured to the local
498: system, compiled and installed, and this is exactly what The NetBSD
499: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
500: to handle binary packages, so that not every user has to build the
501: packages for himself, which is a time-costly task.</p>
1.75 rillig 502: <p>pkgsrc currently contains several thousand packages,
503: including:</p>
504: <div class="itemizedlist"><ul type="disc">
1.91 rillig 505: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.75 rillig 506: web server</p></li>
1.91 rillig 507: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75 rillig 508: web browser</p></li>
1.91 rillig 509: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75 rillig 510: Desktop Environment</p></li>
1.91 rillig 511: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.75 rillig 512: Desktop Environment</p></li>
513: </ul></div>
514: <p>...just to name a few.</p>
515: <p>pkgsrc has built-in support for handling varying dependencies,
516: such as pthreads and X11, and extended features such as IPv6 support on
517: a range of platforms.</p>
1.82 rillig 518: <div class="sect2" lang="en">
519: <div class="titlepage"><div><div><h3 class="title">
520: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
521: <p>
522: pkgsrc provides the following key features:
523: </p>
524: <div class="itemizedlist"><ul type="disc">
525: <li><p>Easy building of software from source as well as the creation
526: and installation of binary packages. The source and latest
527: patches are retrieved from a master or mirror download site, checksum
528: verified, then built on your system. Support for binary-only
529: distributions is available for both native platforms and NetBSD
530: emulated platforms.</p></li>
531: <li><p>All packages are installed in a consistent directory tree,
532: including binaries, libraries, man pages and other
533: documentation.</p></li>
534: <li><p>Package dependencies, including when performing package updates,
535: are handled automatically. The configuration files of various
536: packages are handled automatically during updates, so local changes
537: are preserved.</p></li>
538: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
539: consists of highly portable code. This allows the greatest speed of
540: development when porting to new a platform. This portability also
541: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
542: platforms</em></span>.</p></li>
543: <li><p>The installation prefix, acceptable software licenses,
544: international encryption requirements and build-time options for a
545: large number of packages are all set in a simple, central
546: configuration file.</p></li>
547: <li><p>The entire source (not including the distribution files) is
548: freely available under a BSD license, so you may extend and adapt
549: pkgsrc to your needs. Support for local packages and patches is
550: available right out of the box, so you can configure it specifically
551: for your environment.</p></li>
552: </ul></div>
1.91 rillig 553: <p>The following principles are basic to pkgsrc:</p>
554: <div class="itemizedlist"><ul type="disc">
555: <li><p>“<span class="quote">It should only work if it's right.</span>”
556: — That means, if a package contains bugs, it's better to find
557: them and to complain about them rather than to just install the package
558: and hope that it works. There are numerous checks in pkgsrc that try to
559: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
560: of shell scripts), and post-installation checks (installed files,
561: references to shared libraries, script interpreters).</p></li>
562: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
563: — Like NetBSD has been ported to many hardware architectures,
564: pkgsrc has been ported to many operating systems. Care is taken that
565: packages behave the same on all platforms.</p></li>
566: </ul></div>
1.82 rillig 567: </div>
568: <div class="sect2" lang="en">
569: <div class="titlepage"><div><div><h3 class="title">
570: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
571: <p>pkgsrc consists of both a source distribution and a binary
572: distribution for these operating systems. After retrieving the required
573: source or binaries, you can be up and running with pkgsrc in just
574: minutes!</p>
1.75 rillig 575: <p>pkgsrc was derived from FreeBSD's ports system, and
576: initially developed for NetBSD only. Since then, pkgsrc has
577: grown a lot, and now supports the following platforms:</p>
1.82 rillig 578: <div class="table">
579: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 580: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 581: <colgroup>
582: <col>
583: <col>
584: </colgroup>
585: <thead><tr>
586: <th>Platform</th>
587: <th>Date Support Added</th>
588: </tr></thead>
589: <tbody>
590: <tr>
591: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
592: <td align="center">Aug 1997</td>
593: </tr>
594: <tr>
595: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
596: <td align="center">Mar 1999</td>
597: </tr>
598: <tr>
599: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
600: <td align="center">Jun 1999</td>
601: </tr>
602: <tr>
603: <td>
604: <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
605: (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
606: </td>
607: <td align="center">Oct 2001</td>
608: </tr>
609: <tr>
610: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
611: <td align="center">Nov 2002</td>
612: </tr>
613: <tr>
614: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
615: <td align="center">Nov 2002</td>
616: </tr>
617: <tr>
618: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
619: <td align="center">Dec 2002</td>
620: </tr>
621: <tr>
622: <td>BSD/OS</td>
623: <td align="center">Dec 2003</td>
624: </tr>
625: <tr>
626: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
627: <td align="center">Dec 2003</td>
628: </tr>
629: <tr>
630: <td>
631: <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
632: (Microsoft Windows Services for Unix)
633: </td>
634: <td align="center">Mar 2004</td>
635: </tr>
636: <tr>
637: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
638: <td align="center">Oct 2004</td>
639: </tr>
640: <tr>
641: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
642: <td align="center">Nov 2004</td>
643: </tr>
1.98 ! wiz 644: <tr>
! 645: <td><a href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
! 646: <td align="center">Apr 2007</td>
! 647: </tr>
1.82 rillig 648: </tbody>
1.91 rillig 649: </table></div>
1.82 rillig 650: </div>
1.91 rillig 651: <br class="table-break">
1.82 rillig 652: </div>
1.75 rillig 653: </div>
654: <div class="sect1" lang="en">
655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
656: <a name="overview"></a>1.2. Overview</h2></div></div></div>
657: <p>This document is divided into three parts. The first,
658: <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
659: describes how one can use one of the packages in the Package
660: Collection, either by installing a precompiled binary package,
1.93 rillig 661: or by building one's own copy using the NetBSD package system.
1.75 rillig 662: The second part, <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
663: package so it can be easily built by other NetBSD users without
664: knowing about the package's building details. The third part,
665: <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
666: is intended for those who want to understand how pkgsrc is
667: implemented.</p>
668: <p>This document is available in various formats:
669: <span class="simplelist"><a href="index.html" target="_top">HTML</a>, <a href="pkgsrc.pdf" target="_top">PDF</a>, <a href="pkgsrc.ps" target="_top">PS</a>, <a href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
670: </div>
671: <div class="sect1" lang="en">
672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
673: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
674: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
675: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
676: terminology used within this document.</p>
677: <div class="variablelist"><dl>
678: <dt><span class="term">Package</span></dt>
679: <dd><p>A set of files and building instructions
680: that describe what's necessary
681: to build a certain piece of software using
682: pkgsrc. Packages are traditionally stored under
1.76 rillig 683: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 684: <dt><span class="term">The NetBSD package system</span></dt>
1.87 wiz 685: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
686: is part of the NetBSD operating system and can be bootstrapped
687: to run on non-NetBSD operating systems as well. It handles
688: building (compiling), installing, and removing of
689: packages.</p></dd>
1.75 rillig 690: <dt><span class="term">Distfile</span></dt>
691: <dd><p>This term describes the file or files that are
692: provided by the author of the piece of software to
693: distribute his work. All the changes necessary to build on
694: NetBSD are reflected in the corresponding package. Usually
695: the distfile is in the form of a compressed tar-archive,
696: but other types are possible, too. Distfiles are usually
697: stored below
1.76 rillig 698: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 699: <dt><span class="term">Port</span></dt>
700: <dd><p>This is the term used by FreeBSD and OpenBSD people
701: for what we call a package.
702: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
703: architecture.</p></dd>
704: <dt><span class="term">Precompiled/binary package</span></dt>
705: <dd>
706: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 707: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 708: file so it can be installed on machines of the same
709: machine architecture without the need to
710: recompile. Packages are usually generated in
1.76 rillig 711: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.75 rillig 712: an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
713: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
714: especially in the context of precompiled packages.</p>
715: </dd>
716: <dt><span class="term">Program</span></dt>
1.88 wiz 717: <dd><p>The piece of software to be installed which will be
718: constructed from all the files in the distfile by the
719: actions defined in the corresponding package.</p></dd>
1.75 rillig 720: </dl></div>
721: <div class="sect2" lang="en">
722: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 723: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75 rillig 724: <div class="variablelist"><dl>
725: <dt><span class="term">pkgsrc users</span></dt>
726: <dd>
727: <p>The
728: pkgsrc users are people who use the packages provided by pkgsrc.
729: Typically they are system administrators. The people using the
730: software that is inside the packages (maybe called “<span class="quote">end
731: users</span>”) are not covered by the pkgsrc guide.</p>
732: <p>There are two kinds of pkgsrc users: Some only want to
733: install pre-built binary packages. Others build the pkgsrc
734: packages from source, either for installing them directly or for
735: building binary packages themselves. For pkgsrc users <a href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
736: documentation.</p>
737: </dd>
738: <dt><span class="term">package maintainers</span></dt>
739: <dd><p>A
740: package maintainer creates packages as described in <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
741: <dt><span class="term">infrastructure developers</span></dt>
742: <dd><p>These people are involved in all those files
1.76 rillig 743: that live in the <code class="filename">mk/</code> directory and below.
1.75 rillig 744: Only these people should need to read through <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
745: too.</p></dd>
746: </dl></div>
747: </div>
748: </div>
749: <div class="sect1" lang="en">
750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
751: <a name="typography"></a>1.4. Typography</h2></div></div></div>
752: <p>When giving examples for commands, shell prompts are used to
753: show if the command should/can be issued as root, or if
754: “<span class="quote">normal</span>” user privileges are sufficient. We use a
755: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
756: shell prompt, assuming they use the C-shell or tcsh.</p>
757: </div>
758: </div>
759: <div class="part" lang="en">
760: <div class="titlepage"><div><div><h1 class="title">
761: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
762: <div class="toc">
763: <p><b>Table of Contents</b></p>
764: <dl>
765: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
766: <dd><dl>
767: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
768: <dd><dl>
769: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
770: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 771: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 772: </dl></dd>
773: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
774: <dd><dl>
775: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
776: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
777: </dl></dd>
778: </dl></dd>
779: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
780: <dd><dl>
1.82 rillig 781: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
782: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
783: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
784: <dd><dl>
785: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
786: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
787: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
788: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
789: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
790: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
791: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 792: </dl></dd>
793: </dl></dd>
794: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
795: <dd><dl>
796: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
797: <dd><dl>
798: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
799: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 800: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
801: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
802: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
803: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
804: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
805: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 806: </dl></dd>
807: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
808: <dd><dl>
809: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
810: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
811: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
812: </dl></dd>
813: </dl></dd>
814: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
815: <dd><dl>
816: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
817: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 818: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 819: <dd><dl>
1.89 rillig 820: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
821: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
822: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 823: </dl></dd>
1.78 rillig 824: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
825: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 826: </dl></dd>
827: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
828: <dd><dl>
829: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
830: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
831: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
832: <dd><dl>
833: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
834: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
835: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
836: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
837: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
838: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
839: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
840: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
841: </dl></dd>
842: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
843: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
844: </dl></dd>
1.90 rillig 845: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
846: <dd><dl>
1.91 rillig 847: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90 rillig 848: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
849: </dl></dd>
850: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
1.75 rillig 851: <dd><dl>
1.90 rillig 852: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
853: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
854: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
855: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
856: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
857: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
858: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
859: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
860: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
861: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
862: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 863: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 864: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
865: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
866: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
867: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
868: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
869: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
870: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 871: </dl></dd>
872: </dl>
873: </div>
874: <div class="chapter" lang="en">
875: <div class="titlepage"><div><div><h2 class="title">
876: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
877: <div class="toc">
878: <p><b>Table of Contents</b></p>
879: <dl>
880: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
881: <dd><dl>
882: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
883: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 884: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 885: </dl></dd>
886: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
887: <dd><dl>
888: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
889: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
890: </dl></dd>
891: </dl>
892: </div>
1.91 rillig 893: <p>Before you download and extract the files, you need to decide
894: where you want to extract them. When using pkgsrc as root user, pkgsrc
895: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
896: free to install the sources and binary packages wherever you want in
897: your filesystem, provided that the pathname does not contain white-space
898: or other characters that are interpreted specially by the shell and some
899: other programs. A safe bet is to use only letters, digits, underscores
900: and dashes.</p>
1.75 rillig 901: <div class="sect1" lang="en">
902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
903: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
904: <p>Before you download any pkgsrc files, you should decide
905: whether you want the <span class="emphasis"><em>current</em></span> branch or the
906: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
907: quarterly basis from the current branch and only gets modified
908: for security updates. The names of the stable branches are built
909: from the year and the quarter, for example
1.98 ! wiz 910: <code class="literal">2007Q1</code>.</p>
1.75 rillig 911: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
912: want to download pkgsrc. You can get it as a tar file, via SUP,
913: or via CVS. All three ways are described here.</p>
914: <div class="sect2" lang="en">
915: <div class="titlepage"><div><div><h3 class="title">
916: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
917: <p>The primary download location for all pkgsrc files is
918: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
919: number of subdirectories for different purposes, which are
1.76 rillig 920: described in detail in <a href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.75 rillig 921: <p>The tar file for the current branch is in the directory
1.76 rillig 922: <code class="filename">current</code> and is called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75 rillig 923: It is autogenerated daily.</p>
1.98 ! wiz 924: <p>The tar file for the stable branch 2007Q1 is in the
! 925: directory <code class="filename">pkgsrc-2007Q1</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q1/pkgsrc-2007Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q1.tar.gz</code></a>.</p>
1.75 rillig 926: <p>After downloading the tar file, change to the directory
927: where you want to have pkgsrc. This is usually
1.91 rillig 928: <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
929: pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
1.75 rillig 930: </div>
931: <div class="sect2" lang="en">
932: <div class="titlepage"><div><div><h3 class="title">
933: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
934: <p>As an alternative to the tar file, you can get pkgsrc via
935: the Software Update Protocol, SUP. To do so, make sure your
936: supfile has a line
1.1 grant 937:
1.75 rillig 938: </p>
939: <pre class="programlisting">
1.51 rillig 940: release=pkgsrc
1.1 grant 941: </pre>
1.75 rillig 942: <p>
1.1 grant 943:
1.75 rillig 944: in it, see the examples in
1.76 rillig 945: <code class="filename">/usr/share/examples/supfiles</code>, and that the
946: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.75 rillig 947: run <span><strong class="command">sup -v
948: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
949: </div>
950: <div class="sect2" lang="en">
951: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 952: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.75 rillig 953: <p>To get pkgsrc via CVS, make sure you have <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cvs</span>(1)</span></a>
954: installed. To do an initial (full) checkout of pkgsrc, you first
955: have to set some environment variables. For the C-Shell,
956: type:</p>
957: <pre class="screen">
958: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
959: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
960: </pre>
961: <p>Or, the same for the bourne shell:</p>
962: <pre class="screen">
963: <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
964: <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
965: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
966: </pre>
967: <p>Then, you change to the directory where you want to have
968: your copy of pkgsrc. In most cases this is
1.76 rillig 969: <code class="filename">/usr</code>. In that directory you run the
1.75 rillig 970: checkout command, which is <span><strong class="command">cvs -q checkout -P
971: pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1.98 ! wiz 972: checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
1.75 rillig 973: branch. This command will create a directory called
1.76 rillig 974: <code class="filename">pkgsrc</code> with all the pkgsrc files in
1.75 rillig 975: it.</p>
976: </div>
977: </div>
978: <div class="sect1" lang="en">
979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
980: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
981: <p>The preferred way to keep pkgsrc up-to-date is via CVS
982: (which also works if you have first installed it via a tar
983: file). It saves bandwidth and hard disk activity, compared to
984: downloading the tar file again.</p>
985: <div class="sect2" lang="en">
986: <div class="titlepage"><div><div><h3 class="title">
987: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
988: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
989: <h3 class="title">Warning</h3>
1.77 rillig 990: <p>When updating from a tar file, you first need to
991: completely remove the old pkgsrc directory. Otherwise those
992: files that have been removed from pkgsrc in the mean time will
993: not be removed on your local disk, resulting in inconsistencies.
994: When removing the old files, any changes that you have done to
995: the pkgsrc files will be lost after updating. Therefore updating
996: via CVS is strongly recommended.</p>
1.75 rillig 997: </div>
1.82 rillig 998: <p>Note that by default the distfiles and the binary packages
999: are saved in the pkgsrc tree, so don't forget to rescue them
1000: before updating. You can also configure pkgsrc to use other than
1001: the default directories by setting the
1002: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1003: variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1004: <p>To update pkgsrc from a tar file, download the tar file as
1005: explained above. Then, make sure that you have not made any
1006: changes to the files in the pkgsrc directory. Remove the pkgsrc
1007: directory and extract the new tar file. Done.</p>
1008: </div>
1009: <div class="sect2" lang="en">
1010: <div class="titlepage"><div><div><h3 class="title">
1011: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1012: <p>To update pkgsrc via CVS, make sure the environment
1013: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1014: change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1.77 rillig 1015: -dP</strong></span>.</p>
1.75 rillig 1016: <div class="sect3" lang="en">
1017: <div class="titlepage"><div><div><h4 class="title">
1018: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1019: <p>When updating pkgsrc, the CVS program keeps track of the
1020: branch you selected. But if you, for whatever reason, want to
1021: switch from the stable branch to the current one, you can do it
1022: by adding the option “<span class="quote">-A</span>” after the
1023: “<span class="quote">update</span>” keyword. To switch from the current branch
1024: back to the stable branch, add the
1.98 ! wiz 1025: “<span class="quote">-rpkgsrc-2007Q1</span>” option.</p>
1.75 rillig 1026: </div>
1027: <div class="sect3" lang="en">
1028: <div class="titlepage"><div><div><h4 class="title">
1029: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1030: <p>When you update pkgsrc, the CVS program will only touch
1031: those files that are registered in the CVS repository. That
1032: means that any packages that you created on your own will stay
1033: unmodified. If you change files that are managed by CVS, later
1034: updates will try to merge your changes with those that have been
1035: done by others. See the CVS manual, chapter
1036: “<span class="quote">update</span>” for details.</p>
1037: </div>
1038: </div>
1039: </div>
1040: </div>
1041: <div class="chapter" lang="en">
1042: <div class="titlepage"><div><div><h2 class="title">
1043: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1044: <div class="toc">
1045: <p><b>Table of Contents</b></p>
1046: <dl>
1.82 rillig 1047: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1048: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1049: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1050: <dd><dl>
1051: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1052: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1053: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1054: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1055: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1056: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1057: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1058: </dl></dd>
1059: </dl>
1060: </div>
1061: <div class="sect1" lang="en">
1062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1063: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1064: <p>
1065: We provide a bootstrap kit in both source and binary form for other
1066: platforms than NetBSD, consisting of the pkg administration tools and other
1067: tools required to use pkgsrc and build packages.
1068: </p>
1069: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1070: <h3 class="title">Note</h3>
1071: <p>
1072: Older binary snapshots are available in the
1073: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
1074: directory on ftp.NetBSD.org.</p>
1075: </div>
1076: <div class="table">
1077: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1.91 rillig 1078: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1.82 rillig 1079: <colgroup>
1080: <col>
1081: <col>
1082: <col>
1083: <col>
1084: </colgroup>
1085: <thead><tr>
1086: <th>Platform</th>
1087: <th>Latest snapshot</th>
1088: <th>Binary kit</th>
1089: <th>Binary packages</th>
1090: </tr></thead>
1091: <tbody>
1092: <tr>
1093: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
1094: <td class="date">20021209</td>
1095: <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>
1096: <td class="binary-pkgs-url"> </td>
1097: </tr>
1098: <tr>
1099: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
1100: <td class="date">20030623</td>
1101: <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>
1102: <td class="binary-pkgs-url"> </td>
1103: </tr>
1104: <tr>
1105: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
1106: <td class="date">20041219</td>
1107: <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>
1108: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
1109: </tr>
1110: <tr>
1111: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
1112: <td class="date">20050320</td>
1113: <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>
1114: <td class="binary-pkgs-url"> </td>
1115: </tr>
1116: <tr>
1117: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
1118: <td class="date">20050625</td>
1119: <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>
1120: <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>
1121: </tr>
1122: <tr>
1123: <td class="osname">Debian GNU Linux/i386</td>
1124: <td class="date">20031023</td>
1125: <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>
1126: <td class="binary-pkgs-url"> </td>
1127: </tr>
1128: <tr>
1129: <td class="osname">Fedora Core 2 Linux/i386</td>
1130: <td class="date">20050618</td>
1131: <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>
1132: <td class="binary-pkgs-url"> </td>
1133: </tr>
1134: <tr>
1135: <td class="osname">Fedora Core 4 Linux/i386</td>
1136: <td class="date">20060105</td>
1137: <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>
1138: <td class="binary-pkgs-url"> </td>
1139: </tr>
1140: <tr>
1141: <td class="osname">FreeBSD 3.5/i386</td>
1142: <td class="date">20030411</td>
1143: <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>
1144: <td class="binary-pkgs-url"> </td>
1145: </tr>
1146: <tr>
1147: <td class="osname">FreeBSD 4.7/i386</td>
1148: <td class="date">20021211</td>
1149: <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>
1150: <td class="binary-pkgs-url"> </td>
1151: </tr>
1152: <tr>
1153: <td class="osname">FreeBSD 5.0/i386</td>
1154: <td class="date">20030411</td>
1155: <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>
1156: <td class="binary-pkgs-url"> </td>
1157: </tr>
1158: <tr>
1159: <td class="osname">FreeBSD 5.1/i386</td>
1160: <td class="date">20030630</td>
1161: <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>
1162: <td class="binary-pkgs-url"> </td>
1163: </tr>
1164: <tr>
1165: <td class="osname">FreeBSD 5.2.1/i386</td>
1166: <td class="date">20040227</td>
1167: <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>
1168: <td class="binary-pkgs-url"> </td>
1169: </tr>
1170: <tr>
1171: <td class="osname">FreeBSD 5.3/i386</td>
1172: <td class="date">20050119</td>
1173: <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>
1174: <td class="binary-pkgs-url"> </td>
1175: </tr>
1176: <tr>
1.98 ! wiz 1177: <td class="osname">HP-UX 11.11/hppa</td>
! 1178: <td class="date">20070421</td>
! 1179: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-HPUX-B.11.11-hppa-20070421.tar.gz" target="_top">binary kit</a></td>
! 1180: <td class="binary-pkgs-url"> </td>
! 1181: </tr>
! 1182: <tr>
1.82 rillig 1183: <td class="osname">Interix 3.5</td>
1.93 rillig 1184: <td class="date">20061106</td>
1185: <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>
1186: <td class="binary-pkgs-url"> </td>
1.82 rillig 1187: </tr>
1188: <tr>
1189: <td class="osname">IRIX 6.5 n32-bit ABI</td>
1190: <td class="date">20040911</td>
1191: <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>
1192: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
1193: </tr>
1194: <tr>
1195: <td class="osname">IRIX 6.5 64-bit ABI</td>
1196: <td class="date">20040912</td>
1197: <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>
1198: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
1199: </tr>
1200: <tr>
1201: <td class="osname">OpenBSD 3.2/i386</td>
1202: <td class="date">20030420</td>
1203: <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>
1204: <td class="binary-pkgs-url"> </td>
1205: </tr>
1206: <tr>
1207: <td class="osname">OpenBSD 3.3/i386</td>
1208: <td class="date">20030503</td>
1209: <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>
1210: <td class="binary-pkgs-url"> </td>
1211: </tr>
1212: <tr>
1213: <td class="osname">OpenBSD 3.5/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-OpenBSD-3.5-i386-20040703.tar.gz" target="_top">binary kit</a></td>
1216: <td class="binary-pkgs-url"> </td>
1217: </tr>
1218: <tr>
1.98 ! wiz 1219: <td class="osname">OSF1 5.1/alpha</td>
! 1220: <td class="date">20070420</td>
! 1221: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OSF1-V5.1-alpha-20070420.tar.gz" target="_top">binary kit</a></td>
! 1222: <td class="binary-pkgs-url"> </td>
! 1223: </tr>
! 1224: <tr>
1.82 rillig 1225: <td class="osname">Slackware Linux 8.1/i386</td>
1226: <td class="date">20030417</td>
1227: <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>
1228: <td class="binary-pkgs-url"> </td>
1229: </tr>
1230: <tr>
1231: <td class="osname">Slackware Linux 9/i386</td>
1.93 rillig 1232: <td class="date">20040703</td>
1.82 rillig 1233: <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>
1234: <td class="binary-pkgs-url"> </td>
1235: </tr>
1236: <tr>
1237: <td class="osname">Solaris 8/sparc</td>
1238: <td class="date">20050220</td>
1239: <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>
1240: <td class="binary-pkgs-url"> </td>
1241: </tr>
1242: <tr>
1243: <td class="osname">Solaris 8/i386</td>
1244: <td class="date">20050220</td>
1245: <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>
1246: <td class="binary-pkgs-url"> </td>
1247: </tr>
1248: <tr>
1249: <td class="osname">Solaris 9/sparc</td>
1.93 rillig 1250: <td class="date">20060713</td>
1251: <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>
1252: <td class="binary-pkgs-url"> </td>
1.82 rillig 1253: </tr>
1254: <tr>
1255: <td class="osname">Solaris 9/i386</td>
1256: <td class="date">20030411</td>
1257: <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>
1258: <td class="binary-pkgs-url"> </td>
1259: </tr>
1260: </tbody>
1.91 rillig 1261: </table></div>
1.82 rillig 1262: </div>
1.91 rillig 1263: <br class="table-break"><p>
1.82 rillig 1264: Simply download the binary kit for your platform, and extract it into
1265: <code class="filename">/</code> e.g.
1266: </p>
1267: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
1268: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
1269: | tar -xpf -</code></strong></pre>
1270: <p>
1271: Of course, as with any binary distributions, you should verify the
1272: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
1273: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
1274: file and inspect the contents before extracting it.
1275: </p>
1276: </div>
1277: <div class="sect1" lang="en">
1278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1279: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1280: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1281: <pre class="screen">
1282: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1283: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1284: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1285: </pre>
1.75 rillig 1286: <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 1287: pkgsrc before bootstrapping. The given
1288: <span><strong class="command">bootstrap</strong></span> command will use the defaults of
1289: <code class="filename">/usr/pkg</code> for the
1290: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1291: and <code class="filename">/var/db/pkg</code> for the package database
1292: directory where pkgsrc will do its internal bookkeeping.
1293: However, these can also be set using command-line
1294: arguments.</p>
1.75 rillig 1295: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1.87 wiz 1296: available for supported platforms. An up-to-date list of these can be
1297: found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
1298: Note that this only works for privileged builds that install
1299: into <code class="filename">/usr/pkg</code>.</p>
1.75 rillig 1300: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1301: <h3 class="title">Note</h3>
1302: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1.87 wiz 1303: Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
1304: For examples in this guide, use <span><strong class="command">bmake</strong></span>
1305: instead of “<span class="quote">make</span>”.</p>
1.75 rillig 1306: </div>
1307: </div>
1308: <div class="sect1" lang="en">
1309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1310: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1311: <p>Here are some platform-specific notes you should be aware of.</p>
1312: <div class="sect2" lang="en">
1313: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1314: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85 jmmv 1315: <p>Darwin 5.x and up are supported. There are two methods of using
1.82 rillig 1316: 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 1317: 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 1318: partition</a>.</p>
1319: <p>Before you start, you will need to download and install the Mac OS X Developer
1.87 wiz 1320: Tools from Apple's Developer Connection. See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1321: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1322: from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1323: if you intend to build packages that use the X11 Window System.</p>
1.89 rillig 1324: <p>If you already have a UFS or HFSX partition, or have a spare partition
1325: that you can format as UFS or HFSX, it is recommended to use that instead of
1.87 wiz 1326: the disk image. It'll be somewhat faster and will mount automatically
1327: at boot time, where you must manually mount a disk image.</p>
1.75 rillig 1328: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1329: <h3 class="title">Note</h3>
1.85 jmmv 1330: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89 rillig 1331: 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 1332: </div>
1333: <div class="sect3" lang="en">
1334: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1335: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75 rillig 1336: <p>Create the disk image:</p>
1337: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95 tron 1338: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85 jmmv 1339: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75 rillig 1340: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85 jmmv 1341: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1342: <h3 class="title">Note</h3>
1.89 rillig 1343: <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 1344: </div>
1.89 rillig 1345: <p>Allow suid:</p>
1346: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.75 rillig 1347: </div>
1348: <div class="sect3" lang="en">
1349: <div class="titlepage"><div><div><h4 class="title">
1.89 rillig 1350: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76 rillig 1351: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87 wiz 1352: system, normally HFS+. It is possible to use the default
1353: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1354: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89 rillig 1355: or HFSX file system. Obviously, another symlink is required if you want to
1.87 wiz 1356: place the package database directory outside the
1357: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75 rillig 1358: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1359: <p>If you created your partitions at the time of installing Mac OS X
1.89 rillig 1360: and formatted the target partition as UFS or HFSX, it should automatically
1.87 wiz 1361: mount on <code class="filename">/Volumes/<volume name></code> when the
1.89 rillig 1362: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87 wiz 1363: to ensure that the partition map correctly reflects
1.89 rillig 1364: “<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 1365: <p>The problem is that none of the disk tools will let you touch a
1.87 wiz 1366: disk that is booted from. You can unmount the partition, but even if
1367: you newfs it, the partition type will be incorrect and the
1368: automounter won't mount it. It can be mounted manually, but it won't
1369: appear in Finder.</p>
1.75 rillig 1370: <p>You'll need to boot off of the OS X Installation (User) CD. When
1.87 wiz 1371: the Installation program starts, go up to the menu and select Disk
1372: Utility. Now, you will be able to select the partition you want
1.89 rillig 1373: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1374: installer which will reboot your machine. The new UFS or HFSX file system
1.87 wiz 1375: will appear in Finder.</p>
1.75 rillig 1376: <p>Be aware that the permissions on the new file system will be writable
1.87 wiz 1377: by root only.</p>
1.75 rillig 1378: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87 wiz 1379: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75 rillig 1380: </div>
1381: </div>
1382: <div class="sect2" lang="en">
1383: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1384: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1385: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1386: other versions may work.</p>
1.75 rillig 1387: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1388: with the FreeBSD userland tools. There are several steps:</p>
1.75 rillig 1389: <div class="orderedlist"><ol type="1">
1390: <li><p>FreeBSD stores its ports pkg database in
1.87 wiz 1391: <code class="filename">/var/db/pkg</code>. It is therefore
1392: recommended that you choose a different location (e.g.
1393: <code class="filename">/usr/pkgdb</code>) by
1394: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1395: <li>
1396: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1397: good idea to move them out of the way to avoid confusion, e.g.</p>
1398: <pre class="screen">
1399: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1400: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1401: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1402: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1403: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1404: </pre>
1.75 rillig 1405: </li>
1.76 rillig 1406: <li><p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87 wiz 1407: <code class="filename">/etc/mk.conf.example</code> file
1408: when you use the bootstrap script.</p></li>
1.75 rillig 1409: </ol></div>
1410: </div>
1411: <div class="sect2" lang="en">
1412: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1413: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1414: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1415: providing a Unix-like environment with a tighter kernel integration than
1416: available with Cygwin. It is part of the Windows Services for Unix
1417: package, available for free for any licensed copy of Windows 2000, XP
1418: (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 1419: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1420: are not officially supported. (The main difference in 3.0/3.1 is lack
1421: of pthreads, but other parts of libc may also be lacking.)</p>
1422: <p>Services for Unix Applications (aka SUA) is an integrated component
1423: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1.95 tron 1424: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75 rillig 1425: <div class="sect3" lang="en">
1426: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1427: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1428: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1429: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75 rillig 1430: <div class="itemizedlist"><ul type="disc">
1431: <li><p>Utilities -> Base Utilities</p></li>
1432: <li><p>Interix GNU Components -> (all)</p></li>
1433: <li><p>Remote Connectivity</p></li>
1434: <li><p>Interix SDK</p></li>
1435: </ul></div>
1436: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1437: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1438: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1439: pkgsrc (or from a binary package).</p>
1.75 rillig 1440: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1441: not need to be installed, but Remote Connectivity itself should be
1442: installed in order to have a working inetd.</p>
1.75 rillig 1443: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1444: behavior for Interix programs, and whether to make pathnames default to
1445: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1446: enabled. (Without case-sensitivity, a large number of packages including
1447: perl will not build.)</p>
1.75 rillig 1448: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1449: works (via the Data Execution Prevention feature). In order to use
1450: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1451: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1452: must be installed. Hotfixes are available from Microsoft through a
1453: support contract; however, a NetBSD developer has made most Interix
1454: 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 1455: <p>In addition to the hotfix noted above, it may be necessary to
1456: disable Data Execution Prevention entirely to make Interix functional.
1457: This may happen only with certain types of CPUs; the cause is not fully
1458: understood at this time. If gcc or other applications still segfault
1459: repeatedly after installing one of the hotfixes note above, the
1460: following option can be added to the appropriate "boot.ini" line on the
1461: Windows boot drive: /NoExecute=AlwaysOff
1462: (WARNING, this will disable DEP completely, which may be a security
1463: risk if applications are often run as a user in the Administrators
1464: group!)</p>
1.75 rillig 1465: </div>
1466: <div class="sect3" lang="en">
1467: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1468: <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 1469: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1470: with pkgsrc, note the following things.</p>
1.75 rillig 1471: <div class="itemizedlist"><ul type="disc">
1472: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1473: Windows Services for UNIX, then click Change. In the installer, choose
1474: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.75 rillig 1475: <li>
1476: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1477: change the following registry key:</p>
1.75 rillig 1478: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1479: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1480: </li>
1481: <li>
1482: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1483: following registry key:</p>
1.75 rillig 1484: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1485: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1486: </li>
1487: </ul></div>
1488: </div>
1489: <div class="sect3" lang="en">
1490: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1491: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1492: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1493: running "pkg_add") must be a member of the local Administrators
1494: group. Such a user must also be used to run the bootstrap. This is
1495: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1496: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1497: automatically complain if this is not the case. This ensures that
1498: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1499: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1500: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1501: NOT be used in conjunction with pkgsrc. If you choose to use them at
1502: the same time as the pkgsrc packages, ensure that you use the proper
1503: pkg_* tools for each type of binary package.</p>
1.75 rillig 1504: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1505: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1506: don't have a termcap/terminfo entry for it, but the following .termcap
1507: entry provides adequate emulation in most cases:</p>
1.75 rillig 1508: <pre class="programlisting">
1.87 wiz 1509: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1510: </pre>
1.75 rillig 1511: </div>
1512: <div class="sect3" lang="en">
1513: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1514: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1515: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1516: for a full Unix-like platform, it has some drawbacks that should
1517: be noted for those desiring to make the most of Interix.</p>
1.75 rillig 1518: <div class="itemizedlist"><ul type="disc">
1519: <li>
1520: <p><span class="strong"><strong>X11:</strong></span></p>
1521: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1522: and can run X11 based applications, but it does
1523: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1524: <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1525: <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1526: (available in a trimmed version for Interix from Interop Systems as the
1527: <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1528: and the free X11 server included with
1529: <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1530: </li>
1531: <li>
1532: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1533: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1534: Win32 applications, it does not currently support various X11
1535: protocol extensions for acceleration (such as MIT-SHM or DGA).
1536: Most interactive applications to a local X server will run
1537: reasonably fast, but full motion video and other graphics
1538: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1539: </li>
1540: <li>
1541: <p><span class="strong"><strong>Audio:</strong></span></p>
1542: <p>Interix has no native support for audio output. For audio
1.87 wiz 1543: support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
1544: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1545: <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 1546: <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
1547: server component. To output audio via an Interix host, the
1.91 rillig 1548: <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 1549: must also be installed.</p>
1.75 rillig 1550: </li>
1551: <li>
1552: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1553: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1554: is not currently possible to access CD/DVD drives, USB devices,
1555: or SCSI devices through non-filesystem means. Among other things,
1556: this makes it impossible to use Interix directly for CD/DVD
1557: burning.</p>
1.75 rillig 1558: </li>
1559: <li>
1560: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1561: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1562: drives are also not directly accessible in Interix. However,
1563: support is in work to make tape drive access possible by using
1564: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1565: esound server).</p>
1.75 rillig 1566: </li>
1567: </ul></div>
1568: </div>
1569: <div class="sect3" lang="en">
1570: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1571: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1572: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1573: Windows system; any member of the local Administrators group will
1574: suffice. However, some packages currently assume that the user
1575: named "root" is the privileged user. To accommodate these, you
1576: may create such a user; make sure it is in the local group
1577: Administrators (or your language equivalent).</p>
1578: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
1579: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1580: time being, install packages as the local Administrator (or
1581: your language equivalent), or run the following command after
1582: installing a package to work around the issue:</p>
1.75 rillig 1583: <pre class="screen">
1.87 wiz 1584: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1585: </pre>
1.75 rillig 1586: </div>
1587: </div>
1588: <div class="sect2" lang="en">
1589: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1590: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1591: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1592: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1593: according to your preference. If you do not have a license for the MIPSpro
1594: 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 1595: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87 wiz 1596: 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>,
1597: etc.</p>
1.86 schwarz 1598: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1599: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1600: you start out using "abi=n32", that's what all your packages will be built
1601: with.</p>
1602: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1603: <code class="varname">CFLAGS</code> in your environment or the
1604: <code class="filename">/etc/mk.conf</code>. Particularly, make sure that you do not
1605: try to link n32 object files with lib64 or vice versa. Check your
1606: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1607: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1608: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1609: as it appears that IRIX linker occasionally runs into issues when trying to
1610: link over a network-mounted file system.</p>
1.75 rillig 1611: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1612: as imake(1), but you may want to set some options depending on your local
1613: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1614: course, your compiler's man pages for details.</p>
1.75 rillig 1615: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1616:
1.87 wiz 1617: </p>
1.75 rillig 1618: <pre class="programlisting">
1.87 wiz 1619: PKGSRC_COMPILER= mipspro
1620: </pre>
1.75 rillig 1621: <p>
1.1 grant 1622:
1.87 wiz 1623: in <code class="filename">/etc/mk.conf</code>. Otherwise, pkgsrc will assume you
1624: are using gcc and may end up passing invalid flags to the compiler. Note that
1625: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1626: default.</p>
1.75 rillig 1627: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1628: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1629: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1630: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1631: '--preserve-path' flag.</p>
1.75 rillig 1632: </div>
1633: <div class="sect2" lang="en">
1634: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1635: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1636: <p>Some versions of Linux (for example Debian GNU/Linux) need
1637: either libtermcap or libcurses (libncurses). Installing the
1638: distributions libncurses-dev package (or equivalent) should fix
1639: the problem.</p>
1640: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1641: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1642: i386 have been tested.</p>
1.75 rillig 1643: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1644: directory:</p>
1.75 rillig 1645: <pre class="programlisting">
1.87 wiz 1646: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1647: ac_cv___attribute__=yes ./bootstrap
1648: </pre>
1.75 rillig 1649: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1650: <h3 class="title">Note</h3>
1651: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1652: </div>
1653: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1654: function, which icc does not support. #undef'ing __attribute__ has the
1655: unfortunate side-effect of breaking many of the Linux header files, which
1656: cannot be compiled properly without __attribute__. The test must be
1657: overridden so that __attribute__ is assumed supported by the
1658: compiler.</p>
1.75 rillig 1659: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.87 wiz 1660: in <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 1661: <pre class="programlisting">
1.87 wiz 1662: PKGSRC_COMPILER= icc
1663: </pre>
1.75 rillig 1664: <p>The default installation directory for icc is
1.87 wiz 1665: <code class="filename">/opt/intel_cc_80</code>, which
1666: is also the pkgsrc default. If you have installed it into a different
1667: directory, set <code class="varname">ICCBASE</code> in
1668: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 1669: <pre class="programlisting">
1.87 wiz 1670: ICCBASE= /opt/icc
1671: </pre>
1.75 rillig 1672: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1673: provided by icc, so binaries can be run on other systems which do not
1674: have the shared libraries installed.</p>
1675: <p>Libtool, however, extracts a list of libraries from the
1676: <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
1677: records it, throwing away the -Bstatic and -Bdynamic options
1678: interspersed between the libraries. This means that
1679: libtool-linked C++ shared libraries will have a runtime
1680: dependency on the icc libraries until this is fixed in
1681: libtool.</p>
1.75 rillig 1682: </div>
1683: <div class="sect2" lang="en">
1684: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1685: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1686: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1687: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1688: with the OpenBSD userland tools. There are several steps:</p>
1.75 rillig 1689: <div class="orderedlist"><ol type="1">
1690: <li><p>OpenBSD stores its ports pkg database in
1.87 wiz 1691: <code class="filename">/var/db/pkg</code>. It is therefore
1692: recommended that you choose a different location (e.g.
1693: <code class="filename">/usr/pkgdb</code>) by
1694: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1695: <li>
1696: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1697: good idea to move them out of the way to avoid confusion, e.g.</p>
1698: <pre class="screen">
1699: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1700: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1701: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1702: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1703: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1704: </pre>
1.75 rillig 1705: </li>
1706: <li>
1.76 rillig 1707: <p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87 wiz 1708: <code class="filename">/etc/mk.conf.example</code> file
1709: when you use the bootstrap script. OpenBSD's make program uses
1710: <code class="filename">/etc/mk.conf</code>
1711: as well. You can work around this by enclosing all the pkgsrc-specific parts
1712: of the file with:</p>
1713: <pre class="programlisting">
1714: .ifdef BSD_PKG_MK
1715: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1716: .else
1717: # OpenBSD stuff
1718: .endif
1719: </pre>
1.75 rillig 1720: </li>
1721: </ol></div>
1722: </div>
1723: <div class="sect2" lang="en">
1724: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1725: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1726: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1727: You will need a working C compiler. Both gcc 2.95.3 and
1728: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1729: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1730: process and to build packages.</p>
1.75 rillig 1731: <div class="itemizedlist"><ul type="disc">
1732: <li><p>SUNWsprot</p></li>
1733: <li><p>SUNWarc</p></li>
1734: <li><p>SUNWbtool</p></li>
1735: <li><p>SUNWtoo</p></li>
1736: <li><p>SUNWlibm</p></li>
1737: </ul></div>
1.78 rillig 1738: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1739: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1740: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1741: your $prefix are in your <code class="varname">PATH</code>. This includes
1742: <code class="filename">/usr/ccs/{bin,lib}</code>
1743: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75 rillig 1744: <div class="sect3" lang="en">
1745: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1746: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1747: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1748: for building all packages.</p>
1.75 rillig 1749: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1750: then either build gcc from
1.91 rillig 1751: <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 1752: package, then remove gcc used during bootstrapping.</p>
1.93 rillig 1753: <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 1754: </div>
1755: <div class="sect3" lang="en">
1756: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1757: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1758: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1759: 5.0)</p>
1.75 rillig 1760: <div class="itemizedlist"><ul type="disc">
1761: <li><p>SPROcc
1.87 wiz 1762: - Sun WorkShop Compiler C 5.0</p></li>
1.75 rillig 1763: <li><p>SPROcpl
1.87 wiz 1764: - Sun WorkShop Compiler C++ 5.0</p></li>
1.75 rillig 1765: <li><p>SPROild
1.87 wiz 1766: - Sun WorkShop Incremental Linker</p></li>
1.75 rillig 1767: <li><p>SPROlang
1.87 wiz 1768: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1769: </ul></div>
1.96 rillig 1770: <p>You should set the following variables in your
1771: <code class="filename">mk.conf</code> file:</p>
1772: <pre class="programlisting">
1773: CC= cc
1774: CXX= CC
1775: CPP= cc -E
1776: CXXCPP= CC -E
1777: </pre>
1778: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1779: <h3 class="title">Note</h3>
1780: <p>The <code class="varname">CPP</code> setting might break some
1781: packages that use the C preprocessor for processing things other
1782: than C source code.</p>
1783: </div>
1.75 rillig 1784: </div>
1785: <div class="sect3" lang="en">
1786: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1787: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1788: <p>To build 64-bit packages, you just need to have the
1789: following lines in your <code class="filename">mk.conf</code>
1.75 rillig 1790: file:</p>
1791: <pre class="programlisting">
1.96 rillig 1792: PKGSRC_COMPILER= sunpro
1793: ABI= 64
1794: </pre>
1795: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1796: <h3 class="title">Note</h3>
1797: <p>This setting has been tested for the SPARC
1798: architecture. Intel and AMD machines need some more
1799: work.</p>
1800: </div>
1.75 rillig 1801: </div>
1802: <div class="sect3" lang="en">
1803: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1804: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75 rillig 1805: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87 wiz 1806: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1807: The workaround is to use another shell for the configure
1.91 rillig 1808: 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 1809: to your <code class="filename">mk.conf</code>:</p>
1810: <pre class="programlisting">
1811: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1812: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1813: </pre>
1.91 rillig 1814: <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 1815: </div>
1816: </div>
1817: </div>
1818: </div>
1819: <div class="chapter" lang="en">
1820: <div class="titlepage"><div><div><h2 class="title">
1821: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1822: <div class="toc">
1823: <p><b>Table of Contents</b></p>
1824: <dl>
1825: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1826: <dd><dl>
1827: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1828: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1829: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1830: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1831: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1832: <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>
1833: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1834: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1835: </dl></dd>
1836: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1837: <dd><dl>
1838: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1839: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1840: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1841: </dl></dd>
1842: </dl>
1843: </div>
1844: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1845: is to only install the package tools and to use binary packages
1846: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1847: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1848: of pkgsrc, too. Then you are able to build your own packages,
1849: and you can still use binary packages from someone else.</p>
1.75 rillig 1850: <div class="sect1" lang="en">
1851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1852: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1853: <p>To use binary packages, you need some tools to manage
1.88 wiz 1854: them. On NetBSD, these tools are already installed. On all other
1855: operating systems, you need to install them first. For the
1856: following platforms, prebuilt versions of the package tools
1857: are available and can simply be downloaded and unpacked in the
1858: <code class="filename">/</code> directory:</p>
1.75 rillig 1859: <div class="informaltable">
1860: <a name="binary-bootstrap-kits"></a><table border="1">
1861: <colgroup>
1862: <col>
1863: <col>
1864: </colgroup>
1865: <thead><tr>
1866: <th>Platform</th>
1867: <th>URL</th>
1868: </tr></thead>
1869: <tbody>
1870: <tr>
1871: <td>Solaris 9</td>
1.76 rillig 1872: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1873: </tr>
1874: <tr>
1875: <td>Solaris 10</td>
1.76 rillig 1876: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1877: </tr>
1878: </tbody>
1879: </table>
1880: </div>
1.82 rillig 1881: <p>These pre-built package tools use
1.88 wiz 1882: <code class="filename">/usr/pkg</code> for the base directory, and
1883: <code class="filename">/var/db/pkg</code> for the database of installed
1884: packages. If you cannot use these directories for whatever
1885: reasons (maybe because you're not root), you have to build the
1886: 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 1887: <div class="sect2" lang="en">
1888: <div class="titlepage"><div><div><h3 class="title">
1889: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1890: <p>To install binary packages, you first need to know from
1.88 wiz 1891: where to get them. You can get them on CD-ROMs, DVDs, or via FTP
1892: or HTTP.</p>
1.81 rillig 1893: <p>The binary packages can be found at the following
1.88 wiz 1894: locations.</p>
1.75 rillig 1895: <div class="informaltable">
1896: <a name="binary-packages"></a><table border="1">
1897: <colgroup>
1898: <col>
1899: <col>
1900: </colgroup>
1901: <thead><tr>
1902: <th>Platform</th>
1903: <th>URL</th>
1904: </tr></thead>
1905: <tbody>
1906: <tr>
1.81 rillig 1907: <td>NetBSD</td>
1908: <td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
1909: </tr>
1910: <tr>
1.75 rillig 1911: <td>Solaris 9</td>
1.76 rillig 1912: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
1.75 rillig 1913: </tr>
1914: <tr>
1915: <td>Solaris 10</td>
1.76 rillig 1916: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/</code></td>
1.75 rillig 1917: </tr>
1918: </tbody>
1919: </table>
1920: </div>
1.81 rillig 1921: <p>Most of these directories contain binary packages for
1.88 wiz 1922: multiple platforms. Select the appropriate subdirectories,
1923: according to your machine architecture and operating system,
1924: until you find a directory called <code class="filename">All</code>. This
1925: directory contains all the binary packages. Further, there are
1926: subdirectories for categories that contain symbolic links that
1927: point to the actual binary package in
1928: <code class="filename">../All</code>. This directory layout is used for
1929: all package repositories, no matter if they are accessed via
1930: HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
1.75 rillig 1931: </div>
1932: <div class="sect2" lang="en">
1933: <div class="titlepage"><div><div><h3 class="title">
1934: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87 wiz 1935: <p>If you have the files on a CD-ROM or downloaded them to
1.88 wiz 1936: your hard disk, you can install them with the following command
1937: (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75 rillig 1938: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87 wiz 1939: <p>If you have FTP access and you don't want to download the
1.88 wiz 1940: packages via FTP prior to installation, you can do this
1941: automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.82 rillig 1942: <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 1943: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1944: package in question will be installed, too, assuming they are
1945: present where you install from.</p>
1.75 rillig 1946: <p>To save some typing, you can set the
1.88 wiz 1947: <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
1948: list of paths (including remote URLs); trailing slashes are not allowed.
1949: </p>
1.76 rillig 1950: <p>Additionally to the <code class="filename">All</code> directory
1.88 wiz 1951: there exists a <code class="filename">vulnerable</code> directory to
1952: which binary packages with known vulnerabilities are
1953: moved, since removing them could cause missing dependencies. To
1954: use these packages, add the <code class="filename">vulnerable</code>
1955: directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91 rillig 1956: <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 1957: especially after installing new packages, and verify that the
1958: vulnerabilities are acceptable for your configuration. An example
1959: <code class="varname">PKG_PATH</code> would be:
1960: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
1961: Please note that semicolon (';') is a shell meta-character, so
1962: you'll probably have to quote it.</p>
1.75 rillig 1963: <p>After you've installed packages, be sure to have
1.88 wiz 1964: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1965: <code class="varname">PATH</code> so you can actually start the just
1966: installed program.</p>
1.75 rillig 1967: </div>
1968: <div class="sect2" lang="en">
1969: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1970: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1971: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1972: installed from source code or from a binary package. The
1973: <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
1974: To delete a package, you can just run <span><strong class="command">pkg_delete
1975: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1976: name can be given with or without version number. Wildcards can
1977: also be used to deinstall a set of packages, for example
1978: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1979: so that the shell does not expand them before
1980: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1981: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1982: removes all the packages that require the package in question
1983: and then removes the package itself. For example:
1.82 rillig 1984:
1.88 wiz 1985: </p>
1.82 rillig 1986: <pre class="screen">
1.88 wiz 1987: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1988: </pre>
1.82 rillig 1989: <p>
1990:
1.88 wiz 1991: will remove jpeg and all the packages that used it; this allows
1992: upgrading the jpeg package.</p>
1.82 rillig 1993: </div>
1994: <div class="sect2" lang="en">
1995: <div class="titlepage"><div><div><h3 class="title">
1996: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1997: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88 wiz 1998: installed packages or binary package files.</p>
1.82 rillig 1999: </div>
2000: <div class="sect2" lang="en">
2001: <div class="titlepage"><div><div><h3 class="title">
2002: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
2003: <p>
1.88 wiz 2004: The NetBSD Security-Officer and Packages Groups maintain a list of
2005: known security vulnerabilities to packages which are (or have been)
2006: included in pkgsrc. The list is available from the NetBSD
2007: FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
2008: </p>
1.82 rillig 2009: <p>
1.93 rillig 2010: 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 2011: this list can be downloaded
2012: automatically, and a security audit of all packages installed on a system
2013: can take place.
2014: </p>
1.82 rillig 2015: <p>
1.93 rillig 2016: There are two components to
1.91 rillig 2017: <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 2018: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
2019: the list of vulnerabilities from the NetBSD FTP site. The second
2020: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
2021: installed packages are vulnerable. If a package is vulnerable, you
2022: will see output similar to the following:
2023: </p>
1.82 rillig 2024: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 2025: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 2026: <p>
1.91 rillig 2027: 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 2028: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
2029: file daily, and include a package audit in the daily security script.
2030: 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 2031: 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 2032: </p>
1.82 rillig 2033: </div>
2034: <div class="sect2" lang="en">
2035: <div class="titlepage"><div><div><h3 class="title">
2036: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
2037: <p>
1.93 rillig 2038: 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 2039: <span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
2040: argument to check if your packages are up-to-date, e.g.
2041: </p>
2042: <pre class="screen">
2043: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 2044: ...
1.88 wiz 2045: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
2046: </pre>
1.82 rillig 2047: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88 wiz 2048: package on your system and rebuild any dependencies.
2049: </p>
1.82 rillig 2050: </div>
2051: <div class="sect2" lang="en">
2052: <div class="titlepage"><div><div><h3 class="title">
2053: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
2054: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88 wiz 2055: administrative functions on the package system.</p>
1.82 rillig 2056: </div>
2057: <div class="sect2" lang="en">
2058: <div class="titlepage"><div><div><h3 class="title">
2059: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 2060: <p>Please pay very careful attention to the warnings
1.88 wiz 2061: 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
2062: inherent dangers of installing binary packages which you did
2063: not create yourself, and the security holes that can be
2064: introduced onto your system by indiscriminate adding of such
2065: files.</p>
1.75 rillig 2066: <p>The same warning of course applies to every package you
1.88 wiz 2067: install from source when you haven't completely read and
2068: understood the source code of the package, the compiler that
2069: is used to build the package and all the other tools that are
2070: involved.</p>
1.75 rillig 2071: </div>
2072: </div>
2073: <div class="sect1" lang="en">
2074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2075: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 2076: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
2077: directory now contains a set of packages, organized into
2078: categories. You can browse the online index of packages, or run
2079: <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
2080: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 2081: 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 2082: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
2083: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
2084: should do so by setting <code class="varname">LOCALBASE</code> in
2085: <code class="filename">mk.conf</code>. You should not try to use multiple
2086: different <code class="varname">LOCALBASE</code> definitions on the same
2087: system (inside a chroot is an exception). </p>
2088: <p>The rest of this chapter assumes that the package is already
2089: 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
2090: instructions how to create your own packages.</p>
1.75 rillig 2091: <div class="sect2" lang="en">
2092: <div class="titlepage"><div><div><h3 class="title">
2093: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 2094: <p>To build packages from source, you need a working C
1.88 wiz 2095: compiler. On NetBSD, you need to install the
2096: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
2097: sets. If you want to build X11-related packages, the
2098: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
2099: sets are required, too.</p>
1.75 rillig 2100: </div>
2101: <div class="sect2" lang="en">
2102: <div class="titlepage"><div><div><h3 class="title">
2103: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
2104: <p>The first step for building a package is downloading the
1.88 wiz 2105: distfiles (i.e. the unmodified source). If they have not yet been
2106: downloaded, pkgsrc will fetch them automatically.</p>
2107: <p>If you have all files that you need in the
2108: <code class="filename">distfiles</code> directory,
2109: you don't need to connect. If the distfiles are on CD-ROM, you can
2110: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
2111: </p>
1.82 rillig 2112: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
2113: <p>
1.88 wiz 2114: to your <code class="filename">mk.conf</code>.</p>
1.91 rillig 2115: <p>By default a list of distribution sites will be randomly
2116: intermixed to prevent huge load on servers which holding popular
2117: packages (for example, SourceForge.net mirrors). Thus, every
2118: time when you need to fetch yet another distfile all the mirrors
2119: will be tried in new (random) order. You can turn this feature
2120: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
2121: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 2122: <p>You can overwrite some of the major distribution sites to
2123: fit to sites that are close to your own. By setting one or two
2124: variables you can modify the order in which the master sites are
2125: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
2126: delimited list of domain suffixes.
2127: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
2128: contains a whitespace delimited list of regular expressions. It
2129: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
2130: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
2131: some examples. This may save some of your bandwidth and
2132: time.</p>
1.75 rillig 2133: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 2134: if you want to keep the settings, by editing the
2135: <code class="filename">/etc/mk.conf</code> file,
2136: and adding the definitions there.</p>
1.82 rillig 2137: <p>
1.88 wiz 2138: If a package depends on many other packages (such as
1.93 rillig 2139: <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 2140: alternate between periods of
2141: downloading source, and compiling. To ensure you have all the source
2142: downloaded initially you can run the command:
2143: </p>
1.82 rillig 2144: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
2145: <p>
1.88 wiz 2146: which will output and run a set of shell commands to fetch the
2147: necessary files into the <code class="filename">distfiles</code> directory. You can
2148: also choose to download the files manually.
2149: </p>
1.75 rillig 2150: </div>
2151: <div class="sect2" lang="en">
2152: <div class="titlepage"><div><div><h3 class="title">
2153: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 2154: <p>
1.88 wiz 2155: Once the software has downloaded, any patches will be applied, then it
2156: will be compiled for you. This may take some time depending on your
2157: computer, and how many other packages the software depends on and their
2158: compile time.
2159: </p>
1.75 rillig 2160: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2161: <h3 class="title">Note</h3>
2162: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88 wiz 2163: use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
2164: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 2165: </div>
1.87 wiz 2166: <p>For example, type</p>
1.88 wiz 2167: <pre class="screen">
2168: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2169: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2170: </pre>
1.75 rillig 2171: <p>at the shell prompt to build the various components of the
1.88 wiz 2172: package.</p>
1.82 rillig 2173: <p>The next stage is to actually install the newly compiled
1.88 wiz 2174: program onto your system. Do this by entering:
1.82 rillig 2175:
1.88 wiz 2176: </p>
1.82 rillig 2177: <pre class="screen">
1.88 wiz 2178: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2179: </pre>
1.82 rillig 2180: <p>
2181:
1.88 wiz 2182: while you are still in the directory for whatever package you
2183: are installing.</p>
1.82 rillig 2184: <p>Installing the package on your system may require you to
1.88 wiz 2185: be root. However, pkgsrc has a
2186: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2187: to only become root for the actual installation step.</p>
1.82 rillig 2188: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2189: You can now enter:
1.82 rillig 2190:
1.88 wiz 2191: </p>
1.82 rillig 2192: <pre class="screen">
1.88 wiz 2193: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2194: </pre>
1.82 rillig 2195: <p>
2196:
1.88 wiz 2197: to remove the compiled files in the work directory, as you shouldn't need
2198: them any more. If other packages were also added to your system
2199: (dependencies) to allow your program to compile, you can tidy these up
2200: also with the command:</p>
1.82 rillig 2201: <pre class="screen">
1.88 wiz 2202: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2203: </pre>
1.75 rillig 2204: <p>Taking the figlet utility as an example, we can install it on our
1.88 wiz 2205: system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
2206: <p>The program is installed under the default root of the
2207: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2208: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2209: variable in your environment, and it will use that value as the
2210: root of your packages tree. So, to use
2211: <code class="filename">/usr/local</code>, set
2212: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2213: Please note that you should use a directory which is dedicated to
2214: packages and not shared with other programs (i.e., do not try and
2215: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2216: to add any of your own files or directories (such as
2217: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2218: <code class="filename">pkgsrc/</code>) below the
2219: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2220: conflicts between programs and other files installed by the
2221: package system and whatever else may have been installed
2222: there.</p>
2223: <p>Some packages look in <code class="filename">/etc/mk.conf</code> to
2224: alter some configuration options at build time. Have a look at
2225: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2226: of what will be set there by default. Environment variables such
2227: as <code class="varname">LOCALBASE</code> can be set in
2228: <code class="filename">/etc/mk.conf</code> to save having to remember to
2229: set them each time you want to use pkgsrc.</p>
2230: <p>Occasionally, people want to “<span class="quote">look under the
2231: covers</span>” to see what is going on when a package is building
2232: or being installed. This may be for debugging purposes, or out of
2233: simple curiosity. A number of utility values have been added to
2234: help with this.</p>
1.75 rillig 2235: <div class="orderedlist"><ol type="1">
2236: <li>
1.88 wiz 2237: <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
2238: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2239: information will be displayed. For example,</p>
1.75 rillig 2240: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2241: <p>will show all the commands that are invoked, up to and
2242: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 2243: </li>
2244: <li>
1.88 wiz 2245: <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>
2246: definition, then the <code class="varname">VARNAME</code> definition
2247: should be used, in conjunction with the show-var
2248: 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>
2249: variable <code class="varname">LOCALBASE</code>:</p>
2250: <pre class="screen">
2251: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2252: /usr/pkg
2253: <code class="prompt">%</code>
1.88 wiz 2254: </pre>
1.75 rillig 2255: </li>
2256: </ol></div>
2257: <p>If you want to install a binary package that you've either
1.88 wiz 2258: created yourself (see next section), that you put into
2259: pkgsrc/packages manually or that is located on a remote FTP
2260: server, you can use the "bin-install" target. This target will
2261: 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>,
2262: else do a <span><strong class="command">make package</strong></span>. The list of remote FTP
2263: sites searched is kept in the variable
2264: <code class="varname">BINPKG_SITES</code>, which defaults to
2265: 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>
2266: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2267: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2268: details.</p>
2269: <p>A final word of warning: If you set up a system that has a
2270: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2271: set that before any packages are installed, as you cannot use
2272: several directories for the same purpose. Doing so will result in
2273: pkgsrc not being able to properly detect your installed packages,
2274: and fail miserably. Note also that precompiled binary packages are
2275: usually built with the default <code class="varname">LOCALBASE</code> of
2276: <code class="filename">/usr/pkg</code>, and that you should
2277: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2278: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2279: </div>
2280: </div>
2281: </div>
2282: <div class="chapter" lang="en">
2283: <div class="titlepage"><div><div><h2 class="title">
2284: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2285: <div class="toc">
2286: <p><b>Table of Contents</b></p>
2287: <dl>
2288: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2289: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 2290: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2291: <dd><dl>
1.89 rillig 2292: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
2293: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2294: <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 2295: </dl></dd>
1.78 rillig 2296: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
2297: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 2298: </dl>
2299: </div>
1.89 rillig 2300: <p>The whole pkgsrc system is configured in a single file, usually
2301: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2302: that file depends on the installation. On NetBSD, when you use
2303: <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
2304: <code class="filename">/etc/</code>. In all other cases the default location is
2305: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2306: bootstrap program to install the binary packages.</p>
2307: <p>During the bootstrap, an example configuration file is created. To
2308: use that, you have to create the directory
2309: <code class="filename">${PREFIX}/etc</code> and copy the example file
2310: there.</p>
2311: <p>The format of the configuration file is that of the usual
2312: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2313: is done by setting variables in this file. Note that you can define all
2314: kinds of variables, and no special error checking (for example for
2315: spelling mistakes) takes place, so you have to try it out to see if it
2316: works.</p>
1.75 rillig 2317: <div class="sect1" lang="en">
2318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2319: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2320: <p>In this section, you can find some variables that apply to all
1.89 rillig 2321: pkgsrc packages. A complete list of the variables that can be
2322: configured by the user is available in
2323: <code class="filename">mk/defaults/mk.conf</code>, together with some
2324: comments that describe each variable's intent.</p>
1.75 rillig 2325: <div class="itemizedlist"><ul type="disc">
2326: <li><p><code class="varname">LOCALBASE</code>: Where
2327: packages will be installed. The default is
1.76 rillig 2328: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2329: with different <code class="varname">LOCALBASE</code>s!</p></li>
2330: <li><p><code class="varname">CROSSBASE</code>: Where
2331: “<span class="quote">cross</span>” category packages will be
2332: installed. The default is
1.76 rillig 2333: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2334: <li><p><code class="varname">X11BASE</code>: Where
2335: X11 is installed on the system. The default is
1.76 rillig 2336: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2337: <li><p><code class="varname">DISTDIR</code>: Where to store the
2338: downloaded copies of the original source distributions used
2339: for building pkgsrc packages. The default is
1.76 rillig 2340: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97 rillig 2341: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2342: database about installed packages is stored. The default is
2343: <code class="filename">/var/db/pkg</code>.</p></li>
1.75 rillig 2344: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2345: If set, override the packages'
2346: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2347: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2348: Backup location(s) for distribution files and patch files
2349: if not found locally or in
1.76 rillig 2350: <code class="filename">${MASTER_SITES}</code> or
2351: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2352: The defaults are
1.76 rillig 2353: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2354: and
1.76 rillig 2355: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2356: <li><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2357: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2358: <em class="replaceable"><code>arch</code></em> are replaced with OS
2359: release (“<span class="quote">2.0</span>”, etc.) and architecture
2360: (“<span class="quote">mipsel</span>”, etc.).</p></li>
1.82 rillig 2361: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2362: List of acceptable licenses. Whenever you try to build a package
2363: whose license is not in this list, you will get an error message
2364: that includes instructions on how to change this variable.</p></li>
1.75 rillig 2365: </ul></div>
2366: </div>
2367: <div class="sect1" lang="en">
2368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2369: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2370: <p>XXX
2371: </p>
2372: <div class="itemizedlist"><ul type="disc">
2373: <li><p><code class="varname">PACKAGES</code>: The top level
2374: directory for the binary packages. The default is
1.76 rillig 2375: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2376: <li><p><code class="varname">WRKOBJDIR</code>:
2377: The top level directory where, if defined, the separate
2378: working directories will get created, and symbolically
1.76 rillig 2379: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2380: This is useful for building packages on several
1.76 rillig 2381: architectures, then <code class="filename">${PKGSRCDIR}</code>
2382: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2383: is local to every architecture. (It should be noted that
2384: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.89 rillig 2385: — it is an internal definition which refers to the
1.75 rillig 2386: root of the pkgsrc tree. It is possible to have many
2387: pkgsrc tree instances.)</p></li>
2388: <li><p><code class="varname">LOCALPATCHES</code>:
2389: Directory for local patches that aren't part of pkgsrc.
1.90 rillig 2390: See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more
1.93 rillig 2391: information.</p></li>
1.75 rillig 2392: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.76 rillig 2393: the <code class="filename">mk.conf</code> file used by a package's
1.75 rillig 2394: BSD-style Makefile. If this is not set,
2395: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2396: <code class="filename">/dev/null</code> to avoid picking up
2397: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2398: <li><p><code class="varname">DEPENDS_TARGET</code>:
2399: By default, dependencies are only installed, and no binary
2400: package is created for them. You can set this variable to
2401: <code class="literal">package</code> to automatically create binary
2402: packages after installing dependencies.</p></li>
1.75 rillig 2403: </ul></div>
2404: </div>
2405: <div class="sect1" lang="en">
2406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78 rillig 2407: <a name="conf.compiler"></a>5.3. Selecting and configuring the compiler</h2></div></div></div>
2408: <div class="sect2" lang="en">
2409: <div class="titlepage"><div><div><h3 class="title">
1.89 rillig 2410: <a name="selecting-the-compiler"></a>5.3.1. Selecting the compiler</h3></div></div></div>
2411: <p>By default, pkgsrc will use GCC to build packages. This may be
2412: overridden by setting the following variables in /etc/mk.conf:</p>
2413: <div class="variablelist"><dl>
2414: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2415: <dd>
2416: <p>This is a list of values specifying the chain of
2417: compilers to invoke when building packages. Valid values
2418: are:</p>
2419: <div class="itemizedlist"><ul type="disc">
2420: <li><p><code class="varname">distcc</code>:
2421: distributed C/C++ (chainable)</p></li>
2422: <li><p><code class="varname">ccache</code>:
2423: compiler cache (chainable)</p></li>
2424: <li><p><code class="varname">gcc</code>:
2425: GNU C/C++ Compiler</p></li>
2426: <li><p><code class="varname">mipspro</code>:
2427: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2428: <li><p><code class="varname">mipspro</code>:
2429: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2430: <li><p><code class="varname">sunpro</code>:
2431: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2432: </ul></div>
2433: <p>The default is
2434: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2435: <code class="varname">ccache</code> and/or
2436: <code class="varname">distcc</code> with an appropriate
2437: <code class="varname">PKGSRC_COMPILER</code> setting,
2438: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
1.94 dmcmahil 2439: variable should always be terminated with a value for
2440: a real compiler. Note that only one real compiler
2441: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2442: is not allowed).</p>
1.89 rillig 2443: </dd>
2444: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2445: <dd><p>This specifies the minimum version of GCC to use
2446: when building packages. If the system GCC doesn't
2447: satisfy this requirement, then pkgsrc will build and
2448: install one of the GCC packages to use instead.</p></dd>
2449: </dl></div>
2450: </div>
2451: <div class="sect2" lang="en">
2452: <div class="titlepage"><div><div><h3 class="title">
2453: <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 2454: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2455: please make sure to use the <code class="literal">+=</code> operator
2456: instead of the <code class="literal">=</code> operator:</p>
2457: <pre class="programlisting">
2458: CFLAGS+= -your -flags
2459: </pre>
2460: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2461: “<span class="quote">+</span>”) may lead to problems with packages that need
2462: to add their own flags. Also, you may want to take a look at
1.91 rillig 2463: 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 2464: you're interested in optimization for the current CPU.</p>
2465: </div>
1.88 wiz 2466: <div class="sect2" lang="en">
2467: <div class="titlepage"><div><div><h3 class="title">
1.89 rillig 2468: <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 2469: <p>If you want to pass flags to the linker, both in the configure
2470: step and the build step, you can do this in two ways. Either set
2471: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2472: between the two is that <code class="varname">LIBS</code> will be appended to
2473: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2474: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2475: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2476: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2477: <code class="varname">CFLAGS</code>, if you do not wish to override these
2478: settings, use the <code class="literal">+=</code> operator:</p>
2479: <pre class="programlisting">
2480: LDFLAGS+= -your -linkerflags
2481: </pre>
2482: </div>
1.78 rillig 2483: </div>
2484: <div class="sect1" lang="en">
2485: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2486: <a name="developer-advanced-settings"></a>5.4. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2487: <p>XXX
2488: </p>
2489: <div class="itemizedlist"><ul type="disc">
2490: <li>
2491: <p><code class="varname">PKG_DEVELOPER</code>:
2492: Run some sanity checks that package developers want:
2493: </p>
2494: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2495: <li><p>make sure patches apply with zero
2496: fuzz</p></li>
2497: <li><p>run check-shlibs to see that all
2498: binaries will find their shared libs.</p></li>
1.75 rillig 2499: </ul></div>
2500: <p>
1.87 wiz 2501: </p>
1.75 rillig 2502: </li>
1.88 wiz 2503: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2504: of debugging output which is displayed whilst making and
2505: installing the package. The default value for this is 0,
2506: which will not display the commands as they are executed
2507: (normal, default, quiet operation); the value 1 will display
2508: all shell commands before their invocation, and the value 2
2509: will display both the shell commands before their invocation,
2510: and their actual execution progress with <span><strong class="command">set
2511: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2512: </ul></div>
2513: <p>
2514: </p>
2515: </div>
2516: <div class="sect1" lang="en">
2517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78 rillig 2518: <a name="selecting-build-options"></a>5.5. Selecting Build Options</h2></div></div></div>
1.88 wiz 2519: <p>Some packages have build time options, usually to select
2520: between different dependencies, enable optional support for big
2521: dependencies or enable experimental features.</p>
1.75 rillig 2522: <p>To see which options, if any, a package supports, and which
1.88 wiz 2523: options are mutually exclusive, run <span><strong class="command">make
2524: show-options</strong></span>, for example:</p>
1.75 rillig 2525: <pre class="programlisting">
2526: The following options are supported by this package:
2527: ssl Enable SSL support.
2528: Exactly one of the following gecko options is required:
2529: firefox Use firefox as gecko rendering engine.
2530: mozilla Use mozilla as gecko rendering engine.
2531: At most one of the following database options may be selected:
2532: mysql Enable support for MySQL database.
2533: pgsql Enable support for PostgreSQL database.
1.1 grant 2534:
1.75 rillig 2535: These options are enabled by default: firefox
2536: These options are currently enabled: mozilla ssl
1.1 grant 2537: </pre>
1.75 rillig 2538: <p>The following variables can be defined in
1.88 wiz 2539: <code class="filename">/etc/mk.conf</code> to select which options to
2540: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2541: which can be used to select or disable options for all packages
2542: that support them, and
2543: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2544: which can be used to select or disable options specifically for
2545: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2546: these variables are selected, options preceded by “<span class="quote">-</span>”
2547: are disabled. A few examples:</p>
1.75 rillig 2548: <pre class="screen">
2549: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" /etc/mk.conf</strong></span>
2550: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2551: PKG_OPTIONS.kdebase= debug -sasl
2552: PKG_OPTIONS.apache= suexec </pre>
1.88 wiz 2553: <p>The following settings are consulted in the order given, and
2554: the last setting that selects or disables an option is
2555: used:</p>
1.75 rillig 2556: <div class="orderedlist"><ol type="1">
2557: <li><p>the default options as suggested by the package
1.88 wiz 2558: maintainer</p></li>
1.75 rillig 2559: <li><p>the options implied by the settings of legacy
1.88 wiz 2560: variables (see below)</p></li>
1.75 rillig 2561: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2562: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2563: </ol></div>
2564: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2565: selected is used, all others are automatically disabled. If an
2566: option of the group is explicitly disabled, the previously
2567: selected option, if any, is used. It is an error if no option
2568: from a required group of options is selected, and building the
2569: package will fail.</p>
2570: <p>Before the options framework was introduced, build options
2571: were selected by setting a variable (often named
2572: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
2573: <code class="filename">/etc/mk.conf</code> for each option. To ease
2574: transition to the options framework for the user, these legacy
2575: variables are converted to the appropriate options setting
2576: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2577: automatically. A warning is issued to prompt the user to update
2578: <code class="filename">/etc/mk.conf</code> to use the options framework
2579: directly. Support for the legacy variables will be removed
2580: eventually.</p>
1.75 rillig 2581: </div>
2582: </div>
2583: <div class="chapter" lang="en">
2584: <div class="titlepage"><div><div><h2 class="title">
2585: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2586: <div class="toc">
2587: <p><b>Table of Contents</b></p>
2588: <dl>
2589: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2590: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2591: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
2592: <dd><dl>
2593: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
2594: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
2595: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
2596: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
2597: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
2598: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2599: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
2600: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
2601: </dl></dd>
2602: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2603: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
2604: </dl>
2605: </div>
2606: <div class="sect1" lang="en">
2607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2608: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2609: <p>Once you have built and installed a package, you can create
2610: a <span class="emphasis"><em>binary package</em></span> which can be installed on
2611: 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
2612: the same package on a group of hosts and wasting CPU time. It also
2613: provides a simple means for others to install your package, should
2614: you distribute it.</p>
2615: <p>To create a binary package, change into the appropriate
2616: directory in pkgsrc, and run <span><strong class="command">make
2617: package</strong></span>:</p>
2618: <pre class="screen">
2619: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2620: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2621: </pre>
2622: <p>This will build and install your package (if not already done),
2623: and then build a binary package from what was installed. You can
2624: then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
2625: it. Binary packages are created by default in
2626: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2627: gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2628: 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 2629: <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 2630: such a binary package.</p>
1.75 rillig 2631: </div>
2632: <div class="sect1" lang="en">
2633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2634: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90 rillig 2635: <p>See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, “Other helpful targets”</a>.</p>
1.75 rillig 2636: </div>
2637: <div class="sect1" lang="en">
2638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2639: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
2640: <p>If you want to get a full set of precompiled binary
1.87 wiz 2641: packages, this section describes how to get them. Beware that
2642: the bulk build will remove all currently installed packages from
2643: your system!</p>
1.75 rillig 2644: <p>Having an FTP server configured either on the
1.87 wiz 2645: machine doing the bulk builds or on a nearby NFS server can help
2646: to make the packages available to other machines that can then
2647: 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
2648: more information. If you use a remote NFS server's storage, be
2649: sure to not actually compile on NFS storage, as this slows
2650: things down a lot.</p>
1.75 rillig 2651: <div class="sect2" lang="en">
2652: <div class="titlepage"><div><div><h3 class="title">
2653: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
2654: <div class="sect3" lang="en">
2655: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 2656: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code>
2657: </h4></div></div></div>
1.76 rillig 2658: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2659: configuration file for bulk builds. You can configure how your
2660: copy of pkgsrc is kept up to date, how the distfiles are
2661: downloaded, how the packages are built and how the report is
2662: generated. You can find an annotated example file in
2663: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2664: it, copy <code class="filename">build.conf-example</code> to
2665: <code class="filename">build.conf</code> and edit it, following the
2666: comments in that file.</p>
1.75 rillig 2667: </div>
2668: <div class="sect3" lang="en">
2669: <div class="titlepage"><div><div><h4 class="title">
2670: <a name="binary.mk.conf"></a>6.3.1.2. /etc/mk.conf</h4></div></div></div>
2671: <p>You may want to set variables in
1.87 wiz 2672: <code class="filename">/etc/mk.conf</code>.
2673: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2674: details of the default settings. You will want to ensure that
2675: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2676: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
2677: accepts <span class="emphasis"><em>all</em></span> licenses.</p>
2678: <pre class="programlisting">
2679: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2680: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2681: BSDSRCDIR= /usr/src
2682: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2683: OBJHOSTNAME?= yes # use work.`hostname`
2684: FAILOVER_FETCH= yes # insist on the correct checksum
2685: PKG_DEVELOPER?= yes
2686: _ACCEPTABLE= yes
2687: </pre>
1.75 rillig 2688: <p>Some options that are especially useful for bulk builds
2689: can be found at the top lines of the file
1.76 rillig 2690: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2691: options of these are briefly described here.</p>
2692: <div class="itemizedlist"><ul type="disc">
2693: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2694: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2695: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2696: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2697: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2698: to the directory where all log files are created. Otherwise the
2699: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2700: <li><p>Another important variable is
1.87 wiz 2701: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2702: should be always available while building other
2703: packages.</p></li>
1.75 rillig 2704: </ul></div>
2705: <p>Some other options are scattered in the pkgsrc
2706: infrastructure:</p>
2707: <div class="itemizedlist"><ul type="disc">
2708: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2709: should be set to <code class="literal">yes</code>. The purpose of the bulk
2710: builds is creating binary packages, no matter if they are
2711: vulnerable or not. When uploading the packages to a public
2712: server, the vulnerable packages will be put into a directory of
2713: their own. Leaving this variable unset would prevent the bulk
2714: build system from even trying to build them, so possible
2715: building errors would not show up.</p></li>
1.75 rillig 2716: <li><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2717: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87 wiz 2718: “<span class="quote">yes</span>” to check that the installed set of files
2719: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2720: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2721: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87 wiz 2722: “<span class="quote">yes</span>” to check that the installed
2723: “<span class="quote">#!</span>”-scripts will find their
2724: interpreter.</p></li>
1.91 rillig 2725: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2726: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2727: package's self-test before installing it. Note that some
2728: packages make heavy use of “<span class="quote">good</span>” random
2729: numbers, so you need to assure that the machine on which you
2730: are doing the bulk builds is not completely idle. Otherwise
2731: some test programs will seem to hang, while they are just
2732: waiting for new random data to be
2733: available.</p></li>
1.75 rillig 2734: </ul></div>
2735: </div>
2736: <div class="sect3" lang="en">
2737: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 2738: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
2739: </h4></div></div></div>
1.75 rillig 2740: <p>It is possible to configure the bulk build to perform
1.87 wiz 2741: certain site-specific tasks at the end of the pre-build
2742: stage. If the file
2743: <code class="filename">pre-build.local</code> exists in
2744: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2745: (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
2746: stage. An example use of
2747: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2748: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2749: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2750: <p>to prevent the system from trying to build a particular package
1.87 wiz 2751: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2752: </div>
2753: </div>
2754: <div class="sect2" lang="en">
2755: <div class="titlepage"><div><div><h3 class="title">
2756: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2757: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2758: deleted at the start of bulk builds, make sure your login
2759: shell is placed somewhere else. Either drop it into
2760: <code class="filename">/usr/local/bin</code> (and adjust your login
2761: shell in the passwd file), or (re-)install it via
2762: <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
2763: you can login after a reboot (remember that your current
2764: process won't die if the package is removed, you just can't
2765: start any new instances of the shell any more). Also, if you
2766: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2767: version of ssh for some reason, be sure to install ssh before
2768: starting it from <code class="filename">rc.local</code>:</p>
2769: <pre class="programlisting">
2770: ( cd /usr/pkgsrc/security/ssh ; make bulk-install )
2771: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2772: /usr/pkg/etc/rc.d/sshd
2773: fi
2774: </pre>
1.75 rillig 2775: <p>Not doing so will result in you being not able to log in
1.87 wiz 2776: via ssh after the bulk build is finished or if the machine
2777: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2778: </div>
2779: <div class="sect2" lang="en">
2780: <div class="titlepage"><div><div><h3 class="title">
2781: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
2782: <p>Make sure you don't need any of the packages still
1.87 wiz 2783: installed.</p>
1.75 rillig 2784: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2785: <h3 class="title">Warning</h3>
2786: <p>During the bulk build, <span class="emphasis"><em>all packages will be
1.87 wiz 2787: removed!</em></span></p>
1.75 rillig 2788: </div>
2789: <p>Be sure to remove all other things that might
1.87 wiz 2790: interfere with builds, like some libs installed in
2791: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2792: <pre class="screen">
2793: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2794: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2795: </pre>
1.75 rillig 2796: <p>If for some reason your last build didn't complete (power
1.87 wiz 2797: failure, system panic, ...), you can continue it by
2798: running:</p>
1.75 rillig 2799: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2800: <p>At the end of the bulk build, you will get a summary via mail,
2801: and find build logs in the directory specified by
2802: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2803: file.</p>
1.75 rillig 2804: </div>
2805: <div class="sect2" lang="en">
2806: <div class="titlepage"><div><div><h3 class="title">
2807: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
2808: <p>The bulk builds consist of three steps:</p>
2809: <div class="variablelist"><dl>
2810: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2811: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2812: cleans out any broken distfiles, and removes all
2813: packages installed.</p></dd>
1.75 rillig 2814: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2815: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2816: an optimised order in which packages will be
2817: built. Packages that don't require other packages will
2818: be built first, and packages with many dependencies will
2819: be built later.</p></dd>
1.75 rillig 2820: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2821: <dd><p>Generates a report that's placed in the directory
2822: specified in the <code class="filename">build.conf</code> file
2823: named <code class="filename">broken.html</code>, a short version
2824: of that report will also be mailed to the build's
2825: admin.</p></dd>
1.75 rillig 2826: </dl></div>
1.87 wiz 2827: <p>During the build, a list of broken packages will be compiled
2828: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2829: <code class="filename">.../.broken.${MACHINE}</code> if
2830: <code class="varname">OBJMACHINE</code> is set), individual build logs
2831: of broken builds can be found in the package's
2832: directory. These files are used by the bulk-targets to mark
2833: broken builds to not waste time trying to rebuild them, and
2834: they can be used to debug these broken package builds
2835: later.</p>
1.75 rillig 2836: </div>
2837: <div class="sect2" lang="en">
2838: <div class="titlepage"><div><div><h3 class="title">
2839: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
2840: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2841: NetBSD 2.0/i386:</p>
1.75 rillig 2842: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2843: <li><p>10 GB - distfiles (NFS ok)</p></li>
2844: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2845: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2846: </ul></div>
2847: <p>Note that all pkgs will be de-installed as soon as they are
2848: turned into a binary package, and that sources are removed,
2849: so there is no excessively huge demand to disk
2850: space. Afterwards, if the package is needed again, it will
2851: 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
2852: there are no cycles wasted by recompiling.</p>
1.75 rillig 2853: </div>
2854: <div class="sect2" lang="en">
2855: <div class="titlepage"><div><div><h3 class="title">
2856: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2857: <p>If you don't want all the packages nuked from a machine
2858: (rendering it useless for anything but pkg compiling), there
2859: is the possibility of doing the package bulk build inside a
2860: chroot environment.</p>
2861: <p>The first step is to set up a chroot sandbox,
2862: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2863: using null mounts, or manually.</p>
2864: <p>There is a shell script called
2865: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2866: up the sandbox environment using null mounts. It will also
2867: create a script called <code class="filename">sandbox</code> in the
2868: root of the sandbox environment, which will allow the null
2869: mounts to be activated using the <span><strong class="command">sandbox
2870: mount</strong></span> command and deactivated using the
2871: <span><strong class="command">sandbox umount</strong></span> command.</p>
2872: <p>To set up a sandbox environment by hand, after extracting all
2873: the sets from a NetBSD installation or doing a <span><strong class="command">make
2874: distribution DESTDIR=/usr/sandbox</strong></span> in
2875: <code class="filename">/usr/src/etc</code>, be sure the following items
2876: are present and properly configured:</p>
1.75 rillig 2877: <div class="procedure"><ol type="1">
2878: <li>
2879: <p>Kernel</p>
2880: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2881: </li>
2882: <li>
1.76 rillig 2883: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2884: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2885: </li>
2886: <li>
1.91 rillig 2887: <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 2888: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2889: </li>
2890: <li>
2891: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2892: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2893: </li>
2894: <li>
1.91 rillig 2895: <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 2896: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2897: </li>
2898: <li>
1.76 rillig 2899: <p><code class="filename">/usr/src</code> (system sources,
1.91 rillig 2900: 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 2901: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2902: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2903: </li>
2904: <li>
1.76 rillig 2905: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2906: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2907: </li>
2908: <li>
1.76 rillig 2909: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2910: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2911: </li>
2912: <li>
2913: <p>Checkout pkgsrc via cvs into
1.87 wiz 2914: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2915: <pre class="screen">
2916: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2917: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2918: </pre>
1.75 rillig 2919: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2920: you do development in, as this will likely cause problems!</p>
1.75 rillig 2921: </li>
2922: <li><p>Make
1.87 wiz 2923: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2924: <code class="filename">.../distfiles</code> point somewhere
2925: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.76 rillig 2926: <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>
2927: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2928: </ol></div>
2929: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2930: the build with the following steps:</p>
2931: <pre class="screen">
2932: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2933: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2934: </pre>
2935: <p>This will just jump inside the sandbox and start building. At
2936: the end of the build, mail will be sent with the results of
2937: the build. Created binary pkgs will be in
2938: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2939: (wherever that points/mounts to/from).</p>
1.75 rillig 2940: </div>
2941: <div class="sect2" lang="en">
2942: <div class="titlepage"><div><div><h3 class="title">
2943: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2944: <p>In addition to building a complete set of all packages in
2945: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2946: may be used to build a subset of the packages contained in
2947: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
2948: in <code class="filename">/etc/mk.conf</code>, the variables</p>
1.75 rillig 2949: <div class="itemizedlist"><ul type="disc">
2950: <li><p>SITE_SPECIFIC_PKGS</p></li>
2951: <li><p>HOST_SPECIFIC_PKGS</p></li>
2952: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2953: <li><p>USER_SPECIFIC_PKGS</p></li>
2954: </ul></div>
1.87 wiz 2955: <p>will define the set of packages which should be built.
2956: The bulk build code will also include any packages which are
2957: needed as dependencies for the explicitly listed packages.</p>
2958: <p>One use of this is to do a bulk build with
2959: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2960: periodically to have a complete set of the binary packages
2961: needed for your site available without the overhead of
2962: building extra packages that are not needed.</p>
1.75 rillig 2963: </div>
2964: <div class="sect2" lang="en">
2965: <div class="titlepage"><div><div><h3 class="title">
2966: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2967: <p>This section describes how pkgsrc developers can upload binary
2968: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2969: <p>If you would like to automatically create checksum files for the
2970: binary packages you intend to upload, remember to set
2971: <code class="varname">MKSUMS=yes</code> in your
2972: <code class="filename">mk/bulk/build.conf</code>.</p>
2973: <p>If you would like to PGP sign the checksum files (highly
2974: recommended!), remember to set
2975: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2976: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2977: your GPG password to sign the files before uploading everything.</p>
2978: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2979: set properly in your <code class="filename">mk/bulk/build.conf</code>
2980: file, i.e. adjust it to something like one of the following:</p>
1.93 rillig 2981: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
2982: <p>Please use appropriate values for "packages-200xQy",
1.87 wiz 2983: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2984: is different from your local login, write your login directly
2985: into the variable, e.g. my local account is "feyrer", but for my
2986: login "hubertf", I use:</p>
1.93 rillig 2987: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 2988: <p>A separate <code class="filename">upload</code> directory is used
2989: here to allow "closing" the directory during upload. To do
2990: so, run the following command on ftp.NetBSD.org next:</p>
1.93 rillig 2991: <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 2992: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2993: only appropriate for packages for the NetBSD operating
2994: system. Binary packages for other operating systems should go
2995: into <code class="filename">/pub/pkgsrc</code>.</p>
2996: <p>Before uploading the binary pkgs, ssh authentication needs
2997: to be set up. This example shows how to set up temporary keys
2998: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2999: (assuming that no keys should be present there usually):</p>
3000: <pre class="screen">
3001: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 3002: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
3003: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 3004: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
3005: </pre>
3006: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
3007: append it to your <code class="filename">~/.ssh/authorized_keys</code>
3008: file on ftp.NetBSD.org. You can remove the key after the
3009: upload is done!</p>
3010: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 3011: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 3012: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
3013: <p>Now after all this works, you can exit the sandbox and start
3014: the upload:</p>
3015: <pre class="screen">
3016: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 3017: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 3018: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3019: </pre>
3020: <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
3021: <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
3022: upload. The upload script will take care of not uploading
3023: restricted packages and putting vulnerable packages into the
3024: <code class="filename">vulnerable</code> subdirectory.</p>
3025: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 3026: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 3027: Gdd:x! </pre>
3028: <p>Use whatever is needed to remove the key you've entered
3029: before! Last, move the uploaded packages out of the
3030: <code class="filename">upload</code> directory to have them accessible
3031: to everyone:</p>
3032: <pre class="screen">
1.93 rillig 3033: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 3034: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3035: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 3036: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
3037: </pre>
1.75 rillig 3038: </div>
3039: </div>
3040: <div class="sect1" lang="en">
3041: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3042: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 3043: <p>After your pkgsrc bulk-build has completed, you may wish to
3044: create a CD-ROM set of the resulting binary packages to assist
3045: in installing packages on other machines. The
1.91 rillig 3046: <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 3047: a simple tool for creating the ISO 9660 images.
3048: <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
3049: way that keeps all the dependencies for a given package on the same
3050: CD as that package.</p>
1.75 rillig 3051: <div class="sect2" lang="en">
3052: <div class="titlepage"><div><div><h3 class="title">
3053: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 3054: <p>Complete documentation for cdpack is found in the cdpack(1)
3055: man page. The following short example assumes that the binary
3056: packages are left in
3057: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3058: sufficient disk space exists in <code class="filename">/u2</code> to
3059: hold the ISO 9660 images.</p>
3060: <pre class="screen">
3061: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3062: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3063: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3064: </pre>
3065: <p>If you wish to include a common set of files
3066: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3067: etc.) on each CD in the collection, then you need to create a
3068: directory which contains these files. e.g.</p>
3069: <pre class="screen">
3070: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3071: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3072: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3073: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3074: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3075: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3076: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3077: </pre>
1.75 rillig 3078: <p>Now create the images:</p>
3079: <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 3080: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3081: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3082: in their root directories.</p>
1.75 rillig 3083: </div>
3084: </div>
3085: </div>
3086: <div class="chapter" lang="en">
3087: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3088: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
3089: <div class="toc">
3090: <p><b>Table of Contents</b></p>
3091: <dl>
1.91 rillig 3092: <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 3093: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
3094: </dl>
3095: </div>
3096: <p>The files that are installed by pkgsrc are organized in a way that
3097: is similar to what you find in the <code class="filename">/usr</code> directory
3098: of the base system. But some details are different. This is because
3099: pkgsrc initially came from FreeBSD and had adopted its file system
3100: hierarchy. Later it was largely influenced by NetBSD. But no matter
3101: which operating system you are using pkgsrc with, you can expect the
3102: same layout for pkgsrc.</p>
1.91 rillig 3103: <p>There are mainly four root directories for pkgsrc, which are all
3104: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3105: When pkgsrc has been installed as root, the default locations
3106: are:</p>
3107: <pre class="programlisting">
3108: LOCALBASE= /usr/pkg
3109: PKG_SYSCONFBASE= /usr/pkg/etc
3110: VARBASE= /var
1.93 rillig 3111: PKG_DBDIR= /var/db/pkg
1.91 rillig 3112: </pre>
3113: <p>In unprivileged mode (when pkgsrc has been installed as any other
3114: user), the default locations are:</p>
3115: <pre class="programlisting">
3116: LOCALBASE= ${HOME}/pkg
3117: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3118: VARBASE= ${HOME}/pkg/var
1.93 rillig 3119: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3120: </pre>
3121: <p>What these four directories are for, and what they look like is
3122: explained below.</p>
1.90 rillig 3123: <div class="itemizedlist"><ul type="disc">
3124: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3125: <code class="filename">/usr</code> directory in the base system. It is the
3126: “<span class="quote">main</span>” directory where the files are installed and contains
3127: the well-known subdirectories like <code class="filename">bin</code>,
3128: <code class="filename">include</code>, <code class="filename">lib</code>,
3129: <code class="filename">share</code> and
3130: <code class="filename">sbin</code>.</p></li>
3131: <li><p><code class="varname">VARBASE</code> corresponds to
3132: <code class="filename">/var</code> in the base system. Some programs (especially
3133: games, network daemons) need write access to it during normal
3134: operation.</p></li>
3135: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3136: <code class="filename">/etc</code> in the base system. It contains configuration
3137: files of the packages, as well as pkgsrc's <code class="filename">mk.conf</code>
3138: itself.</p></li>
3139: </ul></div>
3140: <div class="sect1" lang="en">
3141: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 3142: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code>
3143: </h2></div></div></div>
1.90 rillig 3144: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3145: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3146: <div class="variablelist"><dl>
3147: <dt><span class="term"><code class="filename">bin</code></span></dt>
3148: <dd><p>Contains executable programs that are intended to be
3149: directly used by the end user.</p></dd>
3150: <dt><span class="term"><code class="filename">emul</code></span></dt>
3151: <dd><p>Contains files for the emulation layers of various other
3152: operating systems, especially for
3153: NetBSD.</p></dd>
3154: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3155: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3156: <dd><p>Contains
3157: the configuration files.</p></dd>
3158: <dt><span class="term"><code class="filename">include</code></span></dt>
3159: <dd><p>Contains headers for the C and C++ programming
3160: languages.</p></dd>
3161: <dt><span class="term"><code class="filename">info</code></span></dt>
3162: <dd><p>Contains GNU info files of various
3163: packages.</p></dd>
3164: <dt><span class="term"><code class="filename">lib</code></span></dt>
3165: <dd><p>Contains shared and static
3166: libraries.</p></dd>
3167: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3168: <dd><p>Contains data files that don't change after
3169: installation. Other data files belong into
3170: <code class="filename">${VARBASE}</code>.</p></dd>
3171: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3172: <dd><p>Contains programs that are not intended to be used by
3173: end users, such as helper programs or network
3174: daemons.</p></dd>
3175: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3176: <dd><p>Contains programs that are intended to be executed as
3177: CGI scripts by a web server.</p></dd>
3178: <dt><span class="term"><code class="filename">man</code> (the usual value of
3179: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3180: <dd><p>Contains brief
3181: documentation in form of manual pages.</p></dd>
3182: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3183: <dd><p>Contains programs that are intended to be used only by
3184: the super-user.</p></dd>
3185: <dt><span class="term"><code class="filename">share</code></span></dt>
3186: <dd><p>Contains platform-independent data files that don't
3187: change after installation.</p></dd>
3188: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3189: <dd><p>Contains documentation files provided by the
3190: packages.</p></dd>
3191: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3192: <dd><p>Contains example files provided by the packages. Among
3193: others, the original configuration files are saved here and copied to
3194: <code class="filename">${PKG_SYSCONFDIR}</code> during
3195: installation.</p></dd>
3196: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3197: <dd><p>Contains the original files for rc.d
3198: scripts.</p></dd>
3199: <dt><span class="term"><code class="filename">var</code> (the usual location of
3200: <code class="filename">${VARBASE}</code>)</span></dt>
3201: <dd><p>Contains files
3202: that may be modified after
3203: installation.</p></dd>
3204: </dl></div>
3205: </div>
3206: <div class="sect1" lang="en">
3207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 3208: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code>
3209: </h2></div></div></div>
1.90 rillig 3210: <div class="variablelist"><dl>
3211: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3212: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3213: <dd><p>Contains
3214: information about the currently installed
3215: packages.</p></dd>
3216: <dt><span class="term"><code class="filename">games</code></span></dt>
3217: <dd><p>Contains highscore
3218: files.</p></dd>
3219: <dt><span class="term"><code class="filename">log</code></span></dt>
3220: <dd><p>Contains log files.</p></dd>
3221: <dt><span class="term"><code class="filename">run</code></span></dt>
3222: <dd><p>Contains informational files about daemons that are
3223: currently running.</p></dd>
3224: </dl></div>
3225: </div>
3226: </div>
3227: <div class="chapter" lang="en">
3228: <div class="titlepage"><div><div><h2 class="title">
3229: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3230: <div class="toc">
3231: <p><b>Table of Contents</b></p>
3232: <dl>
1.90 rillig 3233: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3234: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
3235: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
3236: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
3237: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
3238: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
3239: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
3240: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
3241: <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>
3242: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
3243: <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 3244: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 3245: <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>
3246: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
3247: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
3248: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
3249: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3250: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
3251: <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 3252: </dl>
3253: </div>
3254: <p>This section contains hints, tips & tricks on special things in
3255: pkgsrc that we didn't find a better place for in the previous chapters, and
3256: it contains items for both pkgsrc users and developers.</p>
3257: <div class="sect1" lang="en">
3258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3259: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3260: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3261: <div class="itemizedlist"><ul type="disc">
1.78 rillig 3262: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
3263: This is a general purpose list for most issues regarding
3264: pkgsrc, regardless of platform, e.g. soliciting user help
3265: for pkgsrc configuration, unexpected build failures, using
3266: particular packages, upgrading pkgsrc installations,
3267: questions regarding the pkgsrc release branches, etc. General announcements or
3268: proposals for changes that impact the pkgsrc user community,
3269: e.g. major infrastructure changes, new features, package
3270: removals, etc., may also be posted.</p></li>
1.75 rillig 3271: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
3272: A list where the results of pkgsrc bulk builds are sent and
3273: discussed.</p></li>
3274: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
3275: This list is for those who are interested in getting a
3276: commit message for every change committed to pkgsrc. It is
3277: also available in digest form, meaning one daily message
3278: containing all commit messages for changes to the package
3279: source tree in that 24 hour period.</p></li>
3280: </ul></div>
3281: <p>To subscribe, do:</p>
3282: <pre class="programlisting">
3283: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3284: </pre>
3285: <p>Archives for all these mailing lists are available from
3286: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3287: </div>
3288: <div class="sect1" lang="en">
3289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3290: <a name="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3291: <p>Pkgviews is tightly integrated with buildlink. You can find a
3292: pkgviews User's guide in
1.76 rillig 3293: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3294: </div>
3295: <div class="sect1" lang="en">
3296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3297: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3298: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3299: a number of useful utilities for both users and developers of pkgsrc. This
3300: section attempts only to make the reader aware of the utilities and when
3301: they might be useful, and not to duplicate the documentation that comes
3302: with each package.</p>
3303: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 rillig 3304: <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 3305: Symlinks for use by buildlink.</p></li></ul></div>
3306: <p>OS tool augmentation (automatically installed when needed):</p>
3307: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3308: <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 3309: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 rillig 3310: <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 3311: Compatibility library for pkgsrc tools.</p></li>
1.91 rillig 3312: <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 3313: non-BSD systems due to lack of native mtree.</p></li>
1.91 rillig 3314: <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 3315: Up-to-date replacement for
1.76 rillig 3316: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3317: systems where pkg_install is not present.</p></li>
3318: </ul></div>
3319: <p>Utilities used by pkgsrc (not automatically installed):</p>
3320: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3321: <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 3322: Create a binary package from an
3323: already-installed package. Used by <span><strong class="command">make replace</strong></span> to
3324: save the old package.</p></li>
1.91 rillig 3325: <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 3326: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3327: from multiple locations. It currently supports the following
3328: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 rillig 3329: <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 3330: packages someplace else (enabled by default).</p></li>
1.91 rillig 3331: <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 3332: best compiler flags to optimise code for your current CPU and
3333: compiler.</p></li>
3334: </ul></div>
3335: <p>Utilities for keeping track of installed packages, being up to date,
3336: etc:</p>
3337: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3338: <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 3339: packages whose installed versions do not match the latest pkgsrc
3340: entries.</p></li>
1.91 rillig 3341: <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 3342: dependency graphs of packages, to aid in choosing a strategy for
3343: updating.</p></li>
1.91 rillig 3344: <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
3345: 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>
3346: <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 3347: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3348: does various checks on the complete pkgsrc system.</p></li>
1.91 rillig 3349: <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 3350: packages you have installed.</p></li>
3351: </ul></div>
3352: <p>Utilities for people maintaining or creating individual packages:</p>
3353: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3354: <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 3355: making and maintaining patches for a package (includes pkgdiff,
3356: pkgvi, mkpatches, etc.).</p></li>
1.91 rillig 3357: <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>,
3358: <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 3359: converting to pkgsrc.</p></li>
1.91 rillig 3360: <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 3361: pkgsrc to a Solaris package.</p></li>
3362: </ul></div>
3363: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3364: utilities)</p>
3365: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3366: <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 3367: packages in a chrooted area.</p></li>
1.91 rillig 3368: <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 3369: kernel version for chrooted cross builds.</p></li>
3370: </ul></div>
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="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3375: <p>If you want to use pkgsrc as non-root user, you can set some
3376: variables to make pkgsrc work under these conditions. At the very least,
3377: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3378: will turn on unprivileged mode and set multiple related variables to allow
3379: installation of packages as non-root.</p>
3380: <p>In case the defaults are not enough, you may want to tune some other
3381: variables used. For example, if the automatic user/group detection leads
3382: to incorrect values (or not the ones you would like to use), you can change
3383: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3384: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3385: <p>As regards bootstrapping, please note that the
3386: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
3387: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3388: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3389: installation targets. These directories can be overridden by the
1.75 rillig 3390: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3391: that allow finer tuning of the tree layout.</p>
3392: </div>
3393: <div class="sect1" lang="en">
3394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3395: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3396: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3397: enable this feature by adding the option
3398: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.76 rillig 3399: <code class="filename">/etc/mk.conf</code>. If, during a fetch step, an incomplete
1.75 rillig 3400: distfile is found, pkgsrc will try to resume it.</p>
3401: <p>You can also
3402: 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
3403: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3404: <code class="varname">FETCH_RESUME_ARGS</code> and
3405: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3406: values.</p>
3407: <p>For example, if you want to use
1.76 rillig 3408: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75 rillig 3409: like:</p>
3410: <pre class="programlisting">
3411: FETCH_CMD= wget
3412: FETCH_BEFORE_ARGS= --passive-ftp
3413: FETCH_RESUME_ARGS= -c
3414: FETCH_OUTPUT_ARGS= -O
1.1 grant 3415: </pre>
1.75 rillig 3416: </div>
3417: <div class="sect1" lang="en">
3418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3419: <a name="XFree86-from-pkgsrc"></a>8.6. How can I install/use XFree86 from pkgsrc?</h2></div></div></div>
1.75 rillig 3420: <p>If you want to use XFree86 from pkgsrc instead of your system's own
1.76 rillig 3421: X11 (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>,
1.75 rillig 3422: ...), you will have to add the following line into
1.76 rillig 3423: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3424: <pre class="programlisting">
3425: X11_TYPE=XFree86
1.1 grant 3426: </pre>
1.75 rillig 3427: </div>
3428: <div class="sect1" lang="en">
3429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3430: <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 3431: <p>If you want to use X.org from pkgsrc instead of your system's own X11
1.76 rillig 3432: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3433: you will have to add the following line into
1.76 rillig 3434: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3435: <pre class="programlisting">
3436: X11_TYPE=xorg
1.1 grant 3437: </pre>
1.75 rillig 3438: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3439: <h3 class="title">Note</h3>
3440: <p>The DragonFly operating system defaults to using
1.87 wiz 3441: this X.org X11 implementation from pkgsrc.</p>
1.75 rillig 3442: </div>
3443: </div>
3444: <div class="sect1" lang="en">
3445: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3446: <a name="fetch-behind-firewall"></a>8.8. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3447: <p>If you are sitting behind a firewall which does not allow direct
3448: connections to Internet hosts (i.e. non-NAT), you may specify the
3449: relevant proxy hosts. This is done using an environment variable in the
3450: form of a URL, e.g. in Amdahl, the machine
3451: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3452: port 80 as the proxy port number. So the proxy environment variables
3453: are:</p>
3454: <pre class="programlisting">
3455: ftp_proxy=ftp://orpheus.amdahl.com:80/
3456: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3457: </pre>
1.75 rillig 3458: </div>
3459: <div class="sect1" lang="en">
3460: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3461: <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 3462: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3463: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3464: the first available command from the following list:</p>
3465: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3466: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3467: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3468: </ul></div>
3469: <p>On a default NetBSD installation, this will be
1.76 rillig 3470: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3471: connections first, and falls back to active connections if the server
3472: refuses to do passive. For the other tools, add the following to your
1.76 rillig 3473: <code class="filename">/etc/mk.conf</code> file:
1.75 rillig 3474: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3475: <p>Having that option present will prevent
1.76 rillig 3476: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3477: transfers.</p>
3478: </div>
3479: <div class="sect1" lang="en">
3480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3481: <a name="fetching-all-distfiles"></a>8.10. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3482: <p>You would like to download all the distfiles in a single batch
3483: from work or university, where you can't run a <span><strong class="command">make
3484: 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 3485: but downloading the entire directory may not be appropriate.</p>
3486: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76 rillig 3487: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3488: resulting list to your machine at work/school and use it there. If you
3489: 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
3490: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3491: URL:</p>
3492: <p>At home:</p>
3493: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3494: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3495: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3496: <p>At work:</p>
3497: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3498: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3499: home.</p>
3500: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3501: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3502: machine architecture), you can do so by using the above-mentioned
3503: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
3504: directly by running:</p>
1.75 rillig 3505: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3506: <p>If you even decide to ignore
3507: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3508: by running:</p>
3509: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3510: </div>
3511: <div class="sect1" lang="en">
3512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3513: <a name="tmac.andoc-missing"></a>8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 3514: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 rillig 3515: <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 3516: package, you get the error from make that it doesn't know how to make
1.76 rillig 3517: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3518: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3519: the NetBSD base distribution on your machine. It is recommended to do
3520: that to format man pages.</p>
1.91 rillig 3521: <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 3522: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.76 rillig 3523: environment or in <code class="filename">/etc/mk.conf</code>.</p>
1.75 rillig 3524: </div>
3525: <div class="sect1" lang="en">
3526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3527: <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 3528: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3529: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3530: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3531: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3532: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3533: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.75 rillig 3534: the one that corresponds to your release (determine via <span><strong class="command">uname
3535: -r</strong></span>).</p>
3536: </div>
3537: <div class="sect1" lang="en">
3538: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3539: <a name="using-sudo-with-pkgsrc"></a>8.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3540: <p>When installing packages as non-root user and using the just-in-time
3541: <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
3542: password for each required package installed. To avoid this, the sudo
3543: package can be used, which does password caching over a limited time. To
3544: use it, install sudo (either as binary package or from
1.98 ! wiz 3545: <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
! 3546: following into your <code class="filename">/etc/mk.conf</code>, somewhere
! 3547: <span class="emphasis"><em>after</em></span> the definition of the
! 3548: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3549: <pre class="programlisting">
3550: .if exists(${LOCALBASE}/bin/sudo)
3551: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3552: .endif
1.1 grant 3553: </pre>
1.75 rillig 3554: </div>
3555: <div class="sect1" lang="en">
3556: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3557: <a name="faq.conf"></a>8.14. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3558: <p>As the system administrator, you can choose where configuration files
3559: are installed. The default settings make all these files go into
1.76 rillig 3560: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3561: be suboptimal depending on your expectations (e.g., a read-only,
3562: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3563: configuration of the provided packages).</p>
3564: <p>In order to change the defaults, you can modify the
3565: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.76 rillig 3566: <code class="filename">/etc/mk.conf</code>) to point to your preferred configuration
3567: directory; some common examples include <code class="filename">/etc</code> or
3568: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3569: <p>Furthermore, you can change this value on a per-package basis by
3570: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3571: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3572: package you would like to modify, that is, the contents of
3573: <code class="varname">PKGBASE</code>.</p>
3574: <p>Note that after changing these settings, you must rebuild and
3575: reinstall any affected packages.</p>
3576: </div>
3577: <div class="sect1" lang="en">
3578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3579: <a name="audit-packages"></a>8.15. Automated security checks</h2></div></div></div>
1.75 rillig 3580: <p>Please be aware that there can often be bugs in third-party software,
3581: and some of these bugs can leave a machine vulnerable to exploitation by
3582: attackers. In an effort to lessen the exposure, the NetBSD packages team
3583: maintains a database of known-exploits to packages which have at one time
3584: been included in pkgsrc. The database can be downloaded automatically, and
3585: a security audit of all packages installed on a system can take place. To
1.91 rillig 3586: 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 3587: components:</p>
3588: <div class="orderedlist"><ol type="1">
3589: <li>
3590: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
3591: download a list of the security vulnerabilities information. This list
3592: is kept up to date by the NetBSD security officer and the NetBSD
3593: packages team, and is distributed from the NetBSD ftp server:</p>
3594: <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>
3595: </li>
3596: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
3597: current machine, checking each vulnerability which is known. If a
3598: vulnerable package is installed, it will be shown by output to stdout,
3599: including a description of the type of vulnerability, and a URL
3600: containing more information.</p></li>
3601: </ol></div>
1.91 rillig 3602: <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 3603: package is strongly recommended! After
3604: “<span class="quote">audit-packages</span>” is installed, please read
3605: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3606: audit-packages</code></strong>.</p>
1.87 wiz 3607: <p>If this package is installed, pkgsrc builds will use it to
3608: 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
3609: check.</p>
1.75 rillig 3610: </div>
3611: <div class="sect1" lang="en">
3612: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3613: <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 3614: <p>When you add your own preferences to the
3615: <code class="varname">CFLAGS</code> variable in your
1.76 rillig 3616: <code class="filename">mk.conf</code>, these flags are passed in
3617: environment variables to the <code class="filename">./configure</code>
1.75 rillig 3618: 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
3619: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3620: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3621: package.</p>
3622: <p>Currently there is no solution to this problem. If you
3623: really need the package to use your <code class="varname">CFLAGS</code>
3624: you should run <span><strong class="command">make patch</strong></span> in the package
1.76 rillig 3625: directory and then inspect any <code class="filename">Makefile</code> and
3626: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3627: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3628: these lines. But be aware that some “<span class="quote">smart</span>”
3629: programmers write so bad code that it only works for the
3630: specific combination of <code class="varname">CFLAGS</code> they have
3631: chosen.</p>
3632: </div>
1.80 rillig 3633: <div class="sect1" lang="en">
3634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3635: <a name="ufaq-fail"></a>8.17. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3636: <div class="procedure"><ol type="1">
3637: <li><p>Make sure that your copy of pkgsrc is consistent. A
3638: case that occurs often is that people only update pkgsrc in
3639: parts, because of performance reasons. Since pkgsrc is one large
3640: system, not a collection of many small systems, there are
3641: sometimes changes that only work when the whole pkgsrc tree is
3642: updated.</p></li>
3643: <li><p>Make sure that you don't have any CVS conflicts.
3644: Search for “<span class="quote"><<<<<<</span>” or
3645: “<span class="quote">>>>>>></span>” in all your pkgsrc
3646: files.</p></li>
3647: <li><p>Make sure that you don't have old copies of the packages
3648: extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
3649: verify this.</p></li>
3650: <li><p>If the problem still exists, write a mail to the
3651: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3652: </ol></div>
3653: </div>
1.88 wiz 3654: <div class="sect1" lang="en">
3655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3656: <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 3657: <p>You have modified a file from pkgsrc, and someone else has
3658: modified that same file afterwards in the CVS repository. Both changes
3659: are in the same region of the file, so when you updated pkgsrc, the
3660: <code class="literal">cvs</code> command marked the conflicting changes in the
3661: file. Because of these markers, the file is no longer a valid
3662: <code class="filename">Makefile</code>.</p>
3663: <p>Have a look at that file, and if you don't need your local changes
3664: anymore, you can remove that file and run <span><strong class="command">cvs -q update
3665: -dP</strong></span> in that directory to download the current version.</p>
3666: </div>
1.75 rillig 3667: </div>
3668: </div>
3669: <div class="part" lang="en">
3670: <div class="titlepage"><div><div><h1 class="title">
3671: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3672: <div class="partintro" lang="en">
3673: <div></div>
3674: <p>This part of the book deals with creating and
3675: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3676: guide on creating a new package. The remaining chapters are more
3677: like a reference manual for pkgsrc.</p>
1.75 rillig 3678: <div class="toc">
3679: <p><b>Table of Contents</b></p>
3680: <dl>
1.90 rillig 3681: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3682: <dd><dl>
3683: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3684: <dd><dl>
3685: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3686: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3687: </dl></dd>
3688: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3689: <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>
3690: </dl></dd>
1.90 rillig 3691: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 3692: <dd><dl>
1.90 rillig 3693: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
3694: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
3695: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
3696: <dd><dl>
1.93 rillig 3697: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
3698: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
3699: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
3700: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
3701: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 3702: </dl></dd>
3703: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
3704: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
3705: <dd><dl>
3706: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
3707: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
3708: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
3709: </dl></dd>
3710: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
3711: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
3712: </dl></dd>
3713: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3714: <dd><dl>
1.97 rillig 3715: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
3716: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
3717: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
3718: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
3719: <dd><dl>
3720: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
3721: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
3722: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
3723: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
3724: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90 rillig 3725: </dl></dd>
3726: </dl></dd>
3727: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
3728: <dd><dl>
3729: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
3730: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3731: <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>
3732: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
3733: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
3734: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3735: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
3736: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
3737: </dl></dd>
3738: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
3739: <dd><dl>
3740: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
3741: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3742: <dd><dl>
3743: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3744: <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>
3745: </dl></dd>
3746: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3747: <dd><dl>
3748: <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>
3749: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3750: </dl></dd>
3751: </dl></dd>
3752: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
3753: <dd><dl>
3754: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
3755: <dd><dl>
3756: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
3757: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
3758: </dl></dd>
3759: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
3760: <dd><dl>
3761: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3762: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
3763: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
3764: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
3765: </dl></dd>
3766: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
3767: <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>
3768: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
3769: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
3770: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
3771: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
3772: <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>
3773: </dl></dd>
3774: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
3775: <dd><dl>
3776: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
3777: <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>
3778: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
3779: </dl></dd>
3780: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
3781: <dd><dl>
3782: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
3783: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
3784: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
3785: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
3786: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3787: <dd><dl>
3788: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
3789: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
3790: </dl></dd>
3791: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3792: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3793: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3794: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3795: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3796: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3797: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3798: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3799: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3800: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3801: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
3802: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
3803: </dl></dd>
3804: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
3805: <dd><dl>
3806: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3807: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3808: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 3809: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90 rillig 3810: </dl></dd>
3811: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
3812: <dd><dl>
3813: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
3814: <dd><dl>
3815: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
3816: <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>
3817: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
3818: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
3819: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
3820: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
3821: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
3822: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
3823: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
3824: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
3825: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3826: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3827: </dl></dd>
3828: <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>
3829: <dd><dl>
3830: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3831: <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>
3832: </dl></dd>
3833: <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>
3834: <dd><dl>
3835: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
3836: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3837: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
3838: </dl></dd>
3839: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
3840: <dd><dl>
3841: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
3842: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
3843: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
3844: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
3845: </dl></dd>
3846: <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>
3847: <dd><dl>
3848: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
3849: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
3850: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3851: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
3852: </dl></dd>
3853: <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>
3854: <dd><dl>
3855: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
3856: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
3857: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
3858: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
3859: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
3860: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
3861: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
3862: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
3863: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
3864: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
3865: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
3866: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
3867: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
3868: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
3869: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
3870: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
3871: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 3872: emulation</a></span></dt>
1.90 rillig 3873: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
3874: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77 rillig 3875: </dl></dd>
1.90 rillig 3876: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3877: </dl></dd>
1.90 rillig 3878: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
3879: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 3880: <dd><dl>
1.90 rillig 3881: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
3882: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3883: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
3884: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
3885: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
3886: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
3887: </dl></dd>
3888: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
3889: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3890: <dd><dl>
3891: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3892: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3893: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3894: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 3895: </dl></dd>
1.75 rillig 3896: </dl>
3897: </div>
1.77 rillig 3898: </div>
3899: <div class="chapter" lang="en">
3900: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3901: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3902: <div class="toc">
3903: <p><b>Table of Contents</b></p>
3904: <dl>
3905: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3906: <dd><dl>
3907: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3908: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3909: </dl></dd>
3910: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3911: <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>
3912: </dl>
3913: </div>
1.77 rillig 3914: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3915: most likely have a URL from where you can download the source
3916: code. Starting with this URL, creating a package involves only a
3917: few steps.</p>
1.77 rillig 3918: <div class="procedure"><ol type="1">
1.91 rillig 3919: <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 3920: <li><p>Then, choose one of the top-level directories as the
1.91 rillig 3921: category in which you want to place your package. You can also create a
3922: directory of your own (maybe called <code class="filename">local</code>). In that
3923: category directory, create another directory for your package and change
3924: into it.</p></li>
3925: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
3926: you for a URL. Enter the URL of the distribution file (in most cases a
3927: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3928: of your package are created automatically. The distribution file is
3929: extracted automatically to fill in some details in the
3930: <code class="filename">Makefile</code> that would otherwise have to be done
3931: manually.</p></li>
3932: <li>
3933: <p>Examine the extracted files to determine the dependencies of
3934: your package. Ideally, this is mentioned in some
3935: <code class="filename">README</code> file, but things may differ. For each of
3936: these dependencies, look where it exists in pkgsrc, and if there is a
3937: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3938: line to your package <code class="filename">Makefile</code> which includes that
3939: file just before the last line. If the
3940: <code class="filename">buildlink3.mk</code> file does not exist, add a
3941: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3942: version of the dependency and where it can be found in pkgsrc. This line
3943: should be placed in the third paragraph. If the dependency is only
3944: needed for building the package, but not when using it, use
3945: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3946: Your package may then look like this:</p>
1.77 rillig 3947: <pre class="programlisting">
3948: [...]
3949:
3950: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3951: DEPENDS+= screen-[0-9]*:../../misc/screen
3952: DEPENDS+= screen>=4.0:../../misc/screen
3953:
3954: [...]
3955:
3956: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3957: .include "../../devel/glib2/buildlink3.mk"
3958: .include "../../mk/bsd.pkg.mk"
3959: </pre>
3960: </li>
1.91 rillig 3961: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
3962: to be done to make your package a “<span class="quote">good</span>” one. If you don't
3963: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
3964: --explain</strong></span> or <span><strong class="command">pkglint
3965: -e</strong></span>, which outputs additional
3966: explanations.</p></li>
3967: <li><p>In many cases the package is not yet ready to build. You can
3968: 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
3969: over there, you can hopefully continue here.</p></li>
3970: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
3971: directory from the extracted files. Besides these files, a lot of cache
3972: files and other system information has been saved in the working
3973: directory, which may become wrong after you edited the
3974: <code class="filename">Makefile</code>.</p></li>
3975: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
3976: 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>
3977: <li><p>When the package builds fine, the next step is to install
3978: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
3979: everything works.</p></li>
3980: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
3981: contains a list of the files that are installed by the package, is
3982: nearly empty. Run <span><strong class="command">bmake print-PLIST
3983: >PLIST</strong></span> to generate a probably correct list. Check
3984: the file using your preferred text editor to see if the list of
3985: files looks plausible.</p></li>
3986: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
3987: <code class="filename">PLIST</code> contains garbage or not.</p></li>
3988: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
3989: has been registered in the database of installed files, but with an
3990: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
3991: and <span><strong class="command">bmake install</strong></span> again. Now the package is
3992: registered with the list of files from
3993: <code class="filename">PLIST</code>.</p></li>
3994: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
3995: package from the set of installed files.</p></li>
1.77 rillig 3996: </ol></div>
1.91 rillig 3997: <div class="sect1" lang="en">
3998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3999: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
4000: <div class="sect2" lang="en">
4001: <div class="titlepage"><div><div><h3 class="title">
4002: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
4003: <p>Simple Perl modules are handled automatically by
4004: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
4005: </div>
4006: <div class="sect2" lang="en">
4007: <div class="titlepage"><div><div><h3 class="title">
4008: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
4009: <p>KDE applications should always include
4010: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
4011: settings that are typical of KDE packages.</p>
4012: </div>
4013: </div>
4014: <div class="sect1" lang="en">
4015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4016: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
4017: <div class="sect2" lang="en">
4018: <div class="titlepage"><div><div><h3 class="title">
4019: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
4020: <div class="sect3" lang="en">
4021: <div class="titlepage"><div><div><h4 class="title">
4022: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
4023: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4024: that the “<span class="quote">nvu</span>” package has not yet been imported into
4025: pkgsrc. As the description says it has to do with the web, the obvious
4026: choice for the category is “<span class="quote">www</span>”.</p>
4027: <pre class="programlisting">
4028: <code class="prompt">$</code> mkdir www/nvu
4029: <code class="prompt">$</code> cd www/nvu
4030: </pre>
4031: <p>The web site says that the sources are available as a tar file, so
4032: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
4033: <pre class="programlisting">
4034: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4035: </pre>
4036: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4037: below the <code class="varname">DISTNAME</code> line, as the package name should
4038: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4039: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4040: <code class="varname">COMMENT</code> fields. Then the package
4041: <code class="filename">Makefile</code> looked like that:</p>
4042: <pre class="programlisting">
4043: # $NetBSD$
4044: #
4045:
4046: DISTNAME= nvu-1.0-sources
4047: PKGNAME= nvu-1.0
4048: CATEGORIES= www
4049: MASTER_SITES= http://cvs.nvu.com/download/
4050: EXTRACT_SUFX= .tar.bz2
4051:
4052: MAINTAINER= rillig@NetBSD.org
4053: HOMEPAGE= http://cvs.nvu.com/
4054: COMMENT= Web Authoring System
4055:
4056: # url2pkg-marker (please do not remove this line.)
4057: .include "../../mk/bsd.pkg.mk"
4058: </pre>
4059: <p>Then, I quit the editor and watched pkgsrc downloading a large
4060: source archive:</p>
4061: <pre class="programlisting">
4062: url2pkg> Running "make makesum" ...
4063: => Required installed package digest>=20010302: digest-20060826 found
4064: => Fetching nvu-1.0-sources.tar.bz2
4065: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4066: 100% |*************************************| 28992 KB 150.77 KB/s 00:00 ETA
4067: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4068: url2pkg> Running "make extract" ...
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: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4073: ===> Installing dependencies for nvu-1.0
4074: ===> Overriding tools for nvu-1.0
4075: ===> Extracting for nvu-1.0
4076: url2pkg> Adjusting the Makefile.
4077:
4078: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
4079:
4080: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
4081: </pre>
4082: </div>
4083: <div class="sect3" lang="en">
4084: <div class="titlepage"><div><div><h4 class="title">
4085: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
4086: <p>Now that the package has been extracted, let's see what's inside
4087: it. The package has a <code class="filename">README.txt</code>, but that only
4088: says something about mozilla, so it's probably useless for seeing what
4089: dependencies this package has. But since there is a GNU configure script
4090: in the package, let's hope that it will complain about everything it
4091: needs.</p>
4092: <pre class="programlisting">
4093: <code class="prompt">$</code> bmake
4094: => Required installed package digest>=20010302: digest-20060826 found
4095: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4096: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4097: ===> Patching for nvu-1.0
4098: ===> Creating toolchain wrappers for nvu-1.0
4099: ===> Configuring for nvu-1.0
4100: [...]
4101: configure: error: Perl 5.004 or higher is required.
4102: [...]
4103: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4104: [...]
4105: </pre>
4106: <p>That worked quite well. So I opened the package Makefile in my
4107: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4108: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4109: package have changed now, and since a perl wrapper is automatically
4110: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4111: from scratch.</p>
4112: <pre class="programlisting">
4113: <code class="prompt">$</code> bmake clean
4114: ===> Cleaning for nvu-1.0
4115: <code class="prompt">$</code> bmake
4116: [...]
4117: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4118: GNU Make. You will not be able to build Mozilla without GNU Make.
4119: [...]
4120: </pre>
4121: <p>So I added “<span class="quote">gmake</span>” to the
4122: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4123: <pre class="programlisting">
4124: [...]
4125: checking for GTK - version >= 1.2.0... no
4126: *** Could not run GTK test program, checking why...
4127: [...]
4128: </pre>
4129: <p>Now to the other dependencies. The first question is: Where is the
4130: GTK package hidden in pkgsrc?</p>
4131: <pre class="programlisting">
4132: <code class="prompt">$</code> echo ../../*/gtk*
4133: [many packages ...]
4134: <code class="prompt">$</code> echo ../../*/gtk
4135: ../../x11/gtk
4136: <code class="prompt">$</code> echo ../../*/gtk2
4137: ../../x11/gtk2
4138: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4139: ../../x11/gtk2/buildlink3.mk
4140: </pre>
4141: <p>The first try was definitely too broad. The second one had exactly
4142: one result, which is very good. But there is one pitfall with GNOME
4143: packages. Before GNOME 2 had been released, there were already many
4144: GNOME 1 packages in pkgsrc. To be able to continue to use these
4145: packages, the GNOME 2 packages were imported as separate packages, and
4146: their names usually have a “<span class="quote">2</span>” appended. So I checked
4147: whether this was the case here, and indeed it was.</p>
4148: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4149: file, adding the dependency is very easy. I just inserted an
4150: <code class="literal">.include</code> line before the last line of the package
4151: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4152: <pre class="programlisting">
4153: [...]
4154: .include "../../x11/gtk2/buildlink3.mk"
4155: .include "../../mk/bsd.pkg.mk
4156: </pre>
4157: <p>After another <span><strong class="command">bmake clean && bmake</strong></span>, the answer
4158: was:</p>
4159: <pre class="programlisting">
4160: [...]
4161: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4162: checking for GTK - version >= 1.2.0... no
4163: *** Could not run GTK test program, checking why...
4164: *** The test program failed to compile or link. See the file config.log for the
4165: *** exact error that occured. This usually means GTK was incorrectly installed
4166: *** or that you have moved GTK since it was installed. In the latter case, you
4167: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4168: configure: error: Test for GTK failed.
4169: [...]
4170: </pre>
4171: <p>In this particular case, the assumption that “<span class="quote">every package
4172: prefers GNOME 2</span>” had been wrong. The first of the lines above
4173: told me that this package really wanted to have the GNOME 1 version of
4174: GTK. If the package had looked for GTK2, it would have looked for
4175: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
4176: So I changed the <code class="literal">x11/gtk2</code> to
4177: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4178: and tried again.</p>
4179: <pre class="programlisting">
4180: [...]
4181: 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
4182: In file included from xpidl.c:42:
4183: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4184: In file included from xpidl.c:42:
4185: xpidl.h:132: error: parse error before "IDL_ns"
4186: [...]
4187: </pre>
4188: <p>The package still does not find all of its dependencies. Now the
4189: question is: Which package provides the
4190: <code class="filename">libIDL/IDL.h</code> header file?</p>
4191: <pre class="programlisting">
4192: <code class="prompt">$</code> echo ../../*/*idl*
4193: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4194: <code class="prompt">$</code> echo ../../*/*IDL*
4195: ../../net/libIDL
4196: </pre>
4197: <p>Let's take the one from the second try. So I included the
4198: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4199: again. But the error didn't change. After digging through some of the
4200: code, I concluded that the build process of the package was broken and
4201: couldn't have ever worked, but since the Mozilla source tree is quite
4202: large, I didn't want to fix it. So I added the following to the package
4203: <code class="filename">Makefile</code> and tried again:</p>
4204: <pre class="programlisting">
4205: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4206: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
4207: </pre>
4208: <p>The latter line is needed because the package expects the library
4209: <code class="filename">libIDL.so</code>, but only
4210: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4211: wrapper to rewrite that on the fly.</p>
4212: <p>The next problem was related to a recent change of the FreeType
4213: 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>
4214: which patch files were relevant for this issue and copied them to the
4215: <code class="filename">patches</code> directory. Then I retried, fixed the
4216: patches so that they applied cleanly and retried again. This time,
4217: everything worked.</p>
4218: </div>
4219: <div class="sect3" lang="en">
4220: <div class="titlepage"><div><div><h4 class="title">
4221: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
4222: <pre class="programlisting">
4223: <code class="prompt">$</code> bmake CHECK_FILES=no install
4224: [...]
4225: <code class="prompt">$</code> bmake print-PLIST >PLIST
4226: <code class="prompt">$</code> bmake deinstall
4227: <code class="prompt">$</code> bmake install
4228: </pre>
4229: </div>
4230: </div>
4231: </div>
1.77 rillig 4232: </div>
1.75 rillig 4233: <div class="chapter" lang="en">
4234: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4235: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4236: <div class="toc">
4237: <p><b>Table of Contents</b></p>
4238: <dl>
1.90 rillig 4239: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
4240: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
4241: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
4242: <dd><dl>
1.93 rillig 4243: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
4244: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
4245: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
4246: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
4247: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 4248: </dl></dd>
4249: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
4250: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
4251: <dd><dl>
4252: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
4253: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
4254: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4255: </dl></dd>
1.90 rillig 4256: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
4257: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4258: </dl>
4259: </div>
1.87 wiz 4260: <p>Whenever you're preparing a package, there are a number of
4261: files involved which are described in the following
4262: sections.</p>
1.75 rillig 4263: <div class="sect1" lang="en">
4264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4265: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code>
4266: </h2></div></div></div>
1.75 rillig 4267: <p>Building, installation and creation of a binary package are all
1.87 wiz 4268: controlled by the package's <code class="filename">Makefile</code>.
4269: The <code class="filename">Makefile</code> describes various things about
4270: a package, for example from where to get it, how to configure,
4271: build, and install it.</p>
1.76 rillig 4272: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4273: sections that describe the package.</p>
1.75 rillig 4274: <p>In the first section there are the following variables, which
1.87 wiz 4275: should appear exactly in the order given here. The order and
4276: grouping of the variables is mostly historical and has no further
4277: meaning.</p>
1.75 rillig 4278: <div class="itemizedlist"><ul type="disc">
4279: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4280: distribution file to be downloaded from the package's
4281: website.</p></li>
1.75 rillig 4282: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4283: package, as used by pkgsrc. You only need to provide it if
4284: <code class="varname">DISTNAME</code> (which is the default) is not a good
4285: name for the package in pkgsrc. Usually it is the pkgsrc
4286: directory name together with the version number. It must match the
4287: regular expression
4288: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4289: starts with a letter or digit, and contains only letters, digits,
4290: dashes, underscores, dots and plus signs.</p></li>
4291: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4292: the package file to create if the <code class="varname">PKGNAME</code>
4293: isn't unique on a SVR4 system. The default is
4294: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4295: <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 4296: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4297: does not produce an unique package name on a SVR4 system.
4298: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4299: characters.</p></li>
1.75 rillig 4300: <li>
4301: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4302: which the package fits in. You can choose any of the top-level
4303: directories of pkgsrc for it.</p>
1.75 rillig 4304: <p>Currently the following values are available for
1.87 wiz 4305: <code class="varname">CATEGORIES</code>. If more than
4306: one is used, they need to be separated by spaces:</p>
1.75 rillig 4307: <pre class="programlisting">
1.87 wiz 4308: archivers cross geography meta-pkgs security
4309: audio databases graphics misc shells
4310: benchmarks devel ham multimedia sysutils
4311: biology editors inputmethod net textproc
4312: cad emulators lang news time
4313: chat finance mail parallel wm
4314: comms fonts math pkgtools www
4315: converters games mbone print x11
4316: </pre>
1.75 rillig 4317: </li>
1.81 rillig 4318: <li><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4319: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4320: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4321: and <code class="varname">DISTFILES</code> are discussed in detail in
1.90 rillig 4322: <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 4323: </ul></div>
4324: <p>The second section contains information about separately
1.87 wiz 4325: downloaded patches, if any.
4326: </p>
1.75 rillig 4327: <div class="itemizedlist"><ul type="disc">
4328: <li><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4329: Name(s) of additional files that contain distribution patches.
4330: There is no default. pkgsrc will look for them at
4331: <code class="varname">PATCH_SITES</code>.
4332: They will automatically be uncompressed before patching if
4333: the names end with <code class="filename">.gz</code> or
4334: <code class="filename">.Z</code>.</p></li>
1.75 rillig 4335: <li><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4336: Primary location(s) for distribution patch files (see
4337: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4338: </ul></div>
4339: <p>The third section contains the following variables.
1.87 wiz 4340: </p>
1.75 rillig 4341: <div class="itemizedlist"><ul type="disc">
4342: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87 wiz 4343: of the person who feels responsible for this package, and who is
4344: most likely to look at problems or questions regarding this
4345: 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
4346: developers should contact the <code class="varname">MAINTAINER</code> before
4347: making major changes to the package. When packaging a new program,
4348: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4349: maintain the package for future updates, set it to
4350: <code class="email"><<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.75 rillig 4351: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4352: find more information about the package.</p></li>
1.75 rillig 4353: <li><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4354: description of the package (should not include the package
4355: name).</p></li>
1.75 rillig 4356: </ul></div>
4357: <p>Other variables that affect the build:
1.87 wiz 4358: </p>
1.75 rillig 4359: <div class="itemizedlist"><ul type="disc"><li>
4360: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4361: interesting distribution files of the package are found. The
4362: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4363: works for most packages.</p>
1.75 rillig 4364: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4365: (most GNU software does, for instance), but extracts itself in
4366: the current directory, you should set
4367: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4368: <p>If a package doesn't create a subdirectory with the
4369: name of <code class="varname">DISTNAME</code> but some different name,
4370: set <code class="varname">WRKSRC</code> to point to the proper name in
4371: <code class="filename">${WRKDIR}</code>, for example
4372: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4373: <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 4374: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4375: taken from the <code class="varname">WRKDIR_BASENAME</code>
4376: variable. By default, its value is
4377: <code class="filename">work</code>. If you want to use the same
4378: pkgsrc tree for building different kinds of binary packages,
4379: you can change the variable according to your needs. Two
4380: other variables handle common cases of setting
4381: <code class="varname">WRKDIR_BASENAME</code> individually. If
4382: <code class="varname">OBJHOSTNAME</code> is defined in
4383: <code class="filename">/etc/mk.conf</code>, the first component of
4384: the host's name is attached to the directory name. If
4385: <code class="varname">OBJMACHINE</code> is defined, the platform name
4386: is attached, which might look like
4387: <code class="filename">work.i386</code> or
4388: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4389: </li></ul></div>
4390: <p>Please pay attention to the following gotchas:</p>
4391: <div class="itemizedlist"><ul type="disc">
1.87 wiz 4392: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4393: installed in compressed form by the package. For packages using
4394: BSD-style makefiles which honor MANZ, there is
4395: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76 rillig 4396: <li><p>Replace <code class="filename">/usr/local</code> with
1.88 wiz 4397: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4398: below).</p></li>
1.90 rillig 4399: <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 4400: </ul></div>
4401: </div>
4402: <div class="sect1" lang="en">
4403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4404: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code>
4405: </h2></div></div></div>
1.76 rillig 4406: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4407: digest, or checksum, of each distfile needed for the package. This
4408: ensures that the distfiles retrieved from the Internet have not been
4409: corrupted during transfer or altered by a malign force to introduce
4410: a security hole. Due to recent rumor about weaknesses of digest
4411: algorithms, all distfiles are protected using both SHA1 and RMD160
4412: message digests, as well as the file size.</p>
1.76 rillig 4413: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4414: checksums for all the patches found in the
1.90 rillig 4415: <code class="filename">patches</code> directory (see <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a>).</p>
1.76 rillig 4416: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87 wiz 4417: <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
4418: command.</p>
1.75 rillig 4419: <p>Some packages have different sets of distfiles depending on
1.91 rillig 4420: 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 4421: <code class="filename">distinfo</code> file and care should be taken when
4422: upgrading such a package to ensure distfile information is not
4423: lost.</p>
1.75 rillig 4424: </div>
4425: <div class="sect1" lang="en">
4426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4427: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.93 rillig 4428: <p>Many packages still don't work out-of-the box on the various
4429: platforms that are supported by pkgsrc. Therefore, a number of custom
4430: patch files are needed to make the package work. These patch files are
4431: found in the <code class="filename">patches/</code> directory.</p>
4432: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4433: applied to the files in <code class="varname">WRKSRC</code> directory after
4434: extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
4435: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4436: <code class="filename">patch-ab</code>, etc.</p>
1.93 rillig 4437: <div class="sect2" lang="en">
4438: <div class="titlepage"><div><div><h3 class="title">
4439: <a name="components.patch.structure"></a>10.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4440: <p>The <code class="filename">patch-*</code> files should be in
1.87 wiz 4441: <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4442: problems. (To force patches to apply with fuzz you can set
4443: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4444: should contain only changes for a single file, and no file should be
1.93 rillig 4445: patched by more than one patch file. This helps to keep future
4446: modifications simple.</p>
4447: <p>Each patch file is structured as follows: In the first line,
4448: there is the RCS Id of the patch itself. The second line should be
4449: empty for aesthetic reasons. After that, there should be a comment for
4450: each change that the patch does. There are a number of standard
4451: cases:</p>
4452: <div class="itemizedlist"><ul type="disc">
4453: <li><p>Patches that replace the <code class="literal">==</code>
4454: 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
4455: should contain a reference to , to avoid
4456: redundant explanations.</p></li>
4457: <li><p>Patches for commonly known vulnerabilities should
4458: mention the vulnerability ID (CAN, CVE).</p></li>
4459: <li><p>Patches that change source code should mention the
4460: platform and other environment (for example, the compiler) that the
4461: patch is needed for.</p></li>
4462: </ul></div>
4463: <p>In all other cases, the patch should be commented so that any
4464: developer who knows the code of the application can make some use of
4465: the patch. Special care should be taken for the upstream developers,
4466: since we generally want that they accept our patches, so we have less
4467: work in the future.</p>
4468: </div>
4469: <div class="sect2" lang="en">
4470: <div class="titlepage"><div><div><h3 class="title">
4471: <a name="components.patches.caveats"></a>10.3.2. Creating patch files</h3></div></div></div>
4472: <p>One important thing to mention is to pay attention that no RCS
4473: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4474: later checked into the NetBSD CVS tree. Use the
1.93 rillig 4475: <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
4476: problems.</p>
1.87 wiz 4477: <p>For even more automation, we recommend using
4478: <span><strong class="command">mkpatches</strong></span> from the same package to make a
4479: whole set of patches. You just have to backup files before you
4480: edit them to <code class="filename">filename.orig</code>, e.g. with
4481: <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
4482: using <span><strong class="command">pkgvi</strong></span> again from the same package. If
4483: you upgrade a package this way, you can easily compare the new
4484: set of patches with the previously existing one with
4485: <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
4486: or update from the <code class="filename">work/.newpatches</code>
4487: directory to <code class="filename">patches/</code>.</p>
4488: <p>When you have finished a package, remember to generate
4489: the checksums for the patch files by using the <span><strong class="command">make
1.90 rillig 4490: 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 4491: <p>When adding a patch that corrects a problem in the
4492: distfile (rather than e.g. enforcing pkgsrc's view of where
4493: man pages should go), send the patch as a bug report to the
4494: maintainer. This benefits non-pkgsrc users of the package,
4495: and usually makes it possible to remove the patch in future
4496: version.</p>
1.93 rillig 4497: </div>
4498: <div class="sect2" lang="en">
4499: <div class="titlepage"><div><div><h3 class="title">
4500: <a name="components.patches.sources"></a>10.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4501: <p>If you want to share patches between multiple packages
4502: in pkgsrc, e.g. because they use the same distfiles, set
4503: <code class="varname">PATCHDIR</code> to the path where the patch files
4504: can be found, e.g.:</p>
4505: <pre class="programlisting">
4506: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4507: </pre>
1.75 rillig 4508: <p>Patch files that are distributed by the author or other
1.87 wiz 4509: maintainers can be listed in
4510: <code class="varname">PATCHFILES</code>.</p>
4511: <p>If it is desired to store any patches that should not be
4512: committed into pkgsrc, they can be kept outside the pkgsrc
4513: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4514: directory tree there is expected to have the same
4515: “<span class="quote">category/package</span>” structure as pkgsrc, and
4516: patches are expected to be stored inside these dirs (also
4517: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4518: example, if you want to keep a private patch for
4519: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4520: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4521: files in the named directory are expected to be patch files,
4522: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4523: applied</em></span>.</p>
1.93 rillig 4524: </div>
1.85 jmmv 4525: <div class="sect2" lang="en">
4526: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 4527: <a name="components.patches.guidelines"></a>10.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4528: <p>When fixing a portability issue in the code do not use
4529: preprocessor magic to check for the current operating system nor
4530: platform. Doing so hurts portability to other platforms because
4531: the OS-specific details are not abstracted appropriately.</p>
4532: <p>The general rule to follow is: instead of checking for the
4533: operating system the application is being built on, check for the
4534: specific <span class="emphasis"><em>features</em></span> you need. For example,
4535: instead of assuming that kqueue is available under NetBSD and
4536: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.89 rillig 4537: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4538: yes, this generally involves patching the
4539: <span><strong class="command">configure</strong></span> script. There is absolutely nothing
4540: that prevents some OSes from adopting interfaces from other OSes
4541: (e.g. Linux implementing kqueue), something that the above checks
4542: cannot take into account.</p>
4543: <p>Of course, checking for features generally involves more
4544: work on the developer's side, but the resulting changes are
1.87 wiz 4545: cleaner and there are chances they will work on many other
1.85 jmmv 4546: platforms. Not to mention that there are higher chances of being
4547: later integrated into the mainstream sources. Remember:
4548: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4549: <p>Some typical examples:</p>
4550: <div class="table">
1.90 rillig 4551: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91 rillig 4552: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4553: <colgroup>
4554: <col>
4555: <col>
4556: <col>
4557: </colgroup>
4558: <thead><tr>
4559: <th>Where</th>
4560: <th>Incorrect</th>
4561: <th>Correct</th>
4562: </tr></thead>
4563: <tbody>
4564: <tr>
4565: <td>configure script</td>
4566: <td>
4567: <pre class="programlisting">case ${target_os} in
1.87 wiz 4568: netbsd*) have_kvm=yes ;;
4569: *) have_kvm=no ;;
4570: esac</pre>
1.85 jmmv 4571: </td>
4572: <td>
4573: <pre class="programlisting">AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)</pre>
4574: </td>
4575: </tr>
4576: <tr>
4577: <td>C source file</td>
4578: <td>
4579: <pre class="programlisting">#if defined(__NetBSD__)
1.87 wiz 4580: # include <sys/event.h>
4581: #endif</pre>
1.85 jmmv 4582: </td>
4583: <td>
4584: <pre class="programlisting">#if defined(HAVE_SYS_EVENT_H)
1.87 wiz 4585: # include <sys/event.h>
4586: #endif</pre>
1.85 jmmv 4587: </td>
4588: </tr>
4589: <tr>
4590: <td>C source file</td>
4591: <td>
4592: <pre class="programlisting">int
1.87 wiz 4593: monitor_file(...)
4594: {
4595: #if defined(__NetBSD__)
4596: int fd = kqueue();
4597: ...
4598: #else
4599: ...
4600: #endif
4601: }</pre>
1.85 jmmv 4602: </td>
4603: <td>
4604: <pre class="programlisting">int
1.87 wiz 4605: monitor_file(...)
4606: {
4607: #if defined(HAVE_KQUEUE)
4608: int fd = kqueue();
4609: ...
4610: #else
4611: ...
4612: #endif
4613: }</pre>
1.85 jmmv 4614: </td>
4615: </tr>
4616: </tbody>
1.91 rillig 4617: </table></div>
1.85 jmmv 4618: </div>
1.91 rillig 4619: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85 jmmv 4620: packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4621: 1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4622: 2</a>). It summarizes multiple details on how to make
4623: software easier to package; all the suggestions in it were
4624: collected from our experience in pkgsrc work, so they are possibly
4625: helpful when creating patches too.</p>
4626: </div>
4627: <div class="sect2" lang="en">
4628: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 4629: <a name="components.patches.feedback"></a>10.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4630: <p>Always, always, <span class="strong"><strong>always</strong></span>
4631: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4632: improvements you do to a package to the mainstream developers.
4633: This is the only way to get their attention on portability issues
4634: and to ensure that future versions can be built out-of-the box on
4635: NetBSD. Furthermore, any user that gets newer distfiles will get
4636: the fixes straight from the packaged code.</p>
1.93 rillig 4637: <p>This generally involves cleaning up the patches
4638: (because sometimes the patches that are
1.85 jmmv 4639: added to pkgsrc are quick hacks), filling bug reports in the
4640: appropriate trackers for the projects and working with the
4641: mainstream authors to accept your changes. It is
4642: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4643: the packages in pkgsrc are kept simple and thus further changes
4644: can be done without much hassle.</p>
4645: <p>Support the idea of free software!</p>
4646: </div>
1.75 rillig 4647: </div>
4648: <div class="sect1" lang="en">
4649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4650: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4651: <div class="variablelist"><dl>
1.76 rillig 4652: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4653: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4654: any credits where they are due. Please bear in mind that others do not
4655: share your sense of humour (or spelling idiosyncrasies), and that others
4656: will read everything that you write here.</p></dd>
1.76 rillig 4657: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4658: <dd><p>This file governs the files that are installed on your
4659: system: all the binaries, manual pages, etc. There are other
4660: directives which may be entered in this file, to control the
4661: creation and deletion of directories, and the location of
1.90 rillig 4662: inserted files. See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87 wiz 4663: information.</p></dd>
1.75 rillig 4664: </dl></div>
4665: </div>
4666: <div class="sect1" lang="en">
4667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4668: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78 rillig 4669: <div class="sect2" lang="en">
4670: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4671: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4672: <div class="variablelist"><dl>
1.76 rillig 4673: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75 rillig 4674: <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 4675: First time after package extraction and before files are
4676: moved in place, the second time after the files to install
4677: are moved in place. This can be used to do any custom
4678: procedures not possible with @exec commands in
4679: <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 4680: <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 4681: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4682: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4683: this script's responsibility to clean up any additional messy details
4684: around the package's installation, since all pkg_delete knows is how to
4685: delete the files created in the original distribution.
4686: 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>
4687: 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 4688: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4689: <dd>
4690: <p>This file is displayed after installation of the package.
1.87 wiz 4691: Useful for things like legal notices on almost-free
4692: software and hints for updating config files after
4693: installing modules for apache, PHP etc.
4694: Please note that you can modify variables in it easily by using
4695: <code class="varname">MESSAGE_SUBST</code> in the package's
4696: <code class="filename">Makefile</code>:</p>
1.75 rillig 4697: <pre class="programlisting">
1.87 wiz 4698: MESSAGE_SUBST+= SOMEVAR="somevalue"
4699: </pre>
1.75 rillig 4700: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4701: <code class="filename">MESSAGE</code>. By default, substitution is
4702: performed for <code class="varname">PKGNAME</code>,
4703: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4704: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4705: <code class="varname">X11BASE</code>,
4706: <code class="varname">PKG_SYSCONFDIR</code>,
4707: <code class="varname">ROOT_GROUP</code>, and
4708: <code class="varname">ROOT_GROUP</code>.</p>
4709: <p>You can display a different or additional files by
4710: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4711: default is <code class="filename">MESSAGE</code>, if the file
4712: exists.</p>
1.75 rillig 4713: </dd>
1.78 rillig 4714: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4715: <dd><p>FIXME: There is no documentation on the
4716: alternatives framework.</p></dd>
4717: </dl></div>
4718: </div>
4719: <div class="sect2" lang="en">
4720: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4721: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4722: <div class="variablelist"><dl>
4723: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4724: <dd><p>This file contains arbitrary things that could
4725: also go into a <code class="filename">Makefile</code>, but its purpose is
4726: to be used by more than one package. This file should only be
4727: used when the packages that will use the file are known in
4728: advance. For other purposes it is often better to write a
4729: <code class="filename">*.mk</code> file and give it a good name that
4730: describes what it does.</p></dd>
4731: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4732: <dd><p>This file contains the dependency information
1.90 rillig 4733: 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 4734: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4735: <dd><p>This file contains workarounds for compiler bugs
4736: and similar things. It is included automatically by the pkgsrc
4737: infrastructure, so you don't need an extra
4738: <code class="literal">.include</code> line for
4739: it.</p></dd>
4740: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4741: <dd><p>This file contains the code for the
1.90 rillig 4742: 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 4743: selected by the user. If a package has only one or two options,
4744: it is equally acceptable to put the code directly into the
4745: <code class="filename">Makefile</code>.</p></dd>
4746: </dl></div>
4747: </div>
4748: <div class="sect2" lang="en">
4749: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4750: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4751: <div class="variablelist"><dl>
4752: <dt><span class="term"><code class="filename">README*</code></span></dt>
4753: <dd><p>These files do not take place in the creation of
4754: a package and thus are purely informative to the package
4755: developer.</p></dd>
4756: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4757: <dd><p>This file contains things that need to be done
4758: to make the package even
4759: better.</p></dd>
1.75 rillig 4760: </dl></div>
4761: </div>
1.78 rillig 4762: </div>
1.75 rillig 4763: <div class="sect1" lang="en">
4764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4765: <a name="work-dir"></a>10.6. <code class="filename">work*</code>
4766: </h2></div></div></div>
1.75 rillig 4767: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87 wiz 4768: unpacked into the directory denoted by
4769: <code class="varname">WRKDIR</code>. It can be removed by running
4770: <span><strong class="command">make clean</strong></span>. Besides the sources, this
4771: directory is also used to keep various timestamp files.
4772: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4773: The default is <code class="filename">${.CURDIR}/work</code>
4774: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4775: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4776: </div>
4777: <div class="sect1" lang="en">
4778: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4779: <a name="files-dir"></a>10.7. <code class="filename">files/*</code>
4780: </h2></div></div></div>
1.75 rillig 4781: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4782: to configuration or building, you could place these files here and use
4783: a <span><strong class="command">${CP}</strong></span> command in the
4784: “<span class="quote">pre-configure</span>” target to achieve
4785: this. Alternatively, you could simply diff the file against
4786: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4787: the creation of this file.</p>
4788: <p>If you want to share files in this way with other
4789: packages, set the <code class="varname">FILESDIR</code> variable to point
4790: to the other package's <code class="filename">files</code> directory,
4791: e.g.:</p>
4792: <pre class="programlisting">
4793: FILESDIR=${.CURDIR}/../xemacs/files
4794: </pre>
1.75 rillig 4795: </div>
4796: </div>
4797: <div class="chapter" lang="en">
4798: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4799: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4800: <div class="toc">
4801: <p><b>Table of Contents</b></p>
4802: <dl>
1.97 rillig 4803: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
4804: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
4805: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
4806: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
4807: <dd><dl>
4808: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
4809: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
4810: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
4811: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
4812: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75 rillig 4813: </dl></dd>
4814: </dl>
4815: </div>
1.76 rillig 4816: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4817: each of which forms a well-defined part of the pkgsrc system. Using
4818: 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
4819: like pkgsrc requires some discipline to keep the code correct and
4820: understandable.</p>
1.76 rillig 4821: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4822: programming are variables (which are actually macros) and shell
4823: commands. Among these shell commands may even be more complex ones
4824: 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
4825: as intended it is necessary to quote all variables correctly when they
4826: are used.</p>
4827: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4828: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4829: with them.</p>
4830: <div class="sect1" lang="en">
4831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97 rillig 4832: <a name="makefile.style"></a>11.1. Caveats</h2></div></div></div>
4833: <div class="itemizedlist"><ul type="disc"><li>
4834: <p>When you are creating a file as a
4835: target of a rule, always write the data to a temporary file first
4836: and finally rename that file. Otherwise there might occur an error
4837: in the middle of generating the file, and when the user runs
4838: <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
4839: regenerated properly. Example:</p>
4840: <pre class="programlisting">
4841: wrong:
4842: @echo "line 1" > ${.TARGET}
4843: @echo "line 2" >> ${.TARGET}
4844: @false
4845:
4846: correct:
4847: @echo "line 1" > ${.TARGET}.tmp
4848: @echo "line 2" >> ${.TARGET}.tmp
4849: @false
4850: @mv ${.TARGET}.tmp ${.TARGET}
4851: </pre>
4852: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
4853: <code class="filename">wrong</code> will exist, although there was an error
4854: message in the first run. On the other hand, running <span><strong class="command">make
4855: correct</strong></span> gives an error message twice, as expected.</p>
4856: <p>You might remember that <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
4857: <code class="literal">${.TARGET}</code> in case of error, but this only
4858: happens when it is interrupted, for example by pressing
4859: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
4860: when one of the commands fails (like <a href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
4861: </li></ul></div>
4862: </div>
4863: <div class="sect1" lang="en">
4864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4865: <a name="makefile.variables"></a>11.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4866: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4867: can be processed using the five operators ``='', ``+='', ``?='',
4868: ``:='', 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
4869: page.</p>
4870: <p>When a variable's value is parsed from a
1.76 rillig 4871: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4872: backslash character ``\'' are handled specially. If a backslash is
4873: followed by a newline, any whitespace immediately in front of the
4874: backslash, the backslash, the newline, and any whitespace
4875: immediately behind the newline are replaced with a single space. A
4876: backslash character and an immediately following hash character are
4877: replaced with a single hash character. Otherwise, the backslash is
4878: passed as is. In a variable assignment, any hash character that is
4879: not preceded by a backslash starts a comment that continues upto the
4880: end of the logical line.</p>
4881: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4882: the only way to create a variable consisting of a single backslash
4883: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4884: <p>So far for defining variables. The other thing you can do with
4885: variables is evaluating them. A variable is evaluated when it is
4886: part of the right side of the ``:='' or the ``!='' operator, or
4887: directly before executing a shell command which the variable is part
4888: 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
4889: is, variables are not evaluated until there's no other way. The
4890: ``modifiers'' mentioned in the man page also evaluate the
4891: variable.</p>
4892: <p>Some of the modifiers split the string into words and then
4893: operate on the words, others operate on the string as a whole. When
4894: a string is split into words, it is split as you would expect
4895: 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 4896: <p>No rule without exception—the <span><strong class="command">.for</strong></span>
1.75 rillig 4897: loop does not follow the shell quoting rules but splits at sequences
4898: of whitespace.</p>
4899: <p>There are several types of variables that should be handled
4900: differently. Strings and two types of lists.</p>
4901: <div class="itemizedlist"><ul type="disc">
4902: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4903: characters. Nevertheless, you should restrict yourself to only
4904: using printable characters. Examples are
4905: <code class="varname">PREFIX</code> and
4906: <code class="varname">COMMENT</code>.</p></li>
4907: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4908: are never exported to any shell command. Their elements are
4909: separated by whitespace. Therefore, the elements themselves cannot
4910: have embedded whitespace. Any other characters are allowed.
4911: Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
4912: Examples are <code class="varname">DEPENDS</code> and
4913: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4914: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4915: may be exported to a shell command. Their elements can contain any
4916: characters, including whitespace. That's why they cannot be used
4917: in <span><strong class="command">.for</strong></span> loops. Examples are
4918: <code class="varname">DISTFILES</code> and
4919: <code class="varname">MASTER_SITES</code>.</p></li>
4920: </ul></div>
4921: <div class="sect2" lang="en">
4922: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4923: <a name="makefile.variables.names"></a>11.2.1. Naming conventions</h3></div></div></div>
1.75 rillig 4924: <div class="itemizedlist"><ul type="disc">
4925: <li><p>All variable names starting with an underscore
4926: are reserved for use by the pkgsrc infrastructure. They shall
4927: not be used by package
1.76 rillig 4928: <code class="filename">Makefile</code>s.</p></li>
1.75 rillig 4929: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
4930: lowercase variable names for the iteration
4931: variables.</p></li>
4932: <li><p>All list variables should have a ``plural''
4933: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4934: <code class="varname">DISTFILES</code>.</p></li>
4935: </ul></div>
4936: </div>
4937: </div>
4938: <div class="sect1" lang="en">
4939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97 rillig 4940: <a name="makefile.code"></a>11.3. Code snippets</h2></div></div></div>
1.75 rillig 4941: <p>This section presents you with some code snippets you should
4942: use in your own code. If you don't find anything appropriate here,
4943: you should test your code and add it here.</p>
4944: <div class="sect2" lang="en">
4945: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4946: <a name="adding-to-list"></a>11.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4947: <pre class="programlisting">
4948: STRING= foo * bar `date`
4949: INT_LIST= # empty
4950: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4951: EXT_LIST= # empty
4952: ANOTHER_EXT_LIST= a=b c=d
1.1 grant 4953:
1.75 rillig 4954: INT_LIST+= ${STRING} # 1
4955: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4956: EXT_LIST+= ${STRING:Q} # 3
4957: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4958: </pre>
1.75 rillig 4959: <p>When you add a string to an external list (example 3), it
4960: must be quoted. In all other cases, you must not add a quoting
4961: level. You must not merge internal and external lists, unless you
4962: are sure that all entries are correctly interpreted in both
4963: lists.</p>
4964: </div>
4965: <div class="sect2" lang="en">
4966: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4967: <a name="converting-internal-to-external"></a>11.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75 rillig 4968: <pre class="programlisting">
4969: EXT_LIST= # empty
4970: .for i in ${INT_LIST}
4971: EXT_LIST+= ${i:Q}""
4972: .endfor
1.1 grant 4973: </pre>
1.75 rillig 4974: <p>This code converts the internal list
4975: <code class="varname">INT_LIST</code> into the external list
4976: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4977: are unquoted they must be quoted here. The reason for appending
4978: <code class="varname">""</code> is explained below.</p>
4979: </div>
4980: <div class="sect2" lang="en">
4981: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4982: <a name="passing-variable-to-shell"></a>11.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4983: <p>Sometimes you may want to print an arbitrary string. There
4984: are many ways to get it wrong and only few that can handle every
4985: nastiness.</p>
1.75 rillig 4986: <pre class="programlisting">
4987: STRING= foo bar < > * `date` $$HOME ' "
4988: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4989:
1.75 rillig 4990: all:
4991: echo ${STRING} # 1
4992: echo "${STRING}" # 2
4993: echo "${STRING:Q}" # 3
4994: echo ${STRING:Q} # 4
4995: echo x${STRING:Q} | sed 1s,.,, # 5
1.79 rillig 4996: printf "%s\\n" ${STRING:Q}"" # 6
1.75 rillig 4997: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4998: </pre>
1.75 rillig 4999: <p>Example 1 leads to a syntax error in the shell, as the
5000: characters are just copied.</p>
5001: <p>Example 2 leads to a syntax error too, and if you leave out
5002: the last " character from <code class="varname">${STRING}</code>,
5003: <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
5004: variable would be evaluated, too.</p>
5005: <p>Example 3 outputs each space character preceded by a
5006: backslash (or not), depending on the implementation of the
5007: <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>
5008: <p>Example 4 handles correctly every string that does not start
5009: with a dash. In that case, the result depends on the
5010: 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
5011: guarantee that your input does not start with a dash, this form is
5012: appropriate.</p>
5013: <p>Example 5 handles even the case of a leading dash
5014: correctly.</p>
1.79 rillig 5015: <p>Example 6 also works with every string and is the
5016: light-weight solution, since it does not involve a pipe, which has
5017: its own problems.</p>
1.75 rillig 5018: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5019: because the quoting has already been done when adding elements to
5020: the list.</p>
5021: <p>As internal lists shall not be passed to the shell, there is
5022: no example for it.</p>
5023: </div>
5024: <div class="sect2" lang="en">
5025: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5026: <a name="quoting-guideline"></a>11.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 5027: <p>There are many possible sources of wrongly quoted variables.
5028: This section lists some of the commonly known ones.</p>
5029: <div class="itemizedlist"><ul type="disc">
5030: <li>
5031: <p>Whenever you use the value of a list, think
5032: about what happens to leading or trailing whitespace. If the
5033: list is a well-formed shell expression, you can apply the
5034: <code class="varname">:M*</code> modifier to strip leading and trailing
5035: whitespace from each word. The <code class="varname">:M</code> operator
5036: first splits its argument according to the rules of the shell,
5037: and then creates a new list consisting of all words that match
5038: the shell glob expression <code class="varname">*</code>, that is: all.
5039: One class of situations where this is needed is when adding a
5040: variable like <code class="varname">CPPFLAGS</code> to
5041: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5042: invokes other configure scripts, it strips the leading and
5043: trailing whitespace from the variable and then passes it to the
5044: other configure scripts. But these configure scripts expect the
5045: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5046: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5047: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5048: here is how we do it:</p>
5049: <pre class="programlisting">
5050: CPPFLAGS= # empty
5051: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5052: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 5053:
1.75 rillig 5054: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 5055:
1.75 rillig 5056: all:
5057: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5058: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5059: </pre>
1.75 rillig 5060: </li>
5061: <li><p>The example above contains one bug: The
5062: <code class="varname">${PREFIX}</code> is a properly quoted shell
5063: expression, but there is the C compiler after it, which also
5064: expects a properly quoted string (this time in C syntax). The
5065: version above is therefore only correct if
5066: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5067: or double quotes. If you want to allow these, you have to add
5068: another layer of quoting to each variable that is used as a C
5069: string literal. You cannot use the <code class="varname">:Q</code>
5070: operator for it, as this operator only works for the
5071: shell.</p></li>
5072: <li>
5073: <p>Whenever a variable can be empty, the
5074: <code class="varname">:Q</code> operator can have surprising results. Here
5075: are two completely different cases which can be solved with the
5076: same trick.</p>
5077: <pre class="programlisting">
5078: EMPTY= # empty
5079: empty_test:
5080: for i in a ${EMPTY:Q} c; do \
5081: echo "$$i"; \
5082: done
1.1 grant 5083:
1.75 rillig 5084: for_test:
5085: .for i in a:\ a:\test.txt
5086: echo ${i:Q}
5087: echo "foo"
5088: .endfor
1.1 grant 5089: </pre>
1.75 rillig 5090: <p>The first example will only print two of the three lines
5091: we might have expected. This is because
5092: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5093: the shell cannot see. The workaround is to write
5094: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5095: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5096: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5097: <p>The second example will only print three lines instead of
5098: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5099: This is because the backslash of the value
5100: <code class="varname">a:\</code> is interpreted as a line-continuation by
5101: <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
5102: <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
5103: <code class="varname">${i:Q}""</code>.</p>
5104: </li>
5105: </ul></div>
5106: </div>
5107: <div class="sect2" lang="en">
5108: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5109: <a name="bsd-make-bug-workaround"></a>11.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5110: <p>The pkgsrc bmake program does not handle the following
5111: assignment correctly. In case <code class="varname">_othervar_</code>
5112: contains a ``-'' character, one of the closing braces is included
5113: in <code class="varname">${VAR}</code> after this code executes.</p>
5114: <pre class="programlisting">
5115: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5116: </pre>
1.75 rillig 5117: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5118: 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 5119: <code class="varname">bug1</code>.</p>
5120: </div>
5121: </div>
5122: </div>
5123: <div class="chapter" lang="en">
5124: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5125: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75 rillig 5126: <div class="toc">
5127: <p><b>Table of Contents</b></p>
5128: <dl>
1.90 rillig 5129: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
5130: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5131: <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>
5132: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
5133: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
5134: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5135: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
5136: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5137: </dl>
5138: </div>
1.87 wiz 5139: <p>The <code class="filename">PLIST</code> file contains a package's
5140: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5141: the package (relative to the <code class="filename">${PREFIX}</code>
5142: directory it's been installed in) plus some additional statements
5143: - 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.
5144: This chapter addresses some issues that need attention when
5145: dealing with the <code class="filename">PLIST</code> file (or files, see
5146: below!).</p>
1.75 rillig 5147: <div class="sect1" lang="en">
5148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5149: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87 wiz 5150: <p>Be sure to add a RCS ID line as the first thing in any
5151: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5152: <pre class="programlisting">
1.87 wiz 5153: @comment $NetBSD$
5154: </pre>
1.75 rillig 5155: </div>
5156: <div class="sect1" lang="en">
5157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5158: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75 rillig 5159: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87 wiz 5160: to output a PLIST that matches any new files since the package
1.90 rillig 5161: 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 5162: more information on this target.</p>
1.75 rillig 5163: </div>
5164: <div class="sect1" lang="en">
5165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 5166: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
5167: </h2></div></div></div>
1.87 wiz 5168: <p>If you have used any of the *-dirs packages, as explained in
1.90 rillig 5169: <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 5170: <span><strong class="command">make print-PLIST</strong></span> outputs a set of
5171: <code class="varname">@comment</code>s instead of real
5172: <code class="varname">@dirrm</code> lines. You can also do this for
5173: specific directories and files, so that the results of that
5174: command are very close to reality. This helps <span class="emphasis"><em>a
5175: lot</em></span> during the update of packages.</p>
5176: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5177: of AWK patterns and actions that are used to filter the output of
5178: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5179: scripting you like to it, but be careful with quoting.</p>
5180: <p>For example, to get all files inside the
5181: <code class="filename">libdata/foo</code> directory removed from the
5182: resulting PLIST:</p>
5183: <pre class="programlisting">
5184: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
5185: </pre>
5186: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5187: to a specific (shared) directory converted to
5188: <code class="varname">@comment</code>s:</p>
1.75 rillig 5189: <pre class="programlisting">
1.87 wiz 5190: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5191: </pre>
1.75 rillig 5192: </div>
5193: <div class="sect1" lang="en">
5194: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5195: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5196: <p>A number of variables are substituted automatically in
5197: PLISTs when a package is installed on a system. This includes the
5198: following variables:</p>
1.75 rillig 5199: <div class="variablelist"><dl>
5200: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5201: <dd>
5202: <p>Some packages like emacs and perl embed information
1.87 wiz 5203: about which architecture they were built on into the
5204: pathnames where they install their files. To handle this
5205: case, PLIST will be preprocessed before actually used, and
5206: the symbol
5207: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
5208: replaced by what <span><strong class="command">uname -p</strong></span> gives. The
5209: same is done if the string
5210: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5211: PLIST somewhere - use this on packages that have GNU
5212: autoconf-created configure scripts.</p>
1.75 rillig 5213: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5214: <h3 class="title">Legacy note</h3>
5215: <p>There used to be a symbol
1.87 wiz 5216: “<span class="quote"><code class="varname">$ARCH</code></span>” that
5217: was replaced by the output of <span><strong class="command">uname
5218: -m</strong></span>, but that's no longer supported and has
5219: been removed.</p>
1.75 rillig 5220: </div>
5221: </dd>
5222: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5223: <dd>
5224: <p>Some packages want to embed the OS name and version
1.87 wiz 5225: into some paths. To do this, use these variables in the
5226: <code class="filename">PLIST</code>:
5227: </p>
1.75 rillig 5228: <div class="itemizedlist"><ul type="disc">
5229: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span><strong class="command">uname -s</strong></span></span>”</p></li>
5230: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
5231: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span><strong class="command">uname -r</strong></span></span>”</p></li>
5232: </ul></div>
5233: </dd>
5234: </dl></div>
1.87 wiz 5235: <p>For a complete list of values which are replaced by
5236: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5237: search for <code class="varname">PLIST_SUBST</code>).</p>
5238: <p>If you want to change other variables not listed above, you
5239: can add variables and their expansions to this variable in the
1.90 rillig 5240: 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 5241: <pre class="programlisting">
1.87 wiz 5242: PLIST_SUBST+= SOMEVAR="somevalue"
5243: </pre>
1.75 rillig 5244: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5245: in the <code class="filename">PLIST</code> with
5246: “<span class="quote">somevalue</span>”.</p>
1.75 rillig 5247: </div>
5248: <div class="sect1" lang="en">
5249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5250: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75 rillig 5251: <p>Man pages should be installed in compressed form if
1.87 wiz 5252: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5253: and uncompressed otherwise. To handle this in the
5254: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5255: appended/removed automatically for man pages according to
5256: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5257: or not, see above for details. This modification of the
5258: <code class="filename">PLIST</code> file is done on a copy of it, not
5259: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5260: </div>
5261: <div class="sect1" lang="en">
5262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 5263: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
5264: </h2></div></div></div>
1.76 rillig 5265: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5266: in generating the binary package, set the variable
5267: <code class="varname">PLIST_SRC</code> to the names of that file(s).
5268: 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
5269: important. The default for <code class="varname">PLIST_SRC</code> is
5270: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5271: </div>
5272: <div class="sect1" lang="en">
5273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5274: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5275: <p>Some packages decide to install a different set of files based on
1.87 wiz 5276: the operating system being used. These differences can be
5277: automatically handled by using the following files:</p>
1.75 rillig 5278: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5279: <li><p><code class="filename">PLIST.common</code></p></li>
5280: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5281: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5282: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5283: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5284: </ul></div>
5285: </div>
5286: <div class="sect1" lang="en">
5287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5288: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5289: <p>A “<span class="quote">shared directory</span>” is a directory where
5290: multiple (and unrelated) packages install files. These
5291: directories are problematic because you have to add special tricks
5292: in the PLIST to conditionally remove them, or have some
5293: centralized package handle them.</p>
5294: <p>Within pkgsrc, you'll find both approaches. If a directory
5295: is shared by a few unrelated packages, it's often not worth to add
5296: an extra package to remove it. Therefore, one simply does:</p>
5297: <pre class="programlisting">
5298: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
5299: </pre>
5300: <p>in the PLISTs of all affected packages, instead of the
5301: regular "@dirrm" line.</p>
5302: <p>However, if the directory is shared across many packages, two
5303: different solutions are available:</p>
1.75 rillig 5304: <div class="orderedlist"><ol type="1">
1.87 wiz 5305: <li><p>If the packages have a common dependency, the directory
5306: can be removed in that. For example, see
1.91 rillig 5307: <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 5308: removes the shared directory
5309: <code class="filename">share/omf</code>.</p></li>
5310: <li><p>If the packages using the directory are not related at
5311: all (they have no common dependencies), a *-dirs package is
5312: used.</p></li>
1.75 rillig 5313: </ol></div>
1.87 wiz 5314: <p>From now on, we'll discuss the second solution. To get an
5315: idea of the *-dirs packages available, issue:</p>
1.75 rillig 5316: <pre class="programlisting">
1.87 wiz 5317: <code class="prompt">%</code> cd .../pkgsrc
5318: <code class="prompt">%</code> ls -d */*-dirs
5319: </pre>
5320: <p>Their use from other packages is very simple. The
5321: <code class="varname">USE_DIRS</code> variable takes a list of package names
5322: (without the “<span class="quote">-dirs</span>” part) together with the required
5323: version number (always pick the latest one when writing new
5324: packages).</p>
5325: <p>For example, if a package installs files under
5326: <code class="filename">share/applications</code>, it should have the
5327: following line in it:</p>
5328: <pre class="programlisting">
5329: USE_DIRS+= xdg-1.1
5330: </pre>
5331: <p>After regenerating the PLIST using <span><strong class="command">make
5332: print-PLIST</strong></span>, you should get the right (commented out)
5333: lines.</p>
5334: <p>Note that even if your package is using
5335: <code class="filename">$X11BASE</code>, it must not depend on the
5336: *-x11-dirs packages. Just specify the name without that part and
5337: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5338: care of it.</p>
1.75 rillig 5339: </div>
5340: </div>
5341: <div class="chapter" lang="en">
5342: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5343: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75 rillig 5344: <div class="toc">
5345: <p><b>Table of Contents</b></p>
5346: <dl>
1.90 rillig 5347: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
5348: <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 5349: <dd><dl>
1.90 rillig 5350: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5351: <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 5352: </dl></dd>
1.90 rillig 5353: <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 5354: <dd><dl>
1.90 rillig 5355: <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>
5356: <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 5357: </dl></dd>
5358: </dl>
5359: </div>
5360: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5361: are seen by a package's configure and build processes. This is implemented
5362: in a two step process:</p>
1.75 rillig 5363: <div class="orderedlist"><ol type="1">
5364: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5365: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5366: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5367: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5368: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5369: <code class="option">-L${LOCALBASE}/lib</code> into references to
5370: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5371: native compiler on some operating systems look like GCC, so that
5372: packages that expect GCC won't require modifications to build with
5373: those native compilers.</p></li>
1.75 rillig 5374: </ol></div>
5375: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5376: package may be built consistently despite what other software may be
5377: installed. Please note that the normal system header and library paths,
5378: e.g. <code class="filename">/usr/include</code>,
5379: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5380: designed to insulate the package build from non-system-supplied
5381: software.</p>
1.75 rillig 5382: <div class="sect1" lang="en">
5383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5384: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5385: <p>The process of converting packages to use the buildlink3
1.87 wiz 5386: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5387: The things to keep in mind are:</p>
1.75 rillig 5388: <div class="orderedlist"><ol type="1">
1.87 wiz 5389: <li><p>Ensure that the build always calls the wrapper scripts
5390: instead of the actual toolchain. Some packages are tricky,
5391: and the only way to know for sure is the check
5392: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5393: wrappers are being invoked.</p></li>
5394: <li><p>Don't override <code class="varname">PREFIX</code> from within
5395: the package Makefile, e.g. Java VMs, standalone shells,
5396: etc., because the code to symlink files into
5397: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5398: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5399: </p></li>
5400: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5401: <code class="filename">buildlink3.mk</code> files that you list in a
5402: package's Makefile are added as dependencies for that package.
5403: </p></li>
1.75 rillig 5404: </ol></div>
1.87 wiz 5405: <p>If a dependency on a particular package is required for its libraries and
5406: headers, then we replace:</p>
1.75 rillig 5407: <pre class="programlisting">
1.87 wiz 5408: DEPENDS+= foo>=1.1.0:../../category/foo
5409: </pre>
1.75 rillig 5410: <p>with</p>
5411: <pre class="programlisting">
1.87 wiz 5412: .include "../../category/foo/buildlink3.mk"
5413: </pre>
1.75 rillig 5414: <p>The buildlink3.mk files usually define the required dependencies.
5415: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5416: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5417: <pre class="programlisting">
1.87 wiz 5418: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5419: .include "../../category/foo/buildlink3.mk"
5420: </pre>
1.76 rillig 5421: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5422: files in <code class="filename">pkgsrc/mk</code>
5423: that handle special package issues:</p>
1.75 rillig 5424: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5425: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5426: the native or a pkgsrc Berkeley DB implementation based on
5427: the values of <code class="varname">BDB_ACCEPTED</code> and
5428: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5429: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5430: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5431: 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 5432: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5433: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5434: adding a dependency on Heimdal or MIT-krb5 for packages that
5435: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5436: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5437: system-provided Motif installation or adds a dependency on
1.91 rillig 5438: <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 5439: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5440: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5441: which Motif version will be used.</p></li>
1.76 rillig 5442: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5443: variables that may be used by packages that use the
5444: Open Sound System (OSS) API.</p></li>
1.76 rillig 5445: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5446: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5447: the file for more information.</p></li>
1.76 rillig 5448: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5449: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5450: 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 5451: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5452: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5453: library.</p></li>
1.75 rillig 5454: </ul></div>
1.76 rillig 5455: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5456: files provide a more complete
5457: description of how to use them properly.</p>
1.75 rillig 5458: </div>
5459: <div class="sect1" lang="en">
5460: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5461: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87 wiz 5462: <p>A package's <code class="filename">buildlink3.mk</code> file is
5463: included by Makefiles to indicate the need to compile and link
5464: against header files and libraries provided by the package. A
5465: <code class="filename">buildlink3.mk</code> file should always provide
5466: enough information to add the correct type of dependency
5467: relationship and include any other
5468: <code class="filename">buildlink3.mk</code> files that it needs to find
5469: headers and libraries that it needs in turn.</p>
5470: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5471: 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 5472: package is highly recommended. For most packages, the following
5473: command will generate a good starting point for
5474: <code class="filename">buildlink3.mk</code> files:</p>
5475: <pre class="screen">
5476: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5477: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5478: </pre>
1.75 rillig 5479: <div class="sect2" lang="en">
5480: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5481: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5482: <p>The following real-life example
1.87 wiz 5483: <code class="filename">buildlink3.mk</code> is taken
5484: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5485: <pre class="programlisting">
1.87 wiz 5486: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1 grant 5487:
1.87 wiz 5488: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5489: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
1.1 grant 5490:
1.87 wiz 5491: .if !empty(BUILDLINK_DEPTH:M+)
5492: BUILDLINK_DEPENDS+= tiff
5493: .endif
5494:
5495: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5496: BUILDLINK_PACKAGES+= tiff
5497:
5498: .if !empty(TIFF_BUILDLINK3_MK:M+)
5499: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5500: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5501: .endif # TIFF_BUILDLINK3_MK
5502:
5503: .include "../../devel/zlib/buildlink3.mk"
5504: .include "../../graphics/jpeg/buildlink3.mk"
5505:
5506: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5507: </pre>
5508: <p>The header and footer manipulate
5509: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5510: <code class="filename">buildlink3.mk</code> files and is used to track
5511: at what depth we are including
5512: <code class="filename">buildlink3.mk</code> files.</p>
5513: <p>The first section controls if the dependency on
5514: <em class="replaceable"><code>pkg</code></em> is added.
5515: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5516: packages for which dependencies are added by
5517: buildlink3.</p>
5518: <p>The second section advises pkgsrc that the
5519: <code class="filename">buildlink3.mk</code> file for
5520: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5521: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5522: packages for which <code class="filename">buildlink3.mk</code> files
5523: have been included. It must <span class="emphasis"><em>always</em></span> be
5524: appended to within a <code class="filename">buildlink3.mk</code>
5525: file.</p>
5526: <p>The third section is protected from multiple inclusion
5527: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5528: added. Several important variables are set in the section:</p>
5529: <div class="itemizedlist"><ul type="disc">
5530: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5531: is the actual dependency recorded in the installed
5532: package; this should always be set using
5533: <span><strong class="command">+=</strong></span> to ensure that
5534: we're appending to any pre-existing list of values. This
5535: variable should be set to the first version of the
5536: package that had an API change.
5537: </p></li>
5538: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5539: is the location of the <em class="replaceable"><code>pkg</code></em>
5540: pkgsrc directory.</p></li>
5541: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5542: (not shown above) controls whether we use
5543: <code class="varname">BUILD_DEPENDS</code> or
5544: <code class="varname">DEPENDS</code> to add the dependency on
5545: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5546: selected by setting
5547: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5548: to “<span class="quote">build</span>”. By default, the full dependency is
5549: used.</p></li>
5550: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5551: and
5552: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5553: (not shown above) are lists of subdirectories of
1.76 rillig 5554: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5555: to add to the header and library search paths. These
5556: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5557: respectively.</p></li>
5558: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5559: (not shown above) is the list of preprocessor flags to add
5560: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5561: configure and build phases. The “<span class="quote">-I</span>” option
5562: should be avoided and instead be handled using
5563: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5564: above.</p></li>
1.75 rillig 5565: </ul></div>
1.87 wiz 5566: <p>The following variables are all optionally defined within
5567: this second section (protected against multiple inclusion) and
5568: control which package files are symlinked into
5569: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5570: transformed during the symlinking:</p>
1.75 rillig 5571: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5572: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5573: (not shown above) is a shell glob pattern relative to
1.76 rillig 5574: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5575: to be symlinked into
1.76 rillig 5576: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5577: e.g. <code class="filename">include/*.h</code>.</p></li>
5578: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5579: (not shown above) is a shell pipeline that
5580: outputs to stdout a list of files relative to
5581: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5582: The resulting files are to be symlinked
5583: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5584: this takes the <code class="filename">+CONTENTS</code> of a
5585: <em class="replaceable"><code>pkg</code></em> and filters it through
5586: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5587: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5588: (not shown above) is a filter command that filters
1.76 rillig 5589: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5590: relative to
1.76 rillig 5591: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5592: on stdout. By default for overwrite packages,
5593: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5594: outputs the contents of the <code class="filename">include</code>
5595: and <code class="filename">lib</code> directories in the package
5596: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5597: it outputs any libtool archives in
1.87 wiz 5598: <code class="filename">lib</code> directories.</p></li>
1.95 tron 5599: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5600: (not shown above) is a list of sed arguments used to
5601: transform the name of the source filename into a
5602: destination filename, e.g. <span><strong class="command">-e
1.87 wiz 5603: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5604: </ul></div>
1.87 wiz 5605: <p>The last section includes any
5606: <code class="filename">buildlink3.mk</code> needed for
5607: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5608: Including these <code class="filename">buildlink3.mk</code> files
5609: means that the headers and libraries for these
5610: dependencies are also symlinked into
5611: <code class="filename">${BUILDLINK_DIR}</code>
5612: whenever the <em class="replaceable"><code>pkg</code></em>
5613: <code class="filename">buildlink3.mk</code>
5614: file is included.</p>
1.75 rillig 5615: </div>
5616: <div class="sect2" lang="en">
5617: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5618: <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 5619: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5620: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5621: after a package update is when the API or interface to the
1.87 wiz 5622: header files change.</p>
5623: <p>In this case,
5624: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5625: should be adjusted to require at least the new package
5626: version. In some cases, the packages that depend on this new
5627: version may need their <code class="varname">PKGREVISION</code>s
5628: increased and, if they have <code class="filename">buildlink3.mk</code>
5629: files, their
5630: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5631: adjusted, too. This is needed so pkgsrc will require the
5632: correct package dependency and not settle for an older one
5633: when building the source.</p>
5634: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5635: should be increased when the binary interface or sonames
5636: (major number of the library version) of any installed
5637: shared libraries change. This is needed so that binary
5638: packages made using it will require the correct package
5639: dependency and not settle for an older one which will not
1.87 wiz 5640: contain the necessary shared libraries.</p>
1.90 rillig 5641: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, “Handling dependencies”</a> for
1.75 rillig 5642: more information about dependencies on other packages,
5643: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5644: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5645: <p>Please take careful consideration before adjusting
5646: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5647: or
5648: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5649: as we don't want to cause unneeded package deletions and
5650: rebuilds. In many cases, new versions of packages work just
5651: fine with older dependencies.</p>
5652: <p>Also it is not needed to set
1.75 rillig 5653: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5654: when it is identical to
1.87 wiz 5655: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5656: </div>
5657: </div>
5658: <div class="sect1" lang="en">
5659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5660: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5661: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5662: coincide with headers and libraries present in the base system.
1.76 rillig 5663: Aside from a <code class="filename">buildlink3.mk</code> file, these
5664: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5665: file that includes the necessary checks to decide whether using
5666: the built-in software or the pkgsrc software is
1.87 wiz 5667: appropriate.</p>
5668: <p>The only requirements of a builtin.mk file for
5669: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5670: <div class="orderedlist"><ol type="1">
1.87 wiz 5671: <li><p>It should set
5672: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5673: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5674: after it is included.</p></li>
5675: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5676: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5677: which is already set before the
5678: <code class="filename">builtin.mk</code> file is included.</p></li>
5679: <li><p>It should be written to allow multiple inclusion. This
5680: is <span class="emphasis"><em>very</em></span> important and takes careful
5681: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5682: </ol></div>
5683: <div class="sect2" lang="en">
5684: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5685: <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 5686: <p>The following is the recommended template for builtin.mk
1.87 wiz 5687: files:</p>
1.75 rillig 5688: <pre class="programlisting">
1.87 wiz 5689: .if !defined(IS_BUILTIN.foo)
5690: #
5691: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5692: # genuinely exists in the system or not.
5693: #
5694: IS_BUILTIN.foo?= no
5695:
5696: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5697: # version can be determined.
5698: #
5699: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5700: BUILTIN_PKG.foo?= foo-1.0
5701: . endif
5702: .endif # IS_BUILTIN.foo
5703:
5704: .if !defined(USE_BUILTIN.foo)
5705: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5706: . if defined(BUILTIN_PKG.foo)
5707: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5708: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5709: USE_BUILTIN.foo!= \
5710: if ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}; then \
5711: ${ECHO} "yes"; \
5712: else \
5713: ${ECHO} "no"; \
5714: fi
5715: . endif
5716: . endfor
5717: . endif
5718: .endif # USE_BUILTIN.foo
5719:
5720: CHECK_BUILTIN.foo?= no
5721: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5722: #
5723: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5724: # "yes" or "no".
5725: #
5726: .endif # CHECK_BUILTIN.foo
5727: </pre>
5728: <p>The first section sets
5729: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5730: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5731: in the base system. This should not be a base system software
5732: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5733: it should only be “<span class="quote">yes</span>” if the actual package is
5734: included as part of the base system. This variable is only
5735: used internally within the <code class="filename">builtin.mk</code>
5736: file.</p>
5737: <p>The second section sets
5738: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5739: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5740: system if it exists (if
5741: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5742: is “<span class="quote">yes</span>”). This variable is only used internally
5743: within the <code class="filename">builtin.mk</code> file.</p>
5744: <p>The third section sets
5745: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5746: and is <span class="emphasis"><em>required</em></span> in all
5747: <code class="filename">builtin.mk</code> files. The code in this
5748: section must make the determination whether the built-in
5749: software is adequate to satisfy the dependencies listed in
5750: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5751: This is typically done by comparing
5752: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5753: against each of the dependencies in
5754: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5755: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5756: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5757: end of the <code class="filename">builtin.mk</code> file. Note that
5758: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5759: may be “<span class="quote">yes</span>” even if
5760: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5761: is “<span class="quote">no</span>” because we may make the determination
5762: that the built-in version of the software is similar enough to
5763: be used as a replacement.</p>
5764: <p>The last section is guarded by
5765: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5766: and includes code that uses the value of
5767: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5768: set in the previous section. This typically includes, e.g.,
5769: adding additional dependency restrictions and listing additional
5770: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5771: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5772: </div>
5773: <div class="sect2" lang="en">
5774: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5775: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5776: <p>When building packages, it's possible to choose whether to set
5777: a global preference for using either the built-in (native)
5778: version or the pkgsrc version of software to satisfy a
5779: dependency. This is controlled by setting
5780: <code class="varname">PREFER_PKGSRC</code> and
5781: <code class="varname">PREFER_NATIVE</code>. These variables take values
5782: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5783: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5784: use the pkgsrc versions of software, while
5785: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5786: built-in versions. Preferences are determined by the most
5787: specific instance of the package in either
5788: <code class="varname">PREFER_PKGSRC</code> or
5789: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5790: in neither or in both variables, then
5791: <code class="varname">PREFER_PKGSRC</code> has precedence over
5792: <code class="varname">PREFER_NATIVE</code>. For example, to require
5793: using pkgsrc versions of software for all but the most basic
5794: bits on a NetBSD system, you can set:</p>
5795: <pre class="programlisting">
5796: PREFER_PKGSRC= yes
5797: PREFER_NATIVE= getopt skey tcp_wrappers
5798: </pre>
5799: <p>A package <span class="emphasis"><em>must</em></span> have a
5800: <code class="filename">builtin.mk</code>
5801: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5802: otherwise it is simply ignored in that list.</p>
1.75 rillig 5803: </div>
5804: </div>
5805: </div>
5806: <div class="chapter" lang="en">
5807: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5808: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75 rillig 5809: <div class="toc">
5810: <p><b>Table of Contents</b></p>
5811: <dl>
1.90 rillig 5812: <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 5813: <dd><dl>
1.90 rillig 5814: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
5815: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75 rillig 5816: </dl></dd>
1.90 rillig 5817: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75 rillig 5818: <dd><dl>
1.90 rillig 5819: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5820: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
5821: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
5822: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
5823: </dl></dd>
5824: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
5825: <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>
5826: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
5827: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
5828: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
5829: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
5830: <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 5831: </dl>
5832: </div>
5833: <p>This chapter describes the framework known as
5834: <code class="literal">pkginstall</code>, whose key features are:</p>
5835: <div class="itemizedlist"><ul type="disc">
5836: <li><p>Generic installation and manipulation of directories and files
5837: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5838: <li><p>Automatic handling of configuration files during installation,
5839: provided that packages are correctly designed.</p></li>
5840: <li><p>Generation and installation of system startup scripts.</p></li>
5841: <li><p>Registration of system users and groups.</p></li>
5842: <li><p>Registration of system shells.</p></li>
5843: <li><p>Automatic updating of fonts databases.</p></li>
5844: </ul></div>
5845: <p>The following sections inspect each of the above points in detail.</p>
5846: <p>You may be thinking that many of the things described here could be
5847: easily done with simple code in the package's post-installation target
5848: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5849: as the code in them is only executed when building from source. Machines
5850: using binary packages could not benefit from it at all (as the code itself
5851: could be unavailable). Therefore, the only way to achieve any of the items
5852: described above is by means of the installation scripts, which are
5853: automatically generated by pkginstall.</p>
5854: <div class="sect1" lang="en">
5855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5856: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5857: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5858: of files and directories that belong to a package. The names used in it
1.76 rillig 5859: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5860: which means that it cannot register files outside this directory (absolute
5861: path names are not allowed). Despite this restriction, some packages need
5862: to install files outside this location; e.g., under
1.76 rillig 5863: <code class="filename">${VARBASE}</code> or
1.87 wiz 5864: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5865: is to create such files during installation time by using
5866: installation scripts.</p>
5867: <p>The generic installation scripts are shell scripts that can
5868: contain arbitrary code. The list of scripts to execute is taken from
5869: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5870: <code class="filename">INSTALL</code>. A similar variable exists for package
5871: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5872: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5873: commands, so they have the potential to create and manage files
5874: anywhere in the file system.</p>
5875: <p>Using these general installation files is not recommended, but
5876: may be needed in some special cases. One reason for avoiding them is
5877: that the user has to trust the packager that there is no unwanted or
5878: simply erroneous code included in the installation script. Also,
5879: previously there were many similar scripts for the same functionality,
5880: and fixing a common error involved finding and changing all of
5881: them.</p>
5882: <p>The pkginstall framework offers another, standardized way. It
5883: provides generic scripts to abstract the manipulation of such files
5884: and directories based on variables set in the package's
5885: <code class="filename">Makefile</code>. The rest of this section describes
5886: these variables.</p>
1.75 rillig 5887: <div class="sect2" lang="en">
5888: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5889: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5890: <p>The following variables can be set to request the creation of
5891: directories anywhere in the file system:</p>
5892: <div class="itemizedlist"><ul type="disc">
5893: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5894: contain a list of directories that should be created and should attempt
5895: to be destroyed by the installation scripts. The difference between
5896: the two is that the latter prompts the administrator to remove any
5897: directories that may be left after deinstallation (because they were
5898: not empty), while the former does not.</p></li>
5899: <li>
5900: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5901: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5902: which directories should be created and should attempt to be destroyed
5903: by the installation scripts. Each tuple holds the following values,
5904: separated by spaces: the directory name, its owner, its group and its
5905: numerical mode. For example:</p>
5906: <pre class="programlisting">
5907: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5908: </pre>
1.75 rillig 5909: <p>The difference between the two is exactly the same as their
5910: non-<code class="varname">PERMS</code> counterparts.</p>
5911: </li>
5912: </ul></div>
5913: </div>
5914: <div class="sect2" lang="en">
5915: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5916: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5917: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5918: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5919: To overcome this problem, the only solution is to extract the file in the
5920: known place (i.e., inside the installation prefix) and copy it to the
5921: appropriate location during installation (done by the installation scripts
5922: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5923: file</em></span> in the following paragraphs, which describe the variables
5924: that can be used to automatically and consistently handle files outside the
5925: installation prefix:</p>
5926: <div class="itemizedlist"><ul type="disc">
5927: <li>
5928: <p><code class="varname">CONF_FILES</code> and
5929: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5930: During installation time, the master file is copied to the target one
5931: if and only if the latter does not exist. Upon deinstallation, the
5932: target file is removed provided that it was not modified by the
5933: installation.</p>
5934: <p>The difference between the two is that the latter prompts the
5935: administrator to remove any files that may be left after
5936: deinstallation (because they were not empty), while the former does
5937: not.</p>
5938: </li>
5939: <li>
5940: <p><code class="varname">CONF_FILES_PERMS</code> and
5941: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5942: files as well as their target locations. For each of them, it also
5943: specifies their owner, their group and their numeric permissions, in
5944: this order. For example:</p>
5945: <pre class="programlisting">
5946: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5947: </pre>
1.75 rillig 5948: <p>The difference between the two is exactly the same as their
5949: non-<code class="varname">PERMS</code> counterparts.</p>
5950: </li>
5951: </ul></div>
5952: </div>
5953: </div>
5954: <div class="sect1" lang="en">
5955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5956: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75 rillig 5957: <p>Configuration files are special in the sense that they are installed
5958: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5959: need special treatment during installation (most of which is automated by
5960: pkginstall). The main concept you must bear in mind is that files marked
5961: as configuration files are automatically copied to the right place (somewhere
5962: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5963: and only if</em></span> they didn't exist before. Similarly, they will not
5964: be removed if they have local modifications. This ensures that
5965: administrators never lose any custom changes they may have made.</p>
5966: <div class="sect2" lang="en">
5967: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5968: <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 5969: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5970: specifies where configuration files shall be installed. Its contents are
5971: set based upon the following variables:</p>
5972: <div class="itemizedlist"><ul type="disc">
5973: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5974: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5975: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5976: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5977: Packages must not use it directly.</p></li>
5978: <li>
5979: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5980: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5981: for the package being built shall be installed. The definition of this
5982: variable only makes sense in the package's
1.76 rillig 5983: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5984: <p>As an example, consider the Apache package,
1.91 rillig 5985: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache2/README.html" target="_top"><code class="filename">www/apache2</code></a>, which places its
1.75 rillig 5986: configuration files under the
1.76 rillig 5987: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5988: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5989: Makefile.</p>
5990: </li>
5991: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5992: variable that holds this package's configuration directory (if
5993: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5994: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5995: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5996: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5997: directory where the configuration files for the package identified by
5998: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5999: </ul></div>
6000: <p>Based on the above variables, pkginstall determines the value of
6001: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6002: variable that can be used within a package to refer to its configuration
6003: directory. The algorithm used to set its value is basically the
6004: following:</p>
6005: <div class="orderedlist"><ol type="1">
6006: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
6007: its value is used.</p></li>
6008: <li><p>If the previous variable is not defined but
6009: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 6010: <code class="filename">Makefile</code>, the resulting value is
6011: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 6012: <li><p>Otherwise, it is set to
1.76 rillig 6013: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 6014: </ol></div>
1.76 rillig 6015: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90 rillig 6016: 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 6017: </div>
6018: <div class="sect2" lang="en">
6019: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6020: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 6021: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6022: known place, you need to teach each package where it shall install its
6023: files. In some cases you will have to patch the package Makefiles to
6024: achieve it. If you are lucky, though, it may be as easy as passing an
6025: extra flag to the configuration script; this is the case of GNU Autoconf-
6026: generated files:</p>
6027: <pre class="programlisting">
6028: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 6029: </pre>
1.75 rillig 6030: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6031: for</em></span> its configuration files, not where they will be originally
6032: installed (although the difference is never explicit,
6033: unfortunately).</p>
6034: </div>
6035: <div class="sect2" lang="en">
6036: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6037: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6038: <p>As said before, pkginstall automatically handles configuration files.
6039: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6040: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6041: directly</strong></span>. Bad news is that many software installation scripts
6042: will, out of the box, mess with the contents of that directory. So what is
6043: the correct procedure to fix this issue?</p>
6044: <p>You must teach the package (usually by manually patching it) to
6045: install any configuration files under the examples hierarchy,
1.76 rillig 6046: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6047: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6048: has the original copies available.</p>
6049: <p>Once the required configuration files are in place (i.e., under the
6050: examples hierarchy), the pkginstall framework can use them as master copies
6051: during the package installation to update what is in
1.76 rillig 6052: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6053: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90 rillig 6054: 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 6055: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6056: <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 6057: <pre class="programlisting">
6058: EGDIR= ${PREFIX}/share/doc/mutt/samples
6059: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6060: </pre>
1.75 rillig 6061: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6062: package and has no meaning outside it.</p>
6063: </div>
6064: <div class="sect2" lang="en">
6065: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6066: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6067: <p>The automatic copying of config files can be toggled by setting the
6068: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6069: installation.</p>
6070: </div>
6071: </div>
6072: <div class="sect1" lang="en">
6073: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6074: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75 rillig 6075: <p>System startup scripts are special files because they must be
6076: installed in a place known by the underlying OS, usually outside the
1.90 rillig 6077: 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 6078: can be used. However, pkginstall provides a special mechanism to handle
6079: these files.</p>
6080: <p>In order to provide system startup scripts, the package has
6081: to:</p>
6082: <div class="orderedlist"><ol type="1">
1.76 rillig 6083: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6084: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6085: <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 6086: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6087: <li>
6088: <p>Tell pkginstall to handle it, appending the name of the script,
6089: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6090: Continuing the previous example:</p>
6091: <pre class="programlisting">
6092: RCD_SCRIPTS+= cupsd
1.1 grant 6093: </pre>
1.75 rillig 6094: </li>
6095: </ol></div>
6096: <p>Once this is done, pkginstall will do the following steps for each
6097: script in an automated fashion:</p>
6098: <div class="orderedlist"><ol type="1">
6099: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6100: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6101: variable.</p></li>
6102: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6103: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6104: that this master file must be explicitly registered in the
1.76 rillig 6105: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6106: <li><p>Add code to the installation scripts to copy the startup script
6107: from the examples hierarchy into the system-wide startup scripts
6108: directory.</p></li>
6109: </ol></div>
6110: <div class="sect2" lang="en">
6111: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6112: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6113: <p>The automatic copying of config files can be toggled by setting the
6114: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6115: installation. Note that the scripts will be always copied inside the
1.76 rillig 6116: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6117: matter what the value of this variable is.</p>
6118: </div>
6119: </div>
6120: <div class="sect1" lang="en">
6121: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6122: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75 rillig 6123: <p>If a package needs to create special users and/or groups during
6124: installation, it can do so by using the pkginstall framework.</p>
6125: <p>Users can be created by adding entries to the
6126: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6127: syntax:</p>
6128: <pre class="programlisting">
6129: user:group
1.1 grant 6130: </pre>
1.87 wiz 6131: <p>Further specification of user details may be done by setting
6132: per-user variables.
6133: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6134: numeric UID for the user.
6135: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6136: user's description or comment.
6137: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6138: user's home directory, and defaults to
6139: <code class="filename">/nonexistent</code> if not specified.
6140: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6141: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6142: not specified.</p>
1.75 rillig 6143: <p>Similarly, groups can be created by adding entries to the
6144: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6145: <pre class="programlisting">
6146: group
1.1 grant 6147: </pre>
1.93 rillig 6148: <p>The numeric GID of the group may be set by defining
1.75 rillig 6149: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6150: <p>If a package needs to create the users and groups at an earlier
6151: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6152: either <code class="literal">configure</code> or <code class="literal">build</code> to
6153: indicate the phase before which the users and groups are created. In
6154: this case, the numeric UIDs and GIDs of the created users and groups
6155: are automatically hardcoded into the final installation scripts.</p>
6156: </div>
6157: <div class="sect1" lang="en">
6158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6159: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75 rillig 6160: <p>Packages that install system shells should register them in the shell
1.76 rillig 6161: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6162: administrator. This must be done from the installation scripts to keep
6163: binary packages working on any system. pkginstall provides an easy way to
6164: accomplish this task.</p>
6165: <p>When a package provides a shell interpreter, it has to set the
6166: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6167: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6168: 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 6169: <pre class="programlisting">
6170: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6171: </pre>
1.75 rillig 6172: <div class="sect2" lang="en">
6173: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6174: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6175: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6176: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6177: environment variable to <code class="literal">NO</code>.</p>
6178: </div>
6179: </div>
6180: <div class="sect1" lang="en">
6181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6182: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75 rillig 6183: <p>Packages that install X11 fonts should update the database files
6184: that index the fonts within each fonts directory. This can easily be
6185: accomplished within the pkginstall framework.</p>
6186: <p>When a package installs X11 fonts, it must list the directories in
6187: which fonts are installed in the
6188: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6189: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6190: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6191: installation scripts to run the appropriate commands to update the fonts
6192: database files within each of those directories. For convenience, if the
6193: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6194: 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 6195: <pre class="programlisting">
6196: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6197: </pre>
1.75 rillig 6198: <div class="sect2" lang="en">
6199: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6200: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6201: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6202: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6203: environment variable to <code class="literal">NO</code>.</p>
6204: </div>
6205: </div>
6206: </div>
6207: <div class="chapter" lang="en">
6208: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6209: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75 rillig 6210: <div class="toc">
6211: <p><b>Table of Contents</b></p>
6212: <dl>
1.90 rillig 6213: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
6214: <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>
6215: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75 rillig 6216: </dl>
6217: </div>
6218: <p>Many packages have the ability to be built to support different
1.76 rillig 6219: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6220: in pkgsrc that provides generic handling of those options that
6221: determine different ways in which the packages can be built. It's
6222: possible for the user to specify exactly which sets of options will be
6223: built into a package or to allow a set of global default options
6224: apply.</p>
6225: <div class="sect1" lang="en">
6226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6227: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75 rillig 6228: <p>Global default options are listed in
6229: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6230: that should be built into every package if that option is supported.
1.76 rillig 6231: This variable should be set in <code class="filename">/etc/mk.conf</code>.</p>
1.75 rillig 6232: </div>
6233: <div class="sect1" lang="en">
6234: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 6235: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code>
6236: </h2></div></div></div>
1.75 rillig 6237: <p>The following example shows how
1.76 rillig 6238: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6239: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6240: <code class="filename">Makefile</code>, or in a file,
6241: e.g. <code class="filename">options.mk</code>, that is included by the
6242: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6243: <pre class="programlisting">
6244: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6245: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6246: PKG_OPTIONS_OPTIONAL_GROUPS= database
6247: PKG_OPTIONS_GROUP.database= mysql pgsql
6248: PKG_SUGGESTED_OPTIONS= wibble-foo
6249: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6250: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
1.1 grant 6251:
1.75 rillig 6252: .include "../../mk/bsd.prefs.mk"
1.69 rillig 6253:
1.75 rillig 6254: # this package was previously named wibble2
6255: .if defined(PKG_OPTIONS.wibble2)
6256: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6257: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
1.78 rillig 6258: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
1.75 rillig 6259: .endif
1.69 rillig 6260:
1.75 rillig 6261: .include "../../mk/bsd.options.mk"
1.69 rillig 6262:
1.75 rillig 6263: # Package-specific option-handling
1.69 rillig 6264:
1.75 rillig 6265: ###
6266: ### FOO support
6267: ###
6268: .if !empty(PKG_OPTIONS:Mwibble-foo)
6269: CONFIGURE_ARGS+= --enable-foo
6270: .endif
1.69 rillig 6271:
1.75 rillig 6272: ###
6273: ### LDAP support
6274: ###
6275: .if !empty(PKG_OPTIONS:Mldap)
1.77 rillig 6276: . include "../../databases/openldap-client/buildlink3.mk"
6277: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
1.75 rillig 6278: .endif
1.69 rillig 6279:
1.75 rillig 6280: ###
6281: ### database support
6282: ###
6283: .if !empty(PKG_OPTIONS:Mmysql)
6284: . include "../../mk/mysql.buildlink3.mk"
6285: .endif
6286: .if !empty(PKG_OPTIONS:Mpgsql)
6287: . include "../../mk/pgsql.buildlink3.mk"
6288: .endif
6289: </pre>
6290: <p>The first section contains the information about which build
6291: options are supported by the package, and any default options settings
6292: if needed.</p>
6293: <div class="orderedlist"><ol type="1">
6294: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6295: <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
6296: options. It should be set to
1.78 rillig 6297: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6298: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6299: at the point where the options are processed.</p></li>
1.75 rillig 6300: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6301: build options supported by the package.</p></li>
6302: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6303: list of names of groups of mutually exclusive options. The options in
6304: each group are listed in
6305: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6306: The most specific setting of any option from the group takes
6307: precedence over all other options in the group. Options from the
6308: groups will be automatically added to
6309: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6310: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6311: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6312: packages will fail if no option from the group is
6313: selected.</p></li>
6314: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6315: of names of sets of options. At least one option from each set must
6316: be selected. The options in each set are listed in
6317: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6318: Options from the sets will be automatically added to
6319: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6320: fail if no option from the set is selected.</p></li>
6321: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6322: build options which are enabled by default.</p></li>
6323: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6324: of
6325: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.76 rillig 6326: pairs that map legacy <code class="filename">/etc/mk.conf</code> variables to
1.75 rillig 6327: their option counterparts. Pairs should be added with
6328: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6329: warning will be issued if the user uses a legacy
6330: variable.</p></li>
6331: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6332: of
6333: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6334: pairs that map options that have been renamed to their new
6335: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6336: the listing of global legacy options. A warning will be issued if
6337: the user uses a legacy option.</p></li>
6338: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6339: options implied by deprecated variables used. This can be used for
6340: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6341: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6342: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6343: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6344: a list of warnings about deprecated variables or options used, and
6345: what to use instead.</p></li>
6346: </ol></div>
6347: <p>A package should never modify
6348: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6349: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6350: To suggest a default set of options, use
6351: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6352: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6353: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6354: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6355: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6356: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6357: happen with platform-specific options if none of them is supported on
6358: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6359: empty list and the package is otherwise treated as not using the
6360: options framework.</p>
1.76 rillig 6361: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6362: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6363: build options, properly filtered to remove unsupported and duplicate
6364: options.</p>
6365: <p>The remaining sections contain the logic that is specific to
6366: each option. The correct way to check for an option is to check
6367: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6368: <pre class="programlisting">
6369: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6370: </pre>
6371: </div>
6372: <div class="sect1" lang="en">
6373: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6374: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75 rillig 6375: <p>Options that enable similar features in different packages (like
6376: optional support for a library) should use a common name in all
6377: packages that support it (like the name of the library). If another
6378: package already has an option with the same meaning, use the same
6379: name.</p>
6380: <p>Options that enable features specific to one package, where it's
6381: unlikely that another (unrelated) package has the same (or a similar)
6382: optional feature, should use a name prefixed with
6383: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6384: <p>If a group of related packages share an optional feature
6385: specific to that group, prefix it with the name of the
6386: “<span class="quote">main</span>” package
6387: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6388: <p>For new options, add a line to
1.76 rillig 6389: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6390: fields, separated by tab. The first field is the option name, the
6391: second its description. The description should be a whole sentence
6392: (starting with an uppercase letter and ending with a period) that
6393: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6394: support.</span>” The file is sorted by option names.</p>
6395: </div>
6396: </div>
6397: <div class="chapter" lang="en">
6398: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6399: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75 rillig 6400: <div class="toc">
6401: <p><b>Table of Contents</b></p>
6402: <dl>
1.90 rillig 6403: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
6404: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
6405: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
6406: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
6407: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6408: <dd><dl>
6409: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
6410: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
6411: </dl></dd>
6412: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6413: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6414: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6415: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6416: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6417: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6418: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6419: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6420: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6421: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6422: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
6423: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75 rillig 6424: </dl>
6425: </div>
6426: <div class="sect1" lang="en">
6427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6428: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75 rillig 6429: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6430: built. Building a package is separated into different
6431: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6432: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6433: described in the following sections. Each phase is splitted into
6434: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6435: containing phase, prefixed by one of <code class="varname">pre-</code>,
6436: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6437: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6438: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6439: <p>Never override the regular targets (like
6440: <code class="varname">fetch</code>), if you have to, override the
6441: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6442: <p>The basic steps for building a program are always the same. First
1.87 wiz 6443: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6444: the local system and then extracted. After any pkgsrc-specific patches
6445: to compile properly are applied, the software can be configured, then
6446: built (usually by compiling), and finally the generated binaries, etc.
6447: can be put into place on the system.</p>
1.97 rillig 6448: <p>To get more details about what is happening at each step,
6449: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6450: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6451: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6452: </div>
6453: <div class="sect1" lang="en">
6454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6455: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75 rillig 6456: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6457: the next section, here's a brief discussion on where programs are
6458: installed, and which variables influence this.</p>
1.75 rillig 6459: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6460: where all files of the final program shall be installed. It is
6461: usually set to <code class="varname">LOCALBASE</code>
6462: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6463: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6464: <code class="varname">PREFIX</code> needs to be put
6465: into the various places in the program's source where paths to
1.90 rillig 6466: 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 6467: <p>When choosing which of these variables to use,
1.87 wiz 6468: follow the following rules:</p>
1.75 rillig 6469: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6470: <li><p><code class="varname">PREFIX</code> always points to the location
6471: where the current pkg will be installed. When referring to a
6472: pkg's own installation path, use
6473: “<span class="quote">${PREFIX}</span>”.</p></li>
6474: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6475: are installed. If you need to construct a -I or -L argument
6476: to the compiler to find includes and libraries installed by
6477: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6478: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6479: installed all packages in <code class="filename">/usr/local</code>. As
6480: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6481: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6482: <li><p><code class="varname">X11BASE</code> is where the actual X11
6483: distribution (from xsrc, etc.) is installed. When looking for
6484: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6485: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6486: <li>
6487: <p>X11-based packages are special in that they may be
6488: installed in either <code class="varname">X11BASE</code> or
6489: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6490: <p>Usually, X11 packages should be installed under
1.88 wiz 6491: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6492: will need to include
6493: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6494: request the presence of X11 and to get the right compilation
6495: flags.</p>
1.75 rillig 6496: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6497: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6498: files. These packages are special and they must be placed under
6499: <code class="varname">X11BASE</code>. To accomplish this, set either
6500: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6501: your package.</p>
1.75 rillig 6502: <p>Some notes: If you need
1.87 wiz 6503: to find includes or libraries installed by a pkg that has
6504: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6505: its pkg <code class="filename">Makefile</code>, you need to look in
6506: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6507: <code class="filename">${LOCALBASE}</code>. To force installation of
6508: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6509: <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 6510: is enabled by default.</p>
1.75 rillig 6511: </li>
1.88 wiz 6512: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6513: the installed location of an X11
6514: package. <code class="varname">X11PREFIX</code> will be set to
6515: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6516: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6517: installed.</p></li>
6518: <li>
6519: <p>If xpkgwedge is installed, it is possible to have some
6520: packages installed in <code class="varname">X11BASE</code> and some in
6521: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6522: installed package, the <code class="varname">EVAL_PREFIX</code>
6523: definition can be used. It takes pairs in the format
6524: “<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>
6525: variable <code class="varname">DIRNAME</code> will be set to the prefix
6526: of the installed package <package>, or
6527: “<span class="quote">${X11PREFIX}</span>” if the package is not
6528: installed.</p>
1.75 rillig 6529: <p>This is best illustrated by example.</p>
6530: <p>The following lines are taken from
1.87 wiz 6531: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6532: <pre class="programlisting">
1.87 wiz 6533: EVAL_PREFIX+= GTKDIR=gtk+
6534: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6535: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6536: CONFIGURE_ARGS+= --enable-multibyte
6537: </pre>
1.88 wiz 6538: <p>Specific defaults can be defined for the packages
6539: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6540: definition of the form:</p>
1.75 rillig 6541: <pre class="programlisting">
1.87 wiz 6542: GTKDIR_DEFAULT= ${LOCALBASE}
6543: </pre>
1.75 rillig 6544: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6545: to the first definition in
6546: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6547: </li>
1.76 rillig 6548: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87 wiz 6549: 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
6550: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6551: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6552: </ul></div>
6553: </div>
6554: <div class="sect1" lang="en">
6555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6556: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75 rillig 6557: <p>When building a package, a number of directories is used to store
1.87 wiz 6558: source files, temporary files, pkgsrc-internal files, and so on. These
6559: directories are explained here.</p>
1.75 rillig 6560: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6561: are two common base directories for these relative directories:
6562: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6563: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6564: inside the package itself.</p>
1.75 rillig 6565: <div class="variablelist"><dl>
6566: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6567: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6568: root directory. Generally, you don't need
6569: it.</p></dd>
1.97 rillig 6570: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6571: <dd><p>This is an absolute pathname that points to the
6572: current package.</p></dd>
1.75 rillig 6573: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6574: <dd><p>This is a pathname relative to
1.87 wiz 6575: <code class="varname">PKGSRCDIR</code> that points to the current
6576: package.</p></dd>
1.75 rillig 6577: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6578: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6579: where all work takes place. The distfiles are extracted to this
1.87 wiz 6580: directory. It also contains temporary directories and log files used by
6581: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6582: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6583: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6584: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6585: where the distfiles are extracted. It is usually a direct subdirectory
6586: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6587: that isn't hidden. This variable may be changed by a package
6588: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6589: </dl></div>
6590: </div>
6591: <div class="sect1" lang="en">
6592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6593: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75 rillig 6594: <p>You can run a particular phase by typing <span><strong class="command">make
1.87 wiz 6595: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6596: phase. This will automatically run all phases that are required for this
6597: phase. The default phase is <code class="varname">build</code>, that is, when you
6598: run <span><strong class="command">make</strong></span> without parameters in a package directory,
6599: the package will be built, but not installed.</p>
1.75 rillig 6600: </div>
6601: <div class="sect1" lang="en">
6602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6603: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6604: <p>The first step in building a package is to fetch the
1.88 wiz 6605: distribution files (distfiles) from the sites that are providing
6606: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6607: phase.</p>
1.81 rillig 6608: <div class="sect2" lang="en">
6609: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6610: <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 6611: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6612: defines all URLs from where the distfile, whose name is
6613: derived from the <code class="varname">DISTNAME</code> variable, is
6614: fetched. The more complicated cases are described
6615: below.</p>
6616: <p>The variable <code class="varname">DISTFILES</code> specifies
6617: the list of distfiles that have to be fetched. Its value
6618: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6619: so that most packages don't need to define it at all.
6620: <code class="varname">EXTRACT_SUFX</code> is
6621: <code class="literal">.tar.gz</code> by default, but can be changed
6622: freely. Note that if your package requires additional
6623: distfiles to the default one, you cannot just append the
6624: additional filenames using the <code class="literal">+=</code>
6625: operator, but you have write for example:</p>
1.81 rillig 6626: <pre class="programlisting">
1.88 wiz 6627: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6628: </pre>
6629: <p>Each distfile is fetched from a list of sites, usually
6630: <code class="varname">MASTER_SITES</code>. If the package has multiple
6631: <code class="varname">DISTFILES</code> or multiple
6632: <code class="varname">PATCHFILES</code> from different sites, you can
6633: set
6634: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6635: to the list of URLs where the file
6636: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6637: (including the suffix) can be found.</p>
6638: <pre class="programlisting">
6639: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6640: DISTFILES+= foo-file.tar.gz
6641: SITES.foo-file.tar.gz= \
6642: http://www.somewhere.com/somehow/ \
6643: http://www.somewhereelse.com/mirror/somehow/
6644: </pre>
1.81 rillig 6645: <p>When actually fetching the distfiles, each item from
1.88 wiz 6646: <code class="varname">MASTER_SITES</code> or
6647: <code class="varname">SITES.*</code> gets the name of each distfile
6648: appended to it, without an intermediate slash. Therefore,
6649: all site values have to end with a slash or other separator
6650: character. This allows for example to set
6651: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6652: that gets the name of the distfile as a parameter. In this
6653: case, the definition would look like:</p>
1.81 rillig 6654: <pre class="programlisting">
1.88 wiz 6655: MASTER_SITES= http://www.example.com/download.cgi?file=
6656: </pre>
1.81 rillig 6657: <p>There are some predefined values for
1.88 wiz 6658: <code class="varname">MASTER_SITES</code>, which can be used in
6659: packages. The names of the variables should speak for
6660: themselves.</p>
6661: <pre class="programlisting">
6662: ${MASTER_SITE_APACHE}
6663: ${MASTER_SITE_BACKUP}
6664: ${MASTER_SITE_CYGWIN}
6665: ${MASTER_SITE_DEBIAN}
6666: ${MASTER_SITE_FREEBSD}
6667: ${MASTER_SITE_FREEBSD_LOCAL}
1.93 rillig 6668: ${MASTER_SITE_GENTOO}
1.88 wiz 6669: ${MASTER_SITE_GNOME}
6670: ${MASTER_SITE_GNU}
6671: ${MASTER_SITE_GNUSTEP}
6672: ${MASTER_SITE_IFARCHIVE}
6673: ${MASTER_SITE_KDE}
6674: ${MASTER_SITE_MOZILLA}
6675: ${MASTER_SITE_MYSQL}
6676: ${MASTER_SITE_OPENOFFICE}
6677: ${MASTER_SITE_PERL_CPAN}
6678: ${MASTER_SITE_PGSQL}
6679: ${MASTER_SITE_R_CRAN}
6680: ${MASTER_SITE_SOURCEFORGE}
6681: ${MASTER_SITE_SOURCEFORGE_JP}
6682: ${MASTER_SITE_SUNSITE}
6683: ${MASTER_SITE_SUSE}
6684: ${MASTER_SITE_TEX_CTAN}
6685: ${MASTER_SITE_XCONTRIB}
6686: ${MASTER_SITE_XEMACS}
6687: </pre>
6688: <p>Some explanations for the less self-explaining ones:
6689: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.93 rillig 6690: 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
6691: 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 6692: <p>If you choose one of these predefined sites, you may
6693: want to specify a subdirectory of that site. Since these
6694: macros may expand to more than one actual site, you
6695: <span class="emphasis"><em>must</em></span> use the following construct to
6696: specify a subdirectory:</p>
1.81 rillig 6697: <pre class="programlisting">
1.88 wiz 6698: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6699: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6700: </pre>
1.81 rillig 6701: <p>Note the trailing slash after the subdirectory
1.88 wiz 6702: name.</p>
1.81 rillig 6703: </div>
6704: <div class="sect2" lang="en">
6705: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6706: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6707: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6708: all the distfiles exist in a local directory
1.93 rillig 6709: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6710: user). If the files do not exist, they are fetched using
6711: commands of the form</p>
1.75 rillig 6712: <pre class="programlisting">
1.88 wiz 6713: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6714: </pre>
6715: <p>where <code class="literal">${site}</code> varies through
6716: several possibilities in turn: first,
6717: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6718: sites specified in either <code class="varname">SITES.file</code> if
6719: defined, else <code class="varname">MASTER_SITES</code> or
6720: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6721: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6722: all except the first and the last can be optionally sorted
6723: by the user, via setting either
6724: <code class="varname">MASTER_SORT_RANDOM</code>, and
6725: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6726: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.97 rillig 6727: <p>The distfiles mirror run by the NetBSD Foundation uses the
6728: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6729: distfiles, if they are freely distributable. Packages setting
6730: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6731: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6732: mirrored.</p>
1.81 rillig 6733: </div>
1.75 rillig 6734: </div>
6735: <div class="sect1" lang="en">
6736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6737: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6738: <p>After the distfile(s) are fetched, their checksum is
6739: generated and compared with the checksums stored in the
6740: distinfo file. If the checksums don't match, the build is
6741: aborted. This is to ensure the same distfile is used for
6742: building, and that the distfile wasn't changed, e.g. by some
6743: malign force, deliberately changed distfiles on the master
6744: distribution site or network lossage.</p>
1.75 rillig 6745: </div>
6746: <div class="sect1" lang="en">
6747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6748: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6749: <p>When the distfiles are present on the local system, they
1.88 wiz 6750: need to be extracted, as they usually come in the form of some
6751: compressed archive format.</p>
1.75 rillig 6752: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6753: extracted. If you only need some of them, you can set the
6754: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6755: files.</p>
6756: <p>Extracting the files is usually done by a little
1.93 rillig 6757: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6758: already knows how to extract various archive formats, so most
6759: likely you will not need to change anything here. But if you
6760: need, the following variables may help you:</p>
1.75 rillig 6761: <div class="variablelist"><dl>
6762: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6763: <dd><p>Use these variables to override the default
1.88 wiz 6764: options for an extract command, which are defined in
1.93 rillig 6765: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6766: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6767: <dd><p>This variable can be set to
1.93 rillig 6768: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
6769: default value), <code class="literal">pax</code>, or an
1.88 wiz 6770: absolute pathname pointing to the command with which tar
6771: archives should be
6772: extracted.</p></dd>
1.75 rillig 6773: </dl></div>
1.88 wiz 6774: <p>If the <code class="filename">extract</code> program doesn't
6775: serve your needs, you can also override the
6776: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6777: command used for extracting the files. This command is
6778: executed in the <code class="filename">${WRKSRC}</code>
6779: directory. During execution of this command, the shell
6780: variable <code class="varname">extract_file</code> holds the absolute
6781: pathname of the file that is going to be extracted.</p>
1.75 rillig 6782: <p>And if that still does not suffice, you can override the
1.88 wiz 6783: <code class="varname">do-extract</code> target in the package
6784: Makefile.</p>
1.75 rillig 6785: </div>
6786: <div class="sect1" lang="en">
6787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6788: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6789: <p>After extraction, all the patches named by the
1.88 wiz 6790: <code class="varname">PATCHFILES</code>, those present in the patches
6791: subdirectory of the package as well as in
6792: $LOCALPATCHES/$PKGPATH (e.g.
6793: <code class="filename">/usr/local/patches/graphics/png</code>) are
6794: applied. Patchfiles ending in <code class="filename">.Z</code> or
6795: <code class="filename">.gz</code> are uncompressed before they are
6796: applied, files ending in <code class="filename">.orig</code> or
6797: <code class="filename">.rej</code> are ignored. Any special options to
6798: <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 6799: <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 6800: <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
6801: it fail if the patches apply with some lines of fuzz. Please
6802: fix (regen) the patches so that they apply cleanly. The
6803: rationale behind this is that patches that don't apply cleanly
6804: may end up being applied in the wrong place, and cause severe
6805: harm there.</p>
1.75 rillig 6806: </div>
6807: <div class="sect1" lang="en">
6808: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6809: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6810: <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 6811: </p>
1.75 rillig 6812: </div>
6813: <div class="sect1" lang="en">
6814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6815: <a name="build.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6816: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6817: linkers. The following variables can be used to tweak the
6818: wrappers.</p>
1.75 rillig 6819: <div class="variablelist"><dl>
6820: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6821: <dd><p>The command used to print progress
1.88 wiz 6822: messages. Does nothing by default. Set to
6823: <code class="literal">${ECHO}</code> to see the progress
6824: messages.</p></dd>
1.75 rillig 6825: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6826: <dd><p>This variable can be set to
1.88 wiz 6827: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6828: depending on whether you want additional information in the
6829: wrapper log file.</p></dd>
1.75 rillig 6830: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6831: <dd><p>This variable can be set to
1.88 wiz 6832: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6833: on whether the wrapper should use its cache, which will
6834: improve the speed. The default value is
6835: <code class="literal">yes</code>, but is forced to
6836: <code class="literal">no</code> if the platform does not support
6837: it.</p></dd>
1.75 rillig 6838: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6839: <dd><p>A list of reordering commands. A reordering
6840: command has the form
6841: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6842: It ensures that that
6843: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6844: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6845: </p></dd>
1.75 rillig 6846: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6847: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6848: investigate further]</p></dd>
1.75 rillig 6849: </dl></div>
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.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6854: <p>Most pieces of software need information on the header
6855: files, system calls, and library routines which are available
6856: on the platform they run on. The process of determining this
6857: information is known as configuration, and is usually
6858: automated. In most cases, a script is supplied with the
6859: distfiles, and its invocation results in generation of header
6860: files, Makefiles, etc.</p>
6861: <p>If the package contains a configure script, this can be
6862: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6863: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6864: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6865: “<span class="quote">yes</span>” instead. What happens in the
6866: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6867: <pre class="programlisting">
6868: .for d in ${CONFIGURE_DIRS}
6869: cd ${WRKSRC} && cd ${d} && env ${CONFIGURE_ENV} \
6870: ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6871: .endfor
6872: </pre>
6873: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6874: “<span class="quote">.</span>”) is a list of pathnames relative to
6875: <code class="varname">WRKSRC</code>. In each of these directories, the
6876: configure script is run with the environment
6877: <code class="varname">CONFIGURE_ENV</code> and arguments
6878: <code class="varname">CONFIGURE_ARGS</code>. The variables
6879: <code class="varname">CONFIGURE_ENV</code>,
6880: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6881: “<span class="quote">./configure</span>”) and
6882: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6883: package.</p>
6884: <p>If the program uses an <code class="filename">Imakefile</code>
6885: for configuration, the appropriate steps can be invoked by
6886: setting <code class="varname">USE_IMAKE</code> to
6887: “<span class="quote">yes</span>”. (If you only want the package installed in
6888: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6889: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6890: xmkmf's environment by adding them to the
6891: <code class="varname">SCRIPTS_ENV</code> variable.</p>
6892: <p>If there is no configure step at all, set
6893: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6894: </div>
6895: <div class="sect1" lang="en">
6896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6897: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6898: <p>For building a package, a rough equivalent of the
6899: following code is executed.</p>
1.75 rillig 6900: <pre class="programlisting">
1.88 wiz 6901: .for d in ${BUILD_DIRS}
6902: cd ${WRKSRC} && cd ${d} && env ${MAKE_ENV} \
6903: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6904: -f ${MAKE_FILE} ${BUILD_TARGET}
6905: .endfor
6906: </pre>
6907: <p><code class="varname">BUILD_DIRS</code> (default:
6908: “<span class="quote">.</span>”) is a list of pathnames relative to
6909: <code class="varname">WRKSRC</code>. In each of these directories,
6910: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6911: <code class="varname">MAKE_ENV</code> and arguments
6912: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6913: <code class="varname">MAKE_ENV</code>,
6914: <code class="varname">BUILD_MAKE_FLAGS</code>,
6915: <code class="varname">MAKE_FILE</code> and
6916: <code class="varname">BUILD_TARGET</code> may all be changed by the
6917: package.</p>
1.75 rillig 6918: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6919: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6920: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6921: default value of <code class="varname">MAKE_FILE</code> is
6922: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6923: defaults to “<span class="quote">all</span>”.</p>
1.97 rillig 6924: <p>If there is no build step at all, set
6925: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6926: </div>
6927: <div class="sect1" lang="en">
6928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6929: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6930: <p>[TODO]</p>
6931: </div>
6932: <div class="sect1" lang="en">
6933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6934: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6935: <p>Once the build stage has completed, the final step is to
1.88 wiz 6936: install the software in public directories, so users can
6937: access the programs and files.</p>
1.75 rillig 6938: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6939: equivalent of the following code is executed. Additionally,
6940: before and after this code, much magic is performed to do
6941: consistency checks, registering the package, and so on.</p>
6942: <pre class="programlisting">
6943: .for d in ${INSTALL_DIRS}
6944: cd ${WRKSRC} && cd ${d} && env ${MAKE_ENV} \
6945: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6946: -f ${MAKE_FILE} ${BUILD_TARGET}
6947: .endfor
6948: </pre>
1.75 rillig 6949: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6950: <span class="emphasis"><em>build</em></span> phase.
6951: <code class="varname">INSTALL_DIRS</code> defaults to
6952: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
6953: is “<span class="quote">install</span>” by default, plus
6954: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
6955: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6956: defined.</p>
1.75 rillig 6957: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6958: variables are useful. They are all variations of the
6959: <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
6960: permissions preset. <code class="varname">INSTALL</code> is the plain
6961: install command. The specialized variants, together with their
6962: intended use, are:</p>
1.75 rillig 6963: <div class="variablelist"><dl>
6964: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6965: <dd><p>directories that contain
6966: binaries</p></dd>
1.75 rillig 6967: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6968: <dd><p>directories that contain
6969: scripts</p></dd>
1.75 rillig 6970: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6971: <dd><p>directories that contain shared and static
6972: libraries</p></dd>
1.75 rillig 6973: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6974: <dd><p>directories that contain data
6975: files</p></dd>
1.75 rillig 6976: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6977: <dd><p>directories that contain man
6978: pages</p></dd>
1.75 rillig 6979: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6980: <dd><p>binaries that can be stripped from debugging
6981: symbols</p></dd>
1.75 rillig 6982: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6983: <dd><p>binaries that cannot be
6984: stripped</p></dd>
1.75 rillig 6985: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6986: <dd><p>game
6987: binaries</p></dd>
1.75 rillig 6988: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6989: <dd><p>shared and static
6990: libraries</p></dd>
1.75 rillig 6991: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6992: <dd><p>data files</p></dd>
6993: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6994: <dd><p>data files for
6995: games</p></dd>
1.75 rillig 6996: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6997: <dd><p>man pages</p></dd>
6998: </dl></div>
6999: <p>Some other variables are:</p>
7000: <div class="variablelist"><dl>
7001: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7002: <dd><p>A list of directories relative to
1.88 wiz 7003: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 ! wiz 7004: beginning of the <span class="emphasis"><em>install</em></span> phase.
! 7005: The package is supposed to create all needed directories itself
! 7006: before installing files to it and list all other directories here.
! 7007: </p></dd>
1.75 rillig 7008: </dl></div>
1.97 rillig 7009: <p>In the rare cases that a package shouldn't install anything,
7010: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
7011: mostly relevant for packages in the <code class="filename">regress</code>
7012: category.</p>
1.75 rillig 7013: </div>
7014: <div class="sect1" lang="en">
7015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7016: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7017: <p>Once the install stage has completed, a binary package of
7018: the installed files can be built. These binary packages can be
7019: used for quick installation without previous compilation, e.g. by
7020: the <span><strong class="command">make bin-install</strong></span> or by using
7021: <span><strong class="command">pkg_add</strong></span>.</p>
7022: <p>By default, the binary packages are created in
7023: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7024: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7025: one for each category in the <code class="varname">CATEGORIES</code>
7026: variable. <code class="varname">PACKAGES</code> defaults to
7027: <code class="filename">pkgsrc/packages</code>.</p>
1.97 rillig 7028: <p>If there should be no binary package, set
7029: <code class="varname">NO_PACKAGE</code> to “<span class="quote">yes</span>”.
7030: This should only be used in rare cases, like when a package
7031: definitely is only usable on the machine where it is built and even
7032: then, a binary package can be useful.</p>
1.88 wiz 7033: </div>
7034: <div class="sect1" lang="en">
7035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7036: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88 wiz 7037: <p>Once you're finished with a package, you can clean the work
7038: directory by running <span><strong class="command">make clean</strong></span>. If you want
7039: to clean the work directories of all dependencies too, use
7040: <span><strong class="command">make clean-depends</strong></span>.</p>
1.75 rillig 7041: </div>
7042: <div class="sect1" lang="en">
7043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7044: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75 rillig 7045: <div class="variablelist"><dl>
7046: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7047: <dd><p>For any of the main targets described in the
7048: previous section, two auxiliary targets exist with
1.87 wiz 7049: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7050: prefix for the main target's name. These targets are
1.88 wiz 7051: invoked before and after the main target is called,
7052: allowing extra configuration or installation steps be
7053: performed from a package's Makefile, for example, which
7054: a program's configure script or install target
7055: omitted.</p></dd>
1.75 rillig 7056: <dt><span class="term">do-*</span></dt>
1.88 wiz 7057: <dd><p>Should one of the main targets do the wrong thing,
7058: and should there be no variable to fix this, you can
7059: redefine it with the do-* target. (Note that redefining
7060: the target itself instead of the do-* target is a bad
7061: idea, as the pre-* and post-* targets won't be called
7062: anymore, etc.) You will not usually need to do
7063: this.</p></dd>
1.75 rillig 7064: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7065: <dd>
7066: <p>If you did a <span><strong class="command">make install</strong></span> and
7067: you noticed some file was not installed properly, you
7068: can repeat the installation with this target, which will
7069: ignore the “<span class="quote">already installed</span>” flag.</p>
7070: <p>This is the default value of
7071: <code class="varname">DEPENDS_TARGET</code> except in the case of
7072: <span><strong class="command">make update</strong></span> and <span><strong class="command">make
7073: package</strong></span>, where the defaults are
7074: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7075: respectively.</p>
7076: </dd>
1.75 rillig 7077: <dt><span class="term">deinstall</span></dt>
7078: <dd>
1.88 wiz 7079: <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
7080: current directory, effectively de-installing the
7081: package. The following variables can be used to tune the
7082: behaviour:</p>
1.75 rillig 7083: <div class="variablelist"><dl>
7084: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7085: <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>
7086: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7087: <dd><p>Remove all packages that require (depend on)
7088: the given package. This can be used to remove any
7089: packages that may have been pulled in by a given
7090: package, e.g. if <span><strong class="command">make deinstall
1.87 wiz 7091: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7092: <code class="filename">pkgsrc/x11/kde</code>, this is
7093: likely to remove whole KDE. Works by adding
7094: “<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>
7095: command line.</p></dd>
1.75 rillig 7096: </dl></div>
7097: </dd>
1.88 wiz 7098: <dt><span class="term">bin-install</span></dt>
7099: <dd><p>Install a binary package from local disk and via FTP
7100: from a list of sites (see the
7101: <code class="varname">BINPKG_SITES</code> variable), and do a
7102: <span><strong class="command">make package</strong></span> if no binary package is
7103: available anywhere. The arguments given to
7104: <span><strong class="command">pkg_add</strong></span> can be set via
7105: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7106: operation, etc.</p></dd>
1.75 rillig 7107: <dt><span class="term">update</span></dt>
7108: <dd>
1.88 wiz 7109: <p>This target causes the current package to be
7110: updated to the latest version. The package and all
7111: depending packages first get de-installed, then current
7112: versions of the corresponding packages get compiled and
7113: installed. This is similar to manually noting which
7114: packages are currently installed, then performing a
7115: series of <span><strong class="command">make deinstall</strong></span> and
7116: <span><strong class="command">make install</strong></span> (or whatever
7117: <code class="varname">UPDATE_TARGET</code> is set to) for these
7118: packages.</p>
7119: <p>You can use the “<span class="quote">update</span>” target to
7120: resume package updating in case a previous <span><strong class="command">make
7121: update</strong></span> was interrupted for some reason.
7122: However, in this case, make sure you don't call
7123: <span><strong class="command">make clean</strong></span> or otherwise remove the
7124: list of dependent packages in <code class="varname">WRKDIR</code>.
7125: Otherwise, you lose the ability to automatically update
7126: the current package along with the dependent packages
7127: you have installed.</p>
7128: <p>Resuming an interrupted <span><strong class="command">make
7129: update</strong></span> will only work as long as the package
7130: tree remains unchanged. If the source code for one of
7131: the packages to be updated has been changed, resuming
7132: <span><strong class="command">make update</strong></span> will most certainly
7133: fail!</p>
7134: <p>The following variables can be used either on the
7135: command line or in <code class="filename">/etc/mk.conf</code> to
7136: alter the behaviour of <span><strong class="command">make
7137: update</strong></span>:</p>
1.75 rillig 7138: <div class="variablelist"><dl>
7139: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7140: <dd><p>Install target to recursively use for the
7141: updated package and the dependent packages.
7142: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7143: set, “<span class="quote">install</span>” otherwise for
7144: <span><strong class="command">make update</strong></span>. Other good
7145: targets are “<span class="quote">package</span>” or
7146: “<span class="quote">bin-install</span>”. Do not set this to
7147: “<span class="quote">update</span>” or you will get stuck in an
7148: endless loop!</p></dd>
1.75 rillig 7149: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7150: <dd><p>Don't clean up after updating. Useful if
7151: you want to leave the work sources of the updated
7152: packages around for inspection or other purposes.
7153: Be sure you eventually clean up the source tree
7154: (see the “<span class="quote">clean-update</span>” target below)
7155: or you may run into troubles with old source code
7156: still lying around on your next
7157: <span><strong class="command">make</strong></span> or <span><strong class="command">make
7158: update</strong></span>.</p></dd>
1.75 rillig 7159: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7160: <dd><p>Deinstall each package before installing
7161: (making <code class="varname">DEPENDS_TARGET</code>). This
7162: may be necessary if the
7163: “<span class="quote">clean-update</span>” target (see below) was
7164: called after interrupting a running <span><strong class="command">make
7165: update</strong></span>.</p></dd>
1.75 rillig 7166: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7167: <dd><p>Allows you to disable recursion and hardcode
7168: the target for packages. The default is
7169: “<span class="quote">update</span>” for the update target,
7170: facilitating a recursive update of prerequisite
7171: packages. Only set
7172: <code class="varname">DEPENDS_TARGET</code> if you want to
7173: disable recursive updates. Use
7174: <code class="varname">UPDATE_TARGET</code> instead to just
7175: set a specific target for each package to be
7176: installed during <span><strong class="command">make update</strong></span>
7177: (see above).</p></dd>
1.75 rillig 7178: </dl></div>
7179: </dd>
7180: <dt><span class="term">clean-update</span></dt>
7181: <dd>
1.88 wiz 7182: <p>Clean the source tree for all packages that would
7183: get updated if <span><strong class="command">make update</strong></span> was called
7184: from the current directory. This target should not be
7185: used if the current package (or any of its depending
7186: packages) have already been de-installed (e.g., after
7187: calling <span><strong class="command">make update</strong></span>) or you may lose
7188: some packages you intended to update. As a rule of
7189: thumb: only use this target <span class="emphasis"><em>before</em></span>
7190: the first time you run <span><strong class="command">make update</strong></span>
7191: and only if you have a dirty package tree (e.g., if you
7192: used <code class="varname">NOCLEAN</code>).</p>
7193: <p>If you are unsure about whether your tree is
7194: clean, you can either perform a <span><strong class="command">make
7195: clean</strong></span> at the top of the tree, or use the
7196: following sequence of commands from the directory of the
7197: package you want to update (<span class="emphasis"><em>before</em></span>
7198: running <span><strong class="command">make update</strong></span> for the first
7199: time, otherwise you lose all the packages you wanted to
7200: update!):</p>
1.87 wiz 7201: <pre class="screen">
7202: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7203: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7204: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7205: </pre>
1.88 wiz 7206: <p>The following variables can be used either on the
7207: command line or in <code class="filename">/etc/mk.conf</code> to
7208: alter the behaviour of <span><strong class="command">make
7209: clean-update</strong></span>:</p>
1.75 rillig 7210: <div class="variablelist"><dl>
7211: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.88 wiz 7212: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
7213: reconstruct the list of directories to update for
7214: this package. Only use this if <span><strong class="command">make
7215: update</strong></span> successfully installed all
7216: packages you wanted to update. Normally, this is
7217: done automatically on <span><strong class="command">make
7218: update</strong></span>, but may have been suppressed by
7219: the <code class="varname">NOCLEAN</code> variable (see
7220: above).</p></dd>
1.75 rillig 7221: </dl></div>
7222: </dd>
1.88 wiz 7223: <dt><span class="term">replace</span></dt>
7224: <dd>
7225: <p>Update the installation of the current package. This
7226: differs from update in that it does not replace dependent
1.93 rillig 7227: 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 7228: target to work.</p>
7229: <p><span class="emphasis"><em>Be careful when using this
7230: target!</em></span> There are no guarantees that dependent
7231: packages will still work, in particular they will most
7232: certainly break if you <span><strong class="command">make replace</strong></span> a
7233: library package whose shared library major version changed
7234: between your installed version and the new one. For this
7235: reason, this target is not officially supported and only
7236: recommended for advanced users.</p>
7237: </dd>
1.75 rillig 7238: <dt><span class="term">info</span></dt>
7239: <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 7240: package. You can use this to check which version of a
7241: package is installed.</p></dd>
7242: <dt><span class="term">index</span></dt>
7243: <dd>
7244: <p>This is a top-level command, i.e. it should be used in
7245: the <code class="filename">pkgsrc</code> directory. It creates a
7246: database of all packages in the local pkgsrc tree, including
7247: dependencies, comment, maintainer, and some other useful
7248: information. Individual entries are created by running
7249: <span><strong class="command">make describe</strong></span> in the packages'
7250: directories. This index file is saved as
7251: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
7252: verbose format by running <span><strong class="command">make
7253: print-index</strong></span>. You can search in it with
7254: <span><strong class="command">make search
7255: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7256: extract a list of all packages that depend on a particular
7257: one by running <span><strong class="command">make show-deps
7258: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7259: <p>Running this command takes a very long time, some
7260: hours even on fast machines!</p>
7261: </dd>
1.75 rillig 7262: <dt><span class="term">readme</span></dt>
1.88 wiz 7263: <dd>
7264: <p>This target generates a
7265: <code class="filename">README.html</code> file, which can be
1.91 rillig 7266: 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 7267: contain references to any packages which are in the
7268: <code class="varname">PACKAGES</code> directory on the local
7269: host. The generated files can be made to refer to URLs
7270: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7271: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7272: wanted to generate <code class="filename">README.html</code>
7273: files which pointed to binary packages on the local
7274: machine, in the directory
7275: <code class="filename">/usr/packages</code>, set
7276: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7277: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7278: <code class="varname">${PACKAGES}</code> directory and its
7279: subdirectories will be searched for all the binary
7280: packages.</p>
7281: <p>The target can be run at the toplevel or in category
7282: directories, in which case it descends recursively.</p>
7283: </dd>
1.75 rillig 7284: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7285: <dd><p>This is a top-level command, run it in
7286: <code class="filename">pkgsrc</code>. Use this target to create a
7287: file <code class="filename">README-all.html</code> which contains a
7288: list of all packages currently available in the NetBSD
7289: Packages Collection, together with the category they belong
7290: to and a short description. This file is compiled from the
7291: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7292: to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
7293: readme</strong></span>.</p></dd>
1.75 rillig 7294: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7295: <dd><p>This is very much the same as the
7296: “<span class="quote">readme</span>” target (see above), but is to be
7297: used when generating a pkgsrc tree to be written to a
7298: CD-ROM. This target also produces
7299: <code class="filename">README.html</code> files, and can be made
7300: to refer to URLs based on
7301: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7302: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7303: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7304: <dd><p>This target shows which distfiles and patchfiles
7305: are needed to build the package
7306: (<code class="varname">ALLFILES</code>, which contains all
7307: <code class="varname">DISTFILES</code> and
1.87 wiz 7308: <code class="varname">PATCHFILES</code>, but not
7309: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7310: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7311: <dd><p>This target shows nothing if the package is not
7312: installed. If a version of this package is installed,
7313: but is not the version provided in this version of
7314: pkgsrc, then a warning message is displayed. This target
7315: can be used to show which of your installed packages are
7316: downlevel, and so the old versions can be deleted, and
7317: the current ones added.</p></dd>
1.75 rillig 7318: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7319: <dd><p>This target shows the directory in the pkgsrc
7320: hierarchy from which the package can be built and
7321: installed. This may not be the same directory as the one
7322: from which the package was installed. This target is
7323: intended to be used by people who may wish to upgrade
7324: many packages on a single host, and can be invoked from
7325: the top-level pkgsrc Makefile by using the
1.87 wiz 7326: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
1.75 rillig 7327: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7328: <dd><p>This target shows which installed packages match
7329: the current package's <code class="varname">DEPENDS</code>. Useful
7330: if out of date dependencies are causing build
7331: problems.</p></dd>
1.75 rillig 7332: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7333: <dd><p>After a package is installed, check all its
7334: binaries and (on ELF platforms) shared libraries to see
7335: if they find the shared libs they need. Run by default
7336: if <code class="varname">PKG_DEVELOPER</code> is set in
1.87 wiz 7337: <code class="filename">/etc/mk.conf</code>.</p></dd>
1.75 rillig 7338: <dt><span class="term">print-PLIST</span></dt>
7339: <dd>
7340: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7341: upgraded pkg, this prints out an attempt to generate a
7342: new <code class="filename">PLIST</code> from a <span><strong class="command">find
7343: -newer work/.extract_done</strong></span>. An attempt is made
7344: to care for shared libs etc., but it is
1.87 wiz 7345: <span class="emphasis"><em>strongly</em></span> recommended to review the
7346: result before putting it into
7347: <code class="filename">PLIST</code>. On upgrades, it's useful to
7348: diff the output of this command against an already
7349: existing <code class="filename">PLIST</code> file.</p>
1.88 wiz 7350: <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
7351: other methods that don't update file access times, be
7352: sure to add these files manually to your
1.87 wiz 7353: <code class="filename">PLIST</code>, as the “<span class="quote">find
7354: -newer</span>” command used by this target won't catch
7355: them!</p>
1.90 rillig 7356: <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 7357: information on this target.</p>
1.75 rillig 7358: </dd>
7359: <dt><span class="term">bulk-package</span></dt>
7360: <dd>
1.88 wiz 7361: <p>Used to do bulk builds. If an appropriate binary
7362: package already exists, no action is taken. If not, this
7363: target will compile, install and package it (and its
7364: depends, if <code class="varname">PKG_DEPENDS</code> is set
7365: properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, “Configuration”</a>).
7366: After creating the binary package, the sources, the
7367: just-installed package and its required packages are
7368: removed, preserving free disk space.</p>
7369: <p><span class="emphasis"><em>Beware that this target may deinstall
7370: all packages installed on a system!</em></span></p>
1.75 rillig 7371: </dd>
7372: <dt><span class="term">bulk-install</span></dt>
7373: <dd>
1.88 wiz 7374: <p>Used during bulk-installs to install required
7375: packages. If an up-to-date binary package is available,
7376: 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,
7377: <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87 wiz 7378: but the installed binary won't be removed.</p>
1.88 wiz 7379: <p>A binary package is considered
7380: “<span class="quote">up-to-date</span>” to be installed via
7381: <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>
7382: <div class="itemizedlist"><ul type="disc">
7383: <li><p>None of the package's files
7384: (<code class="filename">Makefile</code>, ...) were modified
7385: since it was built.</p></li>
7386: <li><p>None of the package's required (binary)
7387: packages were modified since it was built.</p></li>
1.75 rillig 7388: </ul></div>
1.88 wiz 7389: <p><span class="emphasis"><em>Beware that this target may deinstall
7390: all packages installed on a system!</em></span></p>
1.75 rillig 7391: </dd>
7392: </dl></div>
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="tools"></a>Chapter 17. Tools needed for building or running</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="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
7402: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
7403: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 7404: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7405: </dl>
7406: </div>
1.87 wiz 7407: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7408: by pkgsrc and also for individual packages to define what commands
7409: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7410: or for later run-time of an installed packaged (such as
7411: <code class="varname">DEPENDS</code>).
7412: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7413: package will not be used.</p>
7414: <p>When building a package, the replacement tools are
1.75 rillig 7415: made available in a directory (as symlinks or wrapper scripts)
7416: that is early in the executable search path. Just like the buildlink
1.87 wiz 7417: system, this helps with consistent builds.</p>
7418: <p>A tool may be needed to help build a specific package. For example,
7419: perl, GNU make (gmake) or yacc may be needed.</p>
7420: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7421: tool may be inefficient for building a package with pkgsrc.
7422: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7423: yacc) or a better sed.</p>
7424: <p>The tools used by a package can be listed by running
7425: <span><strong class="command">make show-tools</strong></span>.</p>
1.75 rillig 7426: <div class="sect1" lang="en">
7427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7428: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7429: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7430: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75 rillig 7431: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
7432: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
7433: These can be seen by running:
1.87 wiz 7434: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7435: <p>If a package needs a specific program to build
1.75 rillig 7436: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7437: to define the tools needed.</p>
1.75 rillig 7438: </div>
7439: <div class="sect1" lang="en">
7440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7441: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7442: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7443: and not the native version for a build dependency.
7444: And the :run means that it is used for a
7445: run-time dependencies also (and becomes a DEPENDS).
7446: The default is a build dependency which can be set with
7447: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7448: and pkg-config:build.)</p>
1.75 rillig 7449: <pre class="programlisting">
7450: USE_TOOLS+= mktemp:pkgsrc
7451: USE_TOOLS+= gmake perl:run pkg-config
7452: </pre>
1.87 wiz 7453: <p>When using the tools framework, a
1.75 rillig 7454: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7455: which contains the full path to the appropriate tool. For example,
7456: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7457: on Linux systems.</p>
7458: <p>If you always need a pkgsrc version of the
1.75 rillig 7459: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7460: </p>
7461: </div>
7462: <div class="sect1" lang="en">
7463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7464: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7465: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7466: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7467: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7468: the name of the common tools. For example:</p>
7469: <pre class="programlisting">
7470: .if exists(/usr/bin/bzcat)
7471: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7472: .elif exists(/usr/bin/bzip2)
7473: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7474: .endif
1.69 rillig 7475:
1.75 rillig 7476: TOOLS_PLATFORM.true?= true # shell builtin
7477: </pre>
7478: </div>
1.97 rillig 7479: <div class="sect1" lang="en">
7480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7481: <a name="tools.questions"></a>17.4. Questions regarding the tools</h2></div></div></div>
7482: <div class="qandaset">
7483: <dl>
7484: <dt>17.4.1. <a href="#tools.new">How do I add a new tool?</a>
7485: </dt>
7486: <dt>17.4.2. <a href="#tools.listall">How do I get a list of all available
7487: tools?</a>
7488: </dt>
7489: <dt>17.4.3. <a href="#tools.used">How can I get a list of all the tools that a
7490: package is using while being built? I want to know whether it
7491: uses sed or not.</a>
7492: </dt>
7493: </dl>
7494: <table border="0" summary="Q and A Set">
7495: <col align="left" width="1%">
7496: <tbody>
7497: <tr class="question">
7498: <td align="left" valign="top">
1.98 ! wiz 7499: <a name="tools.new"></a><a name="id454976"></a><b>17.4.1.</b>
1.97 rillig 7500: </td>
7501: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7502: </tr>
7503: <tr class="answer">
7504: <td align="left" valign="top"></td>
7505: <td align="left" valign="top"><p>TODO</p></td>
7506: </tr>
7507: <tr class="question">
7508: <td align="left" valign="top">
1.98 ! wiz 7509: <a name="tools.listall"></a><a name="id454985"></a><b>17.4.2.</b>
1.97 rillig 7510: </td>
7511: <td align="left" valign="top"><p>How do I get a list of all available
7512: tools?</p></td>
7513: </tr>
7514: <tr class="answer">
7515: <td align="left" valign="top"></td>
7516: <td align="left" valign="top"><p>TODO</p></td>
7517: </tr>
7518: <tr class="question">
7519: <td align="left" valign="top">
1.98 ! wiz 7520: <a name="tools.used"></a><a name="id454995"></a><b>17.4.3.</b>
1.97 rillig 7521: </td>
7522: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7523: package is using while being built? I want to know whether it
7524: uses sed or not.</p></td>
7525: </tr>
7526: <tr class="answer">
7527: <td align="left" valign="top"></td>
7528: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7529: to do it.)</p></td>
7530: </tr>
7531: </tbody>
7532: </table>
7533: </div>
7534: </div>
1.75 rillig 7535: </div>
7536: <div class="chapter" lang="en">
7537: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7538: <a name="fixes"></a>Chapter 18. Making your package work</h2></div></div></div>
1.75 rillig 7539: <div class="toc">
7540: <p><b>Table of Contents</b></p>
7541: <dl>
1.90 rillig 7542: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75 rillig 7543: <dd><dl>
1.90 rillig 7544: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
7545: <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>
7546: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
7547: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
7548: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
7549: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
7550: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
7551: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
7552: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
7553: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
7554: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7555: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7556: </dl></dd>
7557: <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>
7558: <dd><dl>
7559: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7560: <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>
7561: </dl></dd>
7562: <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>
7563: <dd><dl>
7564: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
7565: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7566: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
7567: </dl></dd>
7568: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
7569: <dd><dl>
7570: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
7571: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
7572: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
7573: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
7574: </dl></dd>
7575: <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>
7576: <dd><dl>
7577: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
7578: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
7579: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7580: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
7581: </dl></dd>
7582: <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>
7583: <dd><dl>
7584: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
7585: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
7586: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
7587: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
7588: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
7589: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
7590: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
7591: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
7592: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
7593: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
7594: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
7595: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
7596: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
7597: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
7598: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
7599: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
7600: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 7601: emulation</a></span></dt>
1.90 rillig 7602: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
7603: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.75 rillig 7604: </dl></dd>
1.90 rillig 7605: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7606: </dl>
7607: </div>
7608: <div class="sect1" lang="en">
7609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7610: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75 rillig 7611: <div class="sect2" lang="en">
7612: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7613: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7614: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7615: different platforms. As a result, it is important to ensure,
7616: where possible, that packages in pkgsrc are portable. This
7617: chapter mentions some particular details you should pay
7618: attention to while working on pkgsrc.</p>
1.78 rillig 7619: </div>
7620: <div class="sect2" lang="en">
7621: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 7622: <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>
7623: </h3></div></div></div>
1.78 rillig 7624: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7625: variables in the file pointed to by <code class="varname">MAKECONF</code>,
7626: which is <code class="filename">/etc/mk.conf</code> by default. When you
7627: want to use those variables in the preprocessor directives of
7628: <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
7629: <code class="literal">.for</code>), you need to include the file
7630: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7631: loads the user preferences.</p>
1.78 rillig 7632: <p>But note that some variables may not be completely defined
1.87 wiz 7633: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7634: included, as they may contain references to variables that are
7635: not yet defined. In shell commands this is no problem, since
7636: variables are actually macros, which are only expanded when they
7637: are used. But in the preprocessor directives mentioned above and
7638: in dependency lines (of the form <code class="literal">target:
7639: dependencies</code>) the variables are expanded at load
7640: time.</p>
1.78 rillig 7641: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7642: <h3 class="title">Note</h3>
7643: <p>Currently there is no exhaustive list of all
1.87 wiz 7644: variables that tells you whether they can be used at load time
7645: or only at run time, but it is in preparation.</p>
1.78 rillig 7646: </div>
7647: </div>
7648: <div class="sect2" lang="en">
7649: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7650: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88 wiz 7651: <p>Occasionally, packages require interaction from the user,
7652: and this can be in a number of ways:</p>
1.78 rillig 7653: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7654: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7655: interaction such as entering username/password or accepting a
7656: license on a web page.</p></li>
1.88 wiz 7657: <li><p>When extracting the distfiles, some packages may ask for
7658: passwords.</p></li>
1.78 rillig 7659: <li><p>help to configure the package before it is built</p></li>
7660: <li><p>help during the build process</p></li>
7661: <li><p>help during the installation of a package</p></li>
7662: </ul></div>
1.88 wiz 7663: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7664: provided to notify the pkgsrc mechanism of an interactive stage
7665: which will be needed, and this should be set in the package's
7666: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7667: <pre class="programlisting">
1.87 wiz 7668: INTERACTIVE_STAGE= build
7669: </pre>
1.78 rillig 7670: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7671: <pre class="programlisting">
1.87 wiz 7672: INTERACTIVE_STAGE= configure install
7673: </pre>
1.88 wiz 7674: <p>The user can then decide to skip this package by setting the
7675: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7676: </div>
7677: <div class="sect2" lang="en">
7678: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7679: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.98 ! wiz 7680: <p>Authors of software can choose the licence under which
! 7681: software can be copied. This is due to copyright law, and reasons
! 7682: for license choices are outside the scope of pkgsrc. The pkgsrc
! 7683: system recognizes that there are a number of licenses which some
! 7684: users may find objectionable or difficult or impossible to comply
! 7685: with. The Free Software Foundation has declared some licenses
! 7686: "Free", and the Open Source Initiative has a definition of "Open
! 7687: Source". The pkgsrc system, as a policy choice, does not label
! 7688: packages which have licenses that are Free or Open Source.
! 7689: However, packages without a license meeting either of those tests
! 7690: are labeled with a license tag denoting the license. Note that a
! 7691: package with no license to copy trivially does not meet either the
! 7692: Free or Open Source test.</p>
! 7693: <p>For packages which are not Free or Open Source, pkgsrc will
! 7694: not build the package unless the user has indicated to pkgsrc that
! 7695: packages with that particular license may be built. Note that
! 7696: this documentation avoids the term "accepted the license". The
! 7697: pkgsrc system is merely providing a mechanism to avoid
! 7698: accidentially building a package with a non-free license;
! 7699: judgement and responsibility remain with the user. (Installation
! 7700: of binary packages are not currently subject to this mechanism;
! 7701: this is a bug.)</p>
! 7702: <p>One might want to only install packages with a BSD license,
! 7703: or the GPL, and not the other. The pkgsrc license tag mechanism
! 7704: does not provide a way to do this. It might be possible to put in
! 7705: tags for free licenses, and have a default
! 7706: <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
! 7707: widely viewed as having a very poor ratio of benefit to
! 7708: work.</p>
1.78 rillig 7709: <p>The license tag mechanism is intended to address
1.87 wiz 7710: copyright-related issues surrounding building, installing and
7711: using a package, and not to address redistribution issues (see
7712: <code class="varname">RESTRICTED</code> and
7713: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7714: definition of licenses for which tags are not needed implies
7715: that packages with redistribution restrictions should have
1.98 ! wiz 7716: tags, because Free or Open Source programs do not have
! 7717: redistribution restrictions.</p>
! 7718: <p>Denoting that a package may be copied according to a
! 7719: particular license is done by placing the license in
1.87 wiz 7720: <code class="filename">pkgsrc/licenses</code> and setting the
7721: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7722: 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 7723: <pre class="programlisting">
7724: LICENSE= xv-license
7725: </pre>
7726: <p>When trying to build, the user will get a notice that the
1.98 ! wiz 7727: package is covered by a license which has not been placed in the
! 7728: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7729: <pre class="programlisting">
7730: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7731: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7732: ===> To view the license, enter "/usr/bin/make show-license".
7733: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7734: ===> ACCEPTABLE_LICENSES+=xv-license
7735: *** Error code 1
7736: </pre>
1.78 rillig 7737: <p>The license can be viewed with <span><strong class="command">make
1.98 ! wiz 7738: show-license</strong></span>, and if the user so chooses, the line
! 7739: printed above can be added to <code class="filename">/etc/mk.conf</code> to
! 7740: convey to pkgsrc that it should not in the future fail because of
! 7741: that license:</p>
1.78 rillig 7742: <pre class="programlisting">
1.87 wiz 7743: ACCEPTABLE_LICENSES+=xv-license
7744: </pre>
1.98 ! wiz 7745: <p>When adding a package with a new license, the license text
! 7746: should be added to <code class="filename">pkgsrc/licenses</code> for
! 7747: displaying. A list of known licenses can be seen in this
1.91 rillig 7748: directory.</p>
1.98 ! wiz 7749: <p>When the license changes (in a way other than formatting),
! 7750: please make sure that the new license has a different name (e.g.,
! 7751: append the version number if it exists, or the date). Just
! 7752: because a user told pkgsrc to build programs under a previous
! 7753: version of a license does not mean that pkgsrc should build
! 7754: programs under the new licenes. The higher-level point is that
! 7755: pkgsrc does not evaluate licenses for reasonableness; the only
! 7756: test is a mechanistic test of whether a particular text has been
! 7757: approved by either of two bodies.</p>
1.78 rillig 7758: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 ! wiz 7759: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
! 7760: is deprecated because it does not crisply refer to a particular
! 7761: license text. Another problem with such usage is that it does not
! 7762: enable a user to tell pkgsrc to proceed for a single package
! 7763: without also telling pkgsrc to proceed for all packages with that
! 7764: tag.</p>
1.75 rillig 7765: </div>
7766: <div class="sect2" lang="en">
7767: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7768: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7769: <p>Some licenses restrict how software may be re-distributed.
1.98 ! wiz 7770: Because a license tag is required unless the package is Free or
! 7771: Open Source, all packages with restrictions should have license
! 7772: tags. By declaring the restrictions, package tools can
! 7773: automatically refrain from e.g. placing binary packages on FTP
! 7774: sites.</p>
! 7775: <p>There are four restrictions that may be encoded, which are
! 7776: the cross product of sources (distfiles) and binaries not being
! 7777: placed on FTP sites and CD-ROMs. Because this is rarely the exact
! 7778: language in any license, and because non-Free licenses tend to be
! 7779: different from each other, pkgsrc adopts a definition of FTP and
! 7780: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
! 7781: should not be made available over the Internet at no charge.
! 7782: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
! 7783: made available on some kind of media, together with other source
! 7784: and binary packages, and which is sold for a distribution charge.
! 7785: </p>
! 7786: <p>In order to encode these restrictions, the package system
1.87 wiz 7787: defines five make variables that can be set to note these
7788: restrictions:</p>
1.75 rillig 7789: <div class="itemizedlist"><ul type="disc">
7790: <li>
7791: <p><code class="varname">RESTRICTED</code></p>
7792: <p>This variable should be set whenever a restriction
1.87 wiz 7793: exists (regardless of its kind). Set this variable to a
1.98 ! wiz 7794: string containing the reason for the restriction. It should
! 7795: be understood that those wanting to understand the restriction
! 7796: will have to read the license, and perhaps seek advice of
! 7797: counsel.</p>
1.75 rillig 7798: </li>
7799: <li>
7800: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 ! wiz 7801: <p>Binaries may not be placed on CD-ROM containing other
! 7802: binary packages, for which a distribution charge may be made.
! 7803: In this case, set this variable to
! 7804: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7805: </li>
7806: <li>
7807: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 ! wiz 7808: <p>Binaries may not made available on the Internet without
! 7809: charge. In this case, set this variable to
! 7810: <code class="varname">${RESTRICTED}</code>. If this variable is set,
! 7811: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7812: </li>
7813: <li>
7814: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 ! wiz 7815: <p>Distfiles may not be placed on CD-ROM, together with
! 7816: other distfiles, for which a fee may be charged. In this
! 7817: case, set this variable to <code class="varname">${RESTRICTED}</code>.
! 7818: </p>
1.75 rillig 7819: </li>
7820: <li>
7821: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 ! wiz 7822: <p>Distfiles may not made available via FTP at no charge.
! 7823: In this case, set this variable to
! 7824: <code class="varname">${RESTRICTED}</code>. If this variable is set,
! 7825: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7826: </li>
7827: </ul></div>
7828: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87 wiz 7829: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7830: generic make variables to denote restrictions is deprecated,
7831: because they unconditionally prevent users from generating
7832: binary packages!</p>
1.75 rillig 7833: </div>
7834: <div class="sect2" lang="en">
7835: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7836: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7837: <p>Your package may depend on some other package being present
1.88 wiz 7838: - and there are various ways of expressing this dependency.
7839: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7840: <code class="varname">DEPENDS</code> definitions, the
7841: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7842: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7843: to handle dependencies, and which uses the variables named above.
1.90 rillig 7844: See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7845: <p>The basic difference between the two variables is as
1.87 wiz 7846: follows: The <code class="varname">DEPENDS</code> definition registers
7847: that pre-requisite in the binary package so it will be pulled in
7848: when the binary package is later installed, whilst the
7849: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7850: dependency that is only needed for building the package.</p>
1.75 rillig 7851: <p>This means that if you only need a package present whilst
1.87 wiz 7852: you are building, it should be noted as a
7853: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7854: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7855: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7856: <pre class="programlisting">
1.87 wiz 7857: <pre-req-package-name>:../../<category>/<pre-req-package>
7858: </pre>
1.75 rillig 7859: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7860: may include any of the wildcard version numbers recognized by
7861: <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 7862: <div class="orderedlist"><ol type="1">
7863: <li>
7864: <p>If your package needs another package's binaries or
1.87 wiz 7865: libraries to build or run, and if that package has a
7866: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7867: <pre class="programlisting">
1.87 wiz 7868: .include "../../graphics/jpeg/buildlink3.mk"
7869: </pre>
1.75 rillig 7870: </li>
7871: <li>
7872: <p>If your package needs to use another package to build
1.87 wiz 7873: itself and there is no <code class="filename">buildlink3.mk</code>
7874: file available, use the <code class="varname">BUILD_DEPENDS</code>
7875: definition:</p>
1.75 rillig 7876: <pre class="programlisting">
1.87 wiz 7877: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
7878: </pre>
1.75 rillig 7879: </li>
7880: <li>
7881: <p>If your package needs a library with which to link and
1.76 rillig 7882: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7883: available, this is specified using the
7884: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7885: <pre class="programlisting">
1.87 wiz 7886: DEPENDS+= xpm-3.4j:../../graphics/xpm
7887: </pre>
1.75 rillig 7888: <p>You can also use wildcards in package dependences:</p>
7889: <pre class="programlisting">
1.87 wiz 7890: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
7891: </pre>
1.75 rillig 7892: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7893: creating binary packages. The dependency is checked when
7894: installing the binary package and any package which matches
7895: the pattern will be used. Wildcard dependencies should be
7896: used with care.</p>
1.75 rillig 7897: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7898: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7899: such as “<span class="quote">tk-postgresql</span>” matching a
7900: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7901: <p>Wildcards can also be used to specify that a package
1.87 wiz 7902: will only build against a certain minimum version of a
7903: pre-requisite:</p>
1.75 rillig 7904: <pre class="programlisting">
1.87 wiz 7905: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
7906: </pre>
1.75 rillig 7907: <p>This means that the package will build against version
1.87 wiz 7908: 3.5.4 of the tiff library or newer. Such a dependency may
7909: be warranted if, for example, the API of the library has
7910: changed with version 3.5.4 and a package would not compile
7911: against an earlier version of tiff.</p>
1.75 rillig 7912: <p>Please note that such dependencies should only be
1.87 wiz 7913: updated if a package requires a newer pre-requisite, but
1.93 rillig 7914: not to denote recommendations such as
1.87 wiz 7915: ABI changes that do not prevent a package from building
7916: correctly. Such recommendations can be expressed using
7917: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7918: <pre class="programlisting">
1.87 wiz 7919: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
7920: </pre>
1.75 rillig 7921: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7922: line, this denotes that while a package will build against
7923: tiff>=3.5.4, at least version 3.6.1 is recommended.
7924: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7925: dependencies unless explicitly ignored (in which case a
7926: warning will be printed).</p>
1.75 rillig 7927: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7928: use the required <code class="varname">DEPENDS</code>, set
7929: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7930: it easier and faster to update packages built using pkgsrc,
7931: since older compatible dependencies can continue to be
7932: used. This is useful for people who watch their rebuilds
7933: very carefully; it is not very good as a general-purpose
7934: hammer. If you use it, you need to be mindful of possible
7935: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7936: <p>Packages that are built with recommendations ignored
1.87 wiz 7937: may not be uploaded to ftp.NetBSD.org by developers and
7938: should not be used across different systems that may have
7939: different versions of binary packages installed.</p>
1.75 rillig 7940: <p>For security fixes, please update the package
1.90 rillig 7941: 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 7942: information.</p>
1.75 rillig 7943: </li>
7944: <li>
7945: <p>If your package needs some executable to be able to run
1.87 wiz 7946: correctly and if there's no
7947: <code class="filename">buildlink3.mk</code> file, this is specified
7948: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 7949: <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 7950: be able to execute the latex binary from the teTeX package
7951: when it runs, and that is specified:</p>
1.75 rillig 7952: <pre class="programlisting">
1.87 wiz 7953: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
7954: </pre>
1.75 rillig 7955: <p>The comment about wildcard dependencies from previous
1.87 wiz 7956: paragraph applies here, too.</p>
1.75 rillig 7957: </li>
7958: </ol></div>
7959: <p>If your package needs files from another package to build,
1.87 wiz 7960: add the relevant distribution files to
7961: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 7962: 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 7963: (It relies on the jpeg sources being present in source form
7964: during the build.)</p>
1.75 rillig 7965: </div>
7966: <div class="sect2" lang="en">
7967: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7968: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7969: <p>Your package may conflict with other packages a user might
1.87 wiz 7970: already have installed on his system, e.g. if your package
1.88 wiz 7971: installs the same set of files as another package in the pkgsrc
7972: tree.</p>
1.75 rillig 7973: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7974: space-separated list of packages (including version string) your
7975: package conflicts with.</p>
1.91 rillig 7976: <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>
7977: 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 7978: install the same shared library, thus you set in
7979: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7980: <pre class="programlisting">
7981: CONFLICTS= Xaw-Xpm-[0-9]*
7982: </pre>
7983: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 7984: <pre class="programlisting">
1.87 wiz 7985: CONFLICTS= Xaw3d-[0-9]*
7986: </pre>
1.75 rillig 7987: <p>Packages will automatically conflict with other packages
1.87 wiz 7988: with the name prefix and a different version
7989: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
7990: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 7991: </div>
7992: <div class="sect2" lang="en">
7993: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7994: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7995: <p>There are several reasons why a package might be
1.88 wiz 7996: instructed to not build under certain circumstances. If the
1.87 wiz 7997: package builds and runs on most platforms, the exceptions
7998: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7999: the package builds and runs on a small handful of platforms,
8000: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8001: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8002: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8003: (OS-version-platform) that can use glob-style
8004: wildcards.</p>
1.88 wiz 8005: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8006: 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 8007: backwards compatible with other versions of the OS, and should be
8008: uploaded to a version specific directory on the FTP server. Mark
8009: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8010: “<span class="quote">yes</span>”. This variable is not currently used by any of
8011: the package system internals, but may be used in the
8012: future.</p>
1.75 rillig 8013: <p>If the package should be skipped (for example, because it
1.87 wiz 8014: provides functionality already provided by the system), set
1.88 wiz 8015: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8016: the package should fail because some preconditions are not met,
8017: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8018: message.</p>
1.75 rillig 8019: </div>
8020: <div class="sect2" lang="en">
8021: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8022: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8023: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8024: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8025: be set in the package Makefile. This will be carried into any
8026: binary package that is made from this pkgsrc entry. A
8027: “<span class="quote">preserved</span>” package will
8028: 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
8029: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 8030: </div>
8031: <div class="sect2" lang="en">
8032: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8033: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8034: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8035: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
8036: and after committing that file, use <span><strong class="command">make upload</strong></span>
8037: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 8038: <p>After fixing the vulnerability by a patch, its
1.87 wiz 8039: <code class="varname">PKGREVISION</code> should be increased (this
8040: is of course not necessary if the problem is fixed by using
8041: a newer release of the software).</p>
1.75 rillig 8042: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8043: branch, be sure to submit a pullup request!</p>
1.75 rillig 8044: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8045: semi-automatically by a weekly cron job.</p>
1.75 rillig 8046: </div>
8047: <div class="sect2" lang="en">
8048: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8049: <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 8050: <p>When making fixes to an existing package it can be useful
1.87 wiz 8051: to change the version number in <code class="varname">PKGNAME</code>. To
8052: avoid conflicting with future versions by the original author, a
8053: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8054: on package versions by setting <code class="varname">PKGREVISION=1</code>
8055: (2, ...). The “<span class="quote">nb</span>” is treated like a
8056: “<span class="quote">.</span>” by the package tools. e.g.</p>
8057: <pre class="programlisting">
8058: DISTNAME= foo-17.42
8059: PKGREVISION= 9
8060: </pre>
1.75 rillig 8061: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 8062: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8063: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8064: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8065: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8066: <p>When a new release of the package is released, the
1.87 wiz 8067: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8068: minor release of the above package, things should be like:</p>
1.75 rillig 8069: <pre class="programlisting">
1.87 wiz 8070: DISTNAME= foo-17.43
8071: </pre>
8072: <p><code class="varname">PKGREVISION</code> should be incremented for any
8073: non-trivial change in the resulting binary package. Without a
8074: <code class="varname">PKGREVISION</code> bump, someone with the previous
8075: version installed has no way of knowing that their package is out
8076: of date. Thus, changes without increasing
8077: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8078: trivial that no reasonable person would want to upgrade", and this
8079: is the rough test for when increasing
8080: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8081: changes that do not merit increasing
8082: <code class="varname">PKGREVISION</code> are:</p>
8083: <pre class="programlisting">
8084: Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
8085: or comments in Makefile.
8086: Changing build variables if the resulting binary package is the same.
8087: Changing <code class="filename">DESCR</code>.
8088: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.
8089: </pre>
8090: <p>Examples of changes that do merit an increase to
8091: <code class="varname">PKGREVISION</code> include:</p>
8092: <pre class="programlisting">
8093: Security fixes
8094: Changes or additions to a patch file
8095: Changes to the <code class="filename">PLIST</code>
8096: </pre>
1.78 rillig 8097: <p>PKGREVISION must also be incremented when dependencies have ABI
8098: changes.</p>
1.75 rillig 8099: </div>
1.79 rillig 8100: <div class="sect2" lang="en">
8101: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8102: <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 8103: <p>When you want to replace the same text in multiple files
1.87 wiz 8104: or when the replacement text varies, patches alone cannot help.
8105: This is where the SUBST framework comes in. It provides an
8106: easy-to-use interface for replacing text in files.
8107: Example:</p>
8108: <pre class="programlisting">
8109: SUBST_CLASSES+= fix-paths
8110: SUBST_STAGE.fix-paths= pre-configure
8111: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8112: SUBST_FILES.fix-paths= src/*.c
8113: SUBST_FILES.fix-paths+= scripts/*.sh
8114: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8115: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8116: </pre>
1.79 rillig 8117: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8118: that are used to identify the different SUBST blocks that are
8119: defined. The SUBST framework is heavily used by pkgsrc, so it is
8120: important to always use the <code class="literal">+=</code> operator with
8121: this variable. Otherwise some substitutions may be
8122: skipped.</p>
1.79 rillig 8123: <p>The remaining variables of each SUBST block are
1.87 wiz 8124: parameterized with the identifier from the first line
8125: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8126: parameters to a function call.</p>
1.79 rillig 8127: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8128: which the replacement will take place. All combinations of
8129: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8130: <code class="literal">post-</code> together with a phase name are
8131: possible, though only few are actually used. Most commonly used
8132: are <code class="literal">post-patch</code> and
8133: <code class="literal">pre-configure</code>. Of these two,
8134: <code class="literal">pre-configure</code> should be preferred because
8135: then it is possible to run <span><strong class="command">bmake patch</strong></span> and
8136: have the state after applying the patches but before making any
8137: other changes. This is especially useful when you are debugging
8138: a package in order to create new patches for it. Similarly,
8139: <code class="literal">post-build</code> is preferred over
8140: <code class="literal">pre-install</code>, because the install phase should
8141: generally be kept as simple as possible. When you use
8142: <code class="literal">post-build</code>, you have the same files in the
8143: working directory that will be installed later, so you can check
8144: if the substitution has succeeded.</p>
1.79 rillig 8145: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8146: that is printed just before the substitution is done.</p>
1.79 rillig 8147: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8148: globbing patterns that specifies the files in which the
8149: substitution will take place. The patterns are interpreted
8150: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8151: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87 wiz 8152: <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
8153: command should be prefixed with <code class="literal">-e</code>, so that
8154: all SUBST blocks look uniform.</p>
1.79 rillig 8155: <p>There are some more variables, but they are so seldomly
1.87 wiz 8156: used that they are only documented in the
8157: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8158: </div>
1.75 rillig 8159: </div>
8160: <div class="sect1" lang="en">
8161: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8162: <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 8163: <div class="sect2" lang="en">
8164: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8165: <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 8166: <p>If you need to download from a dynamic URL you can set
1.87 wiz 8167: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
8168: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8169: with the name of each file to download as an argument, expecting
8170: it to output the URL of the directory from which to download
1.91 rillig 8171: 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 8172: example of this usage.</p>
1.75 rillig 8173: <p>If the download can't be automated, because the user must
1.87 wiz 8174: submit personal information to apply for a password, or must pay
8175: for the source, or whatever, you can set
8176: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8177: displayed to the user before aborting the build. Example:</p>
8178: <pre class="programlisting">
8179: FETCH_MESSAGE= "Please download the files"
8180: FETCH_MESSAGE+= " "${DISTFILES:Q}
8181: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8182: </pre>
1.75 rillig 8183: </div>
8184: <div class="sect2" lang="en">
8185: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8186: <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 8187: <p>Sometimes authors of a software package make some
1.87 wiz 8188: modifications after the software was released, and they put up a
8189: new distfile without changing the package's version number. If a
8190: package is already in pkgsrc at that time, the checksum will
8191: no longer match. The contents of the new distfile should be
8192: compared against the old one before changing anything, to make
8193: sure the distfile was really updated on purpose, and that
8194: no trojan horse or so crept in.
1.97 rillig 8195: Please mention that the distfiles were compared and what was found
8196: in your commit message.
1.87 wiz 8197: Then, the correct way to work around this is to
8198: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8199: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8200: <code class="varname">DISTFILES</code> and
1.93 rillig 8201: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8202: subdirectory of the local distfiles directory.
8203: (See <a href="#bumping-pkgrevision" title="18.1.11. How to handle incrementing versions when fixing an existing package">Section 18.1.11, “How to handle incrementing versions when fixing an existing package”</a> for more details.)
8204: In case this
1.87 wiz 8205: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8206: including the <code class="filename">nbX</code> suffix) or a date stamp
8207: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8208: Do not forget regenerating the <code class="filename">distinfo</code> file
8209: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8210: path in the filenames.
1.97 rillig 8211: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8212: Furthermore, a mail to the package's authors seems appropriate
8213: telling them that changing distfiles after releases without
8214: changing the file names is not good practice.</p>
1.75 rillig 8215: </div>
8216: </div>
8217: <div class="sect1" lang="en">
8218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8219: <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 8220: <div class="sect2" lang="en">
8221: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8222: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8223: <p>pkgsrc supports many different machines, with different
1.87 wiz 8224: object formats like a.out and ELF, and varying abilities to do
8225: shared library and dynamic loading at all. To accompany this,
8226: varying commands and options have to be passed to the
8227: compiler, linker, etc. to get the Right Thing, which can be
8228: pretty annoying especially if you don't have all the machines
8229: at your hand to test things. The
1.91 rillig 8230: <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 8231: can help here, as it just “<span class="quote">knows</span>” how to build
8232: both static and dynamic libraries from a set of source files,
8233: thus being platform-independent.</p>
8234: <p>Here's how to use libtool in a package in seven simple
8235: steps:</p>
1.75 rillig 8236: <div class="orderedlist"><ol type="1">
8237: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8238: Makefile.</p></li>
1.75 rillig 8239: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8240: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8241: add it to the definition of <code class="varname">CC</code>, if only
8242: libraries are being built in a given Makefile. This one command
8243: will build both PIC and non-PIC library objects, so you need not
8244: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8245: <li>
8246: <p>For the linking of the library, remove any
1.87 wiz 8247: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8248: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8249: <pre class="programlisting">
1.87 wiz 8250: ${LIBTOOL} --mode=link ${CC} -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} \
8251: -rpath ${PREFIX}/lib -version-info major:minor
8252: </pre>
1.75 rillig 8253: <p>Note that the library is changed to have a
1.87 wiz 8254: <code class="filename">.la</code> extension, and the objects are
8255: changed to have a <code class="filename">.lo</code>
8256: extension. Change <code class="varname">OBJS</code> as
8257: necessary. This automatically creates all of the
8258: <code class="filename">.a</code>,
8259: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8260: necessary) in the build directory. Be sure to include
8261: “<span class="quote">-version-info</span>”, especially when major and
8262: minor are zero, as libtool will otherwise strip off the
8263: shared library version.</p>
1.75 rillig 8264: <p>From the libtool manual:</p>
8265: <pre class="programlisting">
1.87 wiz 8266: So, libtool library versions are described by three integers:
1.69 rillig 8267:
1.87 wiz 8268: CURRENT
8269: The most recent interface number that this library implements.
1.69 rillig 8270:
1.87 wiz 8271: REVISION
8272: The implementation number of the CURRENT interface.
1.69 rillig 8273:
1.87 wiz 8274: AGE
8275: The difference between the newest and oldest interfaces that
8276: this library implements. In other words, the library implements
8277: all the interface numbers in the range from number `CURRENT -
8278: AGE' to `CURRENT'.
1.1 grant 8279:
1.87 wiz 8280: If two libraries have identical CURRENT and AGE numbers, then the
8281: dynamic linker chooses the library with the greater REVISION number.
8282: </pre>
1.75 rillig 8283: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8284: different results for a.out and ELF (excluding symlinks)
8285: in only one case. An ELF library of the form
8286: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8287: will have a symlink of
8288: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8289: on an a.out platform. This is handled
8290: automatically.</p>
1.75 rillig 8291: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8292: directory of the library being built.</p>
1.76 rillig 8293: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8294: <code class="filename">.la</code> file, the other files will be
8295: added automatically.</p>
1.75 rillig 8296: </li>
8297: <li>
1.76 rillig 8298: <p>When linking shared object (<code class="filename">.so</code>)
1.87 wiz 8299: 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
8300: shared libraries, use “<span class="quote">-module
8301: -avoid-version</span>” to prevent them getting version
8302: tacked on.</p>
1.76 rillig 8303: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8304: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8305: </li>
8306: <li>
8307: <p>When linking programs that depend on these libraries
1.87 wiz 8308: <span class="emphasis"><em>before</em></span> they are installed, preface
8309: 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}
8310: --mode=link</span>”, and it will find the correct
8311: libraries (static or shared), but please be aware that
8312: libtool will not allow you to specify a relative path in
8313: -L (such as “<span class="quote">-L../somelib</span>”), because it
8314: expects you to change that argument to be the
8315: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8316: <pre class="programlisting">
1.87 wiz 8317: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8318: </pre>
1.75 rillig 8319: <p>should be changed to:</p>
8320: <pre class="programlisting">
1.87 wiz 8321: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8322: </pre>
1.75 rillig 8323: <p>and it will do the right thing with the libraries.</p>
8324: </li>
8325: <li>
8326: <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 8327: 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}
8328: --mode=install</span>”, and change the library name to
8329: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8330: <pre class="programlisting">
1.87 wiz 8331: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
8332: </pre>
1.76 rillig 8333: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8334: shared library, any needed symlinks, and run
8335: <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 8336: </li>
1.76 rillig 8337: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8338: the <code class="filename">.la</code>
8339: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8340: </ol></div>
8341: </div>
8342: <div class="sect2" lang="en">
8343: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8344: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8345: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8346: package Makefile. This will override the package's own libtool
8347: in most cases. For older libtool using packages, libtool is
8348: made by ltconfig script during the do-configure step; you can
8349: check the libtool script location by doing <span><strong class="command">make
8350: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8351: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8352: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8353: default, it is set to “<span class="quote">libtool */libtool
8354: */*/libtool</span>”. If this does not match the location of the
8355: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8356: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8357: libraries built and installed, then use
8358: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8359: <p>If your package makes use of the platform-independent library
1.87 wiz 8360: for loading dynamic shared objects, that comes with libtool
8361: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8362: <p>Some packages use libtool incorrectly so that the package
8363: may not work or build in some circumstances. Some of the more
8364: common errors are:</p>
1.75 rillig 8365: <div class="itemizedlist"><ul type="disc">
8366: <li>
8367: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8368: executable or library. This in itself isn't a problem if one of two things
8369: has been done:</p>
1.75 rillig 8370: <div class="orderedlist"><ol type="1">
8371: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8372: <code class="filename">libfoo.la</code>, not
8373: <code class="filename">foo.la</code></p></li>
1.75 rillig 8374: <li><p>The -dlopen option is used when linking an executable.</p></li>
8375: </ol></div>
8376: </li>
8377: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8378: The function lt_dlinit() should be called and the macro
8379: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8380: executables.</p></li>
1.75 rillig 8381: </ul></div>
8382: </div>
8383: <div class="sect2" lang="en">
8384: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8385: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8386: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8387: to regenerate the configure script and Makefile.in makefile
8388: templates, then they should be executed in a pre-configure
8389: target.</p>
1.75 rillig 8390: <p>For packages that need only autoconf:</p>
8391: <pre class="programlisting">
1.87 wiz 8392: AUTOCONF_REQD= 2.50 # if default version is not good enough
8393: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8394: ...
1.1 grant 8395:
1.87 wiz 8396: pre-configure:
8397: cd ${WRKSRC}; autoconf
1.1 grant 8398:
1.87 wiz 8399: ...
8400: </pre>
1.75 rillig 8401: <p>and for packages that need automake and autoconf:</p>
8402: <pre class="programlisting">
1.87 wiz 8403: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8404: USE_TOOLS+= automake # use "automake14" for automake-1.4
8405: ...
8406:
8407: pre-configure:
8408: cd ${WRKSRC}; \
8409: aclocal; autoheader; \
8410: automake -a --foreign -i; autoconf
1.1 grant 8411:
1.87 wiz 8412: ...
8413: </pre>
1.75 rillig 8414: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8415: require GNU Make.</p>
1.75 rillig 8416: <p>There are times when the configure process makes
1.87 wiz 8417: additional changes to the generated files, which then causes
8418: the build process to try to re-execute the automake sequence.
8419: This is prevented by touching various files in the configure
8420: stage. If this causes problems with your package you can set
8421: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8422: Makefile.</p>
1.75 rillig 8423: </div>
8424: </div>
8425: <div class="sect1" lang="en">
8426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8427: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87 wiz 8428: <div class="sect2" lang="en">
8429: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8430: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8431: <p>Compilers for the C, C++, and Fortran languages comes with
8432: the NetBSD base system. By default, pkgsrc assumes that a package
8433: is written in C and will hide all other compilers (via the wrapper
1.90 rillig 8434: framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8435: <p>To declare which language's compiler a package needs, set
8436: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8437: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8438: “<span class="quote">fortran</span>” (and any combination). The default is
8439: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8440: written in C++, usually need a C compiler for the configure
8441: phase.</p>
8442: </div>
8443: <div class="sect2" lang="en">
8444: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8445: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87 wiz 8446: <p>If a program is written in Java, use the Java framework in
8447: pkgsrc. The package must include
8448: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8449: provides the following variables:</p>
8450: <div class="itemizedlist"><ul type="disc">
8451: <li><p><code class="varname">USE_JAVA</code> defines if a build
8452: dependency on the JDK is added. If
8453: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8454: there is only a runtime dependency on the JDK. The default is
8455: “<span class="quote">yes</span>”, which also adds a build dependency on the
8456: JDK.</p></li>
8457: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8458: a package needs a Java2 implementation. The supported values
8459: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8460: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8461: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8462: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8463: above. This variable is not set by default.</p></li>
8464: </ul></div>
8465: </div>
8466: <div class="sect2" lang="en">
8467: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8468: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8469: <p>If your package contains interpreted perl scripts, add
8470: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8471: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8472: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8473: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8474: that you want adjusted. Every occurrence of
8475: <code class="filename">*/bin/perl</code> will be replaced with the full
8476: path to the perl executable.</p>
8477: <p>If a particular version of perl is needed, set the
8478: <code class="varname">PERL5_REQD</code> variable to the version number. The
8479: default is “<span class="quote">5.0</span>”.</p>
1.90 rillig 8480: <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 8481: about handling perl modules.</p>
8482: </div>
8483: <div class="sect2" lang="en">
8484: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8485: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8486: <p>Currently, there is no special handling for other languages
8487: in pkgsrc. If a compiler package provides a
8488: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8489: just add a (build) dependency on the appropriate compiler
8490: package.</p>
8491: </div>
8492: </div>
8493: <div class="sect1" lang="en">
8494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8495: <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 8496: <p>The most common failures when building a package are that
8497: some platforms do not provide certain header files, functions or
8498: libraries, or they provide the functions in a library that the
8499: original package author didn't know. To work around this, you
8500: can rewrite the source code in most cases so that it does not
8501: use the missing functions or provides a replacement function.</p>
8502: <div class="sect2" lang="en">
8503: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8504: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8505: <p>If a package already comes with a GNU configure script, the
8506: preferred way to fix the build failure is to change the
8507: configure script, not the code. In the other cases, you can
8508: utilize the C preprocessor, which defines certain macros
8509: depending on the operating system and hardware architecture it
8510: compiles for. These macros can be queried using for example
8511: <code class="varname">#if defined(__i386)</code>. Almost every operating
8512: system, hardware architecture and compiler has its own macro.
8513: For example, if the macros <code class="varname">__GNUC__</code>,
8514: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8515: are all defined, you know that you are using NetBSD on an i386
8516: compatible CPU, and your compiler is GCC.</p>
8517: <p>The list of the following macros for hardware and
8518: operating system depends on the compiler that is used. For
8519: example, if you want to conditionally compile code on Solaris,
8520: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8521: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8522: <div class="sect3" lang="en">
8523: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8524: <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 8525: <p>To distinguish between 4.4 BSD-derived systems and the
8526: rest of the world, you should use the following code.</p>
8527: <pre class="programlisting">
8528: #include <sys/param.h>
8529: #if (defined(BSD) && BSD >= 199306)
8530: /* BSD-specific code goes here */
8531: #else
8532: /* non-BSD-specific code goes here */
8533: #endif
8534: </pre>
1.77 rillig 8535: <p>If this distinction is not fine enough, you can also test
8536: for the following macros.</p>
1.75 rillig 8537: <pre class="programlisting">
8538: FreeBSD __FreeBSD__
8539: DragonFly __DragonFly__
8540: Interix __INTERIX
1.97 rillig 8541: IRIX __sgi (TODO: get a definite source for this)
1.75 rillig 8542: Linux linux, __linux, __linux__
8543: NetBSD __NetBSD__
8544: OpenBSD __OpenBSD__
8545: Solaris sun, __sun
8546: </pre>
8547: </div>
8548: <div class="sect3" lang="en">
8549: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8550: <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 8551: <pre class="programlisting">
8552: i386 i386, __i386, __i386__
8553: MIPS __mips
8554: SPARC sparc, __sparc
8555: </pre>
8556: </div>
8557: <div class="sect3" lang="en">
8558: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8559: <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 8560: <pre class="programlisting">
8561: GCC __GNUC__ (major version), __GNUC_MINOR__
1.97 rillig 8562: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8563: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8564: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8565: </pre>
8566: </div>
8567: </div>
1.78 rillig 8568: <div class="sect2" lang="en">
8569: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8570: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8571: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8572: combinations of compiler version and architecture and almost
8573: always relation to optimisation being enabled. Common symptoms
8574: are gcc internal errors or never finishing compiling a
1.78 rillig 8575: file.</p>
8576: <p>Typically, a workaround involves testing the
8577: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8578: optimisation for that combination of file,
8579: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8580: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8581: number of examples.</p>
8582: </div>
8583: <div class="sect2" lang="en">
8584: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8585: <a name="undefined-reference"></a>18.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.92 rillig 8586: <p>This error message often means that a package did not
1.78 rillig 8587: link to a shared library it needs. The following functions are
8588: known to cause this error message over and over.</p>
8589: <div class="informaltable">
8590: <a name="undefined-reference-functions"></a><table border="1">
8591: <colgroup>
8592: <col>
8593: <col>
8594: <col>
8595: </colgroup>
8596: <thead><tr>
8597: <th>Function</th>
8598: <th>Library</th>
8599: <th>Affected platforms</th>
8600: </tr></thead>
8601: <tbody>
8602: <tr>
8603: <td>accept, bind, connect</td>
8604: <td>-lsocket</td>
8605: <td>Solaris</td>
8606: </tr>
8607: <tr>
8608: <td>crypt</td>
8609: <td>-lcrypt</td>
8610: <td>DragonFly, NetBSD</td>
8611: </tr>
8612: <tr>
8613: <td>dlopen, dlsym</td>
8614: <td>-ldl</td>
8615: <td>Linux</td>
8616: </tr>
8617: <tr>
8618: <td>gethost*</td>
8619: <td>-lnsl</td>
8620: <td>Solaris</td>
8621: </tr>
8622: <tr>
8623: <td>inet_aton</td>
8624: <td>-lresolv</td>
8625: <td>Solaris</td>
8626: </tr>
8627: <tr>
8628: <td>nanosleep, sem_*, timer_*</td>
8629: <td>-lrt</td>
8630: <td>Solaris</td>
8631: </tr>
8632: <tr>
8633: <td>openpty</td>
8634: <td>-lutil</td>
8635: <td>Linux</td>
8636: </tr>
8637: </tbody>
8638: </table>
8639: </div>
8640: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8641: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8642: -l<em class="replaceable"><code>foo</code></em></code> to the package
8643: <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
8644: bmake</strong></span>.</p>
1.92 rillig 8645: <div class="sect3" lang="en">
8646: <div class="titlepage"><div><div><h4 class="title">
8647: <a name="undefined-reference-sunpro"></a>18.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
8648: <p>When you are using the SunPro compiler, there is another
8649: possibility. That compiler cannot handle the following code:</p>
8650: <pre class="programlisting">
8651: extern int extern_func(int);
1.93 rillig 8652:
1.92 rillig 8653: static inline int
8654: inline_func(int x)
8655: {
8656: return extern_func(x);
8657: }
1.93 rillig 8658:
1.92 rillig 8659: int main(void)
8660: {
8661: return 0;
8662: }
8663: </pre>
8664: <p>It generates the code for <code class="function">inline_func</code> even if
8665: that function is never used. This code then refers to
8666: <code class="function">extern_func</code>, which can usually not be resolved. To
8667: solve this problem you can try to tell the package to disable inlining
8668: of functions.</p>
8669: </div>
1.87 wiz 8670: </div>
8671: <div class="sect2" lang="en">
8672: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8673: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8674: <p>Sometimes packages fail to build because the compiler runs
8675: into an operating system specific soft limit. With the
8676: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8677: to unlimit the resources. Currently, the allowed values are
8678: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8679: Setting this variable is similar to running the shell builtin
8680: <span><strong class="command">ulimit</strong></span> command to raise the maximum data
8681: segment size or maximum stack size of a process, respectively, to
8682: their hard limits.</p>
1.78 rillig 8683: </div>
1.75 rillig 8684: </div>
8685: <div class="sect1" lang="en">
8686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8687: <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 8688: <div class="sect2" lang="en">
8689: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8690: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78 rillig 8691: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87 wiz 8692: with some operating systems cannot create more than one
8693: directory at a time. As such, you should call
8694: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8695: <pre class="programlisting">
8696: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8697: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8698: </pre>
1.78 rillig 8699: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8700: dir2</code></span>” to the
8701: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8702: automatically do the right thing.</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="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8707: <p>In general, documentation should be installed into
1.87 wiz 8708: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8709: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8710: includes the version number of the package).</p>
1.84 wiz 8711: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8712: directory where HTML documentation is installed with the
8713: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8714: is needed because otherwise the documentation ends up in
8715: <code class="filename">${PREFIX}/share/doc/html</code> or other
8716: places.</p>
8717: <p>An exception to the above is that library API documentation
1.91 rillig 8718: 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 8719: browsers (devhelp) should be left at their default location, which
8720: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8721: documentation can be recognized from files ending in
8722: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8723: (It is also acceptable to install such files in
8724: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8725: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8726: <code class="filename">.devhelp*</code> file must be directly in that
8727: directory then, no additional subdirectory level is allowed in
8728: this case. This is usually achieved by using
8729: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8730: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8731: though.)</p>
1.75 rillig 8732: </div>
8733: <div class="sect2" lang="en">
8734: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8735: <a name="installing-score-files"></a>18.6.3. Installing score files</h3></div></div></div>
1.75 rillig 8736: <p>Certain packages, most of them in the games category, install
1.87 wiz 8737: a score file that allows all users on the system to record their
8738: highscores. In order for this to work, the binaries need to be
8739: installed setgid and the score files owned by the appropriate
8740: group and/or owner (traditionally the "games" user/group). The
8741: following variables, documented in more detail in
8742: <code class="filename">mk/defaults/mk.conf</code>, control this
8743: behaviour: <code class="varname">SETGIDGAME</code>,
8744: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8745: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8746: <p>Note that per default, setgid installation of games is
1.87 wiz 8747: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8748: the other variables accordingly.</p>
1.75 rillig 8749: <p>A package should therefor never hard code file ownership or
1.87 wiz 8750: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8751: <code class="varname">INSTALL_GAME_DATA</code> to set these
8752: correctly.</p>
1.75 rillig 8753: </div>
8754: <div class="sect2" lang="en">
8755: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8756: <a name="hardcoded-paths"></a>18.6.4. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8757: <p>Your package may also contain scripts with hardcoded paths to
8758: other interpreters besides (or as well as) perl. To correct the
8759: full pathname to the script interpreter, you need to set the
8760: following definitions in your <code class="filename">Makefile</code> (we
8761: shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
8762: <pre class="programlisting">
8763: REPLACE_INTERPRETER+= tcl
8764: REPLACE.tcl.old= .*/bin/tclsh
8765: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8766: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8767: # relative to ${WRKSRC}, just as in REPLACE_PERL
8768: </pre>
1.75 rillig 8769: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8770: <h3 class="title">Note</h3>
8771: <p>Before March 2006, these variables were called
1.87 wiz 8772: <code class="varname">_REPLACE.*</code> and
8773: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8774: </div>
8775: </div>
8776: <div class="sect2" lang="en">
8777: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8778: <a name="perl-modules"></a>18.6.5. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8779: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8780: the Makefile fragment
8781: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
8782: <span><strong class="command">do-configure</strong></span> target for the standard perl
8783: configuration for such modules as well as various hooks to tune
8784: this configuration. See comments in this file for
8785: details.</p>
1.75 rillig 8786: <p>Perl5 modules will install into different places depending
1.87 wiz 8787: on the version of perl used during the build process. To
8788: address this, pkgsrc will append lines to the
8789: <code class="filename">PLIST</code> corresponding to the files listed in
8790: the installed <code class="filename">.packlist</code> file generated by
8791: most perl5 modules. This is invoked by defining
8792: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8793: paths to packlist files, e.g.:</p>
1.75 rillig 8794: <pre class="programlisting">
1.87 wiz 8795: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8796: </pre>
1.75 rillig 8797: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8798: <code class="varname">PERL5_SITEARCH</code>, and
8799: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8800: in which perl5 modules may be installed, and may be used by
8801: perl5 packages that don't have a packlist. These three
8802: variables are also substituted for in the
8803: <code class="filename">PLIST</code>.</p>
1.75 rillig 8804: </div>
8805: <div class="sect2" lang="en">
8806: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8807: <a name="faq.info-files"></a>18.6.6. Packages installing info files</h3></div></div></div>
1.75 rillig 8808: <p>Some packages install info files or use the
1.87 wiz 8809: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8810: commands. <code class="varname">INFO_FILES</code> should be defined in
8811: the package Makefile so that <code class="filename">INSTALL</code> and
8812: <code class="filename">DEINSTALL</code> scripts will be generated to
8813: handle registration of the info files in the Info directory
8814: file. The “<span class="quote">install-info</span>” command used for the info
8815: files registration is either provided by the system, or by a
8816: special purpose package automatically added as dependency if
8817: needed.</p>
1.75 rillig 8818: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8819: <code class="filename">${PREFIX}</code> where info files are primarily
8820: located. <code class="varname">PKGINFODIR</code> defaults to
8821: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8822: <p>The info files for the package should be listed in the
1.87 wiz 8823: package <code class="filename">PLIST</code>; however any split info files
8824: need not be listed.</p>
1.75 rillig 8825: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8826: at build time must add “<span class="quote">makeinfo</span>” to
8827: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8828: version of the “<span class="quote">makeinfo</span>” command is needed it
8829: should be noted with the <code class="varname">TEXINFO_REQD</code>
8830: variable in the package <code class="filename">Makefile</code>. By
8831: default, a minimum version of 3.12 is required. If the system
8832: does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
8833: does not match the required minimum, a build dependency on the
1.91 rillig 8834: <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 8835: be added automatically.</p>
1.75 rillig 8836: <p>The build and installation process of the software provided
1.87 wiz 8837: by the package should not use the
8838: <span><strong class="command">install-info</strong></span> command as the registration of
8839: info files is the task of the package
8840: <code class="filename">INSTALL</code> script, and it must use the
8841: appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75 rillig 8842: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87 wiz 8843: overriding scripts for the <span><strong class="command">install-info</strong></span> and
8844: <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
8845: in <code class="varname">PATH</code>.</p>
1.75 rillig 8846: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87 wiz 8847: no effect except the logging of a message. The script overriding
8848: <span><strong class="command">makeinfo</strong></span> logs a message and according to the
8849: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
8850: <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8851: </div>
8852: <div class="sect2" lang="en">
8853: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8854: <a name="manpages"></a>18.6.7. Packages installing man pages</h3></div></div></div>
1.81 rillig 8855: <p>All packages that install manual pages should install them
1.87 wiz 8856: into the same directory, so that there is one common place to look
8857: for them. In pkgsrc, this place is
8858: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8859: should be used in packages. The default for
8860: <code class="varname">PKGMANDIR</code> is
8861: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8862: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8863: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8864: <h3 class="title">Note</h3>
1.87 wiz 8865: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8866: is far from complete.</p>
1.75 rillig 8867: </div>
1.81 rillig 8868: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8869: <code class="filename">man/</code> as the top level directory for the man
8870: page file entries, and the pkgsrc framework will convert as
8871: needed. In all other places, the correct
8872: <code class="varname">PKGMANDIR</code> must be used.</p>
8873: <p>Packages that are
8874: configured with <code class="varname">GNU_CONFIGURE</code> set as
8875: “<span class="quote">yes</span>”, by default will use the
8876: <code class="filename">./configure</code>
8877: --mandir switch to set where the man pages should be installed.
8878: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8879: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8880: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8881: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8882: to “<span class="quote">no</span>”.
8883: Or if the <code class="filename">./configure</code> script uses
8884: a non-standard use of --mandir, you can set
8885: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90 rillig 8886: <p>See <a href="#manpage-compression" title="12.5. Man page compression">Section 12.5, “Man page compression”</a> for
1.87 wiz 8887: information on installation of compressed manual pages.</p>
1.75 rillig 8888: </div>
8889: <div class="sect2" lang="en">
8890: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8891: <a name="gconf2-data-files"></a>18.6.8. Packages installing GConf2 data files</h3></div></div></div>
1.87 wiz 8892: <p>If a package installs <code class="filename">.schemas</code> or
8893: <code class="filename">.entries</code> files, used by GConf2,
8894: you need to take some extra steps to make sure they get registered
8895: in the database:</p>
1.75 rillig 8896: <div class="orderedlist"><ol type="1">
1.76 rillig 8897: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87 wiz 8898: instead of its <code class="filename">buildlink3.mk</code> file. This
8899: takes care of rebuilding the GConf2 database at installation and
8900: deinstallation time, and tells the package where to install
8901: GConf2 data files using some standard configure arguments. It
8902: also disallows any access to the database directly from the
8903: package.</p></li>
1.75 rillig 8904: <li><p>Ensure that the package installs its
1.87 wiz 8905: <code class="filename">.schemas</code> files under
8906: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8907: installed under <code class="filename">${PREFIX}/etc</code>, you will
8908: need to manually patch the package.</p></li>
1.75 rillig 8909: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8910: directory, as they will be handled automatically. See
1.90 rillig 8911: <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 8912: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87 wiz 8913: your <code class="filename">Makefile</code> with a list of all
8914: <code class="filename">.schemas</code> files installed by the package, if
8915: any. Names must not contain any directories in them.</p></li>
1.75 rillig 8916: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87 wiz 8917: your <code class="filename">Makefile</code> with a
8918: list of all <code class="filename">.entries</code> files installed by the
8919: package, if any. Names must not contain any directories in
8920: them.</p></li>
1.75 rillig 8921: </ol></div>
8922: </div>
8923: <div class="sect2" lang="en">
8924: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8925: <a name="scrollkeeper-data-files"></a>18.6.9. Packages installing scrollkeeper data files</h3></div></div></div>
1.87 wiz 8926: <p>If a package installs <code class="filename">.omf</code> files, used by
8927: scrollkeeper, you need to take some extra steps to make sure they
8928: get registered in the database:</p>
1.75 rillig 8929: <div class="orderedlist"><ol type="1">
8930: <li><p>Include
1.87 wiz 8931: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
8932: instead of its <code class="filename">buildlink3.mk</code> file. This
8933: takes care of rebuilding the scrollkeeper database at
8934: installation and deinstallation time, and disallows any access
8935: to it directly from the package.</p></li>
1.75 rillig 8936: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 8937: <code class="filename">libdata/scrollkeeper</code> directory, as they
8938: will be handled automatically.</p></li>
1.76 rillig 8939: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87 wiz 8940: the PLIST. It will be handled by scrollkeeper.</p></li>
1.75 rillig 8941: </ol></div>
8942: </div>
8943: <div class="sect2" lang="en">
8944: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8945: <a name="x11-fonts"></a>18.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8946: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8947: the fonts database in the directory where they get installed at
8948: installation and deinstallation time. This can be automatically
8949: done by using the pkginstall framework.</p>
1.75 rillig 8950: <p>You can list the directories where fonts are installed in the
1.87 wiz 8951: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8952: variables, where <em class="replaceable"><code>type</code></em> can be one of
8953: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
8954: Also make sure that the database file
8955: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8956: <p>Note that you should not create new directories for fonts;
1.87 wiz 8957: instead use the standard ones to avoid that the user needs to
8958: manually configure his X server to find them.</p>
1.75 rillig 8959: </div>
8960: <div class="sect2" lang="en">
8961: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8962: <a name="gtk2-modules"></a>18.6.11. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8963: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8964: take some extra steps to get them registered in the GTK2 database
8965: properly:</p>
1.75 rillig 8966: <div class="orderedlist"><ol type="1">
8967: <li><p>Include
1.87 wiz 8968: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8969: <code class="filename">buildlink3.mk</code> file. This takes care of
8970: rebuilding the database at installation and deinstallation time.</p></li>
8971: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
8972: your package installs GTK2 immodules.</p></li>
8973: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
8974: GTK2 loaders.</p></li>
1.75 rillig 8975: <li>
1.87 wiz 8976: <p>Patch the package to not touch any of the GTK2
8977: databases directly. These are:</p>
1.75 rillig 8978: <div class="itemizedlist"><ul type="disc">
1.76 rillig 8979: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8980: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8981: </ul></div>
8982: </li>
1.87 wiz 8983: <li><p>Check the <code class="filename">PLIST</code> and remove
8984: any entries under the <code class="filename">libdata/gtk-2.0</code>
8985: directory, as they will be handled automatically.</p></li>
1.75 rillig 8986: </ol></div>
8987: </div>
8988: <div class="sect2" lang="en">
8989: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8990: <a name="sgml-xml-data"></a>18.6.12. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8991: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8992: registered in system-wide catalogs (like DTDs, sub-catalogs,
8993: etc.), you need to take some extra steps:</p>
1.75 rillig 8994: <div class="orderedlist"><ol type="1">
8995: <li><p>Include
1.87 wiz 8996: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8997: your <code class="filename">Makefile</code>, which takes care of
8998: registering those files in system-wide catalogs at
8999: installation and deinstallation time.</p></li>
1.75 rillig 9000: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9001: any SGML catalogs installed by the package.</p></li>
1.75 rillig 9002: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9003: any XML catalogs installed by the package.</p></li>
1.75 rillig 9004: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9005: to be added to the SGML catalog. These come in groups of
9006: three strings; see xmlcatmgr(1) for more information
9007: (specifically, arguments recognized by the 'add' action).
9008: Note that you will normally not use this variable.</p></li>
1.75 rillig 9009: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9010: to be added to the XML catalog. These come in groups of three
9011: strings; see xmlcatmgr(1) for more information (specifically,
9012: arguments recognized by the 'add' action). Note that you will
9013: normally not use this variable.</p></li>
1.75 rillig 9014: </ol></div>
9015: </div>
9016: <div class="sect2" lang="en">
9017: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9018: <a name="mime-database"></a>18.6.13. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9019: <p>If a package provides extensions to the MIME database by
1.87 wiz 9020: installing <code class="filename">.xml</code> files inside
9021: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9022: need to take some extra steps to ensure that the database is kept
9023: consistent with respect to these new files:</p>
1.75 rillig 9024: <div class="orderedlist"><ol type="1">
9025: <li><p>Include
1.87 wiz 9026: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9027: (avoid using the <code class="filename">buildlink3.mk</code> file from
9028: this same directory, which is reserved for inclusion from
9029: other <code class="filename">buildlink3.mk</code> files). It takes
9030: care of rebuilding the MIME database at installation and
9031: deinstallation time, and disallows any access to it directly
9032: from the package.</p></li>
1.75 rillig 9033: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9034: <code class="filename">share/mime</code> directory,
9035: <span class="emphasis"><em>except</em></span> for files saved under
9036: <code class="filename">share/mime/packages</code>. The former are
9037: handled automatically by
9038: the update-mime-database program, but the latter are
9039: package-dependent and must be removed by the package that
9040: installed them in the first place.</p></li>
1.76 rillig 9041: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9042: from the PLIST. They will be handled by the shared-mime-info
9043: package.</p></li>
1.75 rillig 9044: </ol></div>
9045: </div>
9046: <div class="sect2" lang="en">
9047: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9048: <a name="intltool"></a>18.6.14. Packages using intltool</h3></div></div></div>
1.93 rillig 9049: <p>If a package uses intltool during its build, add
9050: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9051: which forces it to use the intltool package provided by pkgsrc,
9052: instead of the one bundled with the distribution file.</p>
1.75 rillig 9053: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9054: latest available version; this way, the package benefits of any
9055: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9056: </div>
9057: <div class="sect2" lang="en">
9058: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9059: <a name="startup-scripts"></a>18.6.15. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9060: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9061: the startup directory by default, but you can enable it, by adding
9062: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
9063: <code class="filename">/etc/mk.conf</code>. This option will copy the scripts
9064: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9065: it will automatically remove the scripts when the package is
9066: deinstalled.</p>
1.75 rillig 9067: </div>
9068: <div class="sect2" lang="en">
9069: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9070: <a name="tex-packages"></a>18.6.16. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9071: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9072: the <code class="filename">ls-R</code> database of the tree needs to be
9073: updated.</p>
1.75 rillig 9074: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9075: <h3 class="title">Note</h3>
9076: <p>Except the main TeX packages such as teTeX-texmf,
1.87 wiz 9077: packages should install files
9078: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9079: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75 rillig 9080: </div>
9081: <div class="orderedlist"><ol type="1">
9082: <li><p>Include
1.87 wiz 9083: <code class="filename">../../print/teTeX/module.mk</code> instead
9084: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
9085: takes care of rebuilding the <code class="filename">ls-R</code>
9086: database at installation and deinstallation time.</p></li>
1.75 rillig 9087: <li>
9088: <p>If your package installs files into a texmf
1.87 wiz 9089: tree other than the one
9090: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9091: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
9092: trees that need database update.</p>
1.75 rillig 9093: <p>If your package also installs font map files that need
1.87 wiz 9094: to be registered using <span><strong class="command">updmap</strong></span>,
9095: set <code class="varname">TEX_FONTMAPS</code> to the list of all
9096: such font map files. Then <span><strong class="command">updmap</strong></span> will
9097: be run automatically at installation/deinstallation to
9098: enable/disable font map files for TeX output
9099: drivers.</p>
1.75 rillig 9100: </li>
1.76 rillig 9101: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9102: databases are included in <code class="filename">PLIST</code>, as
9103: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 9104: </ol></div>
9105: </div>
1.85 jmmv 9106: <div class="sect2" lang="en">
9107: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9108: <a name="emulation-packages"></a>18.6.17. Packages supporting running binaries in
1.87 wiz 9109: emulation</h3></div></div></div>
9110: <p>There are some packages that provide libraries and
9111: executables for running binaries from a one operating system
9112: on a different one (if the latter supports it). One example
9113: is running Linux binaries on NetBSD.</p>
1.91 rillig 9114: <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 9115: helps in extracting and packaging Linux rpm packages.</p>
9116: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
9117: avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
9118: if all libraries for each installed executable can be found by
9119: the dynamic linker. Since the standard dynamic linker is run,
9120: this fails for emulation packages, because the libraries used
9121: by the emulation are not in the standard directories.</p>
9122: </div>
9123: <div class="sect2" lang="en">
9124: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9125: <a name="hicolor-theme"></a>18.6.18. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9126: <p>If a package installs images under the
1.87 wiz 9127: <code class="filename">share/icons/hicolor</code> and/or updates the
9128: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9129: database, you need to take some extra steps to make sure that the
9130: shared theme directory is handled appropriately and that the cache
9131: database is rebuilt:</p>
1.85 jmmv 9132: <div class="orderedlist"><ol type="1">
9133: <li><p>Include
1.87 wiz 9134: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9135: <li><p>Check the <code class="filename">PLIST</code> and remove the
9136: entry that refers to the theme cache.</p></li>
1.85 jmmv 9137: <li><p>Ensure that the PLIST does not remove the shared icon
9138: directories from the <code class="filename">share/icons/hicolor</code>
9139: hierarchy because they will be handled automatically.</p></li>
9140: </ol></div>
9141: <p>The best way to verify that the PLIST is correct with
9142: respect to the last two points is to regenerate it using
9143: <span><strong class="command">make print-PLIST</strong></span>.</p>
9144: </div>
9145: <div class="sect2" lang="en">
9146: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9147: <a name="desktop-files"></a>18.6.19. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9148: <p>If a package installs <code class="filename">.desktop</code> files
9149: under <code class="filename">share/applications</code> and these include
9150: MIME information, you need to take extra steps to ensure that they
9151: are registered into the MIME database:</p>
9152: <div class="orderedlist"><ol type="1">
9153: <li><p>Include
9154: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9155: <li><p>Check the PLIST and remove the entry that refers to the
9156: <code class="filename">share/applications/mimeinfo.cache</code> file.
9157: It will be handled automatically.</p></li>
9158: </ol></div>
9159: <p>The best way to verify that the PLIST is correct with
9160: respect to the last point is to regenerate it using <span><strong class="command">make
9161: print-PLIST</strong></span>.</p>
1.75 rillig 9162: </div>
9163: </div>
1.87 wiz 9164: <div class="sect1" lang="en">
9165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9166: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9167: <p>In some cases one does not have the time to solve a problem
9168: immediately. There are currently two ways to declare that one knows
9169: that a package has problems.</p>
9170: <div class="itemizedlist"><ul type="disc">
9171: <li><p>The first way is to plainly mark it as broken. For
9172: this, one just sets the variable <code class="varname">BROKEN</code> to the
9173: reason why the package is broken (similar to the
9174: <code class="varname">RESTRICTED</code> variable). A user trying to build
9175: the package will immediately be shown this message, and the build
9176: will not be even tried.</p></li>
9177: <li><p>After each pkgsrc freeze period (a time when the
9178: tree is stabilized and a new pkgsrc branch is cut), the packages
9179: that were not building in the official branch build on the latest
9180: NetBSD release will be marked as broken on that branch. This is
9181: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9182: branch name (or appending the branch name to it). If a user tries
9183: to build such a package and the build fails, the user gets a
9184: message that says that the package was broken on the respective
9185: branch(es).</p></li>
9186: </ul></div>
9187: <p>Both types of packages are removed from pkgsrc in irregular
9188: intervals.</p>
9189: </div>
1.75 rillig 9190: </div>
9191: <div class="chapter" lang="en">
9192: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9193: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88 wiz 9194: <p>To check out all the gotchas when building a package, here are
9195: the steps that I do in order to get a package working. Please note
9196: this is basically the same as what was explained in the previous
9197: sections, only with some debugging aids.</p>
1.75 rillig 9198: <div class="itemizedlist"><ul type="disc">
1.88 wiz 9199: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=1</code> in
9200: <code class="filename">/etc/mk.conf</code></p></li>
1.75 rillig 9201: <li>
1.91 rillig 9202: <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 9203: create a directory for a new package, change into it, then run
9204: <span><strong class="command">url2pkg</strong></span>:</p>
1.75 rillig 9205: <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>
9206: <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>
9207: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9208: </li>
1.76 rillig 9209: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9210: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87 wiz 9211: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75 rillig 9212: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9213: configure step to the package's
9214: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 9215: <li>
9216: <p>Make the package compile, doing multiple rounds of</p>
9217: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9218: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9219: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9220: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9221: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9222: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9223: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9224: <p>Doing this step as non-root user will ensure that no files
9225: are modified that shouldn't be, especially during the build
9226: phase. <span><strong class="command">mkpatches</strong></span>,
9227: <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91 rillig 9228: 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 9229: package.</p>
1.75 rillig 9230: </li>
1.88 wiz 9231: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90 rillig 9232: necessary; see <a href="#components.Makefile" title="10.1. Makefile">Section 10.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.75 rillig 9233: <li>
1.76 rillig 9234: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9235: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9236: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9237: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9238: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9239: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9240: <p>You usually need to be <code class="username">root</code> to do
9241: this. Look if there are any files left:</p>
1.75 rillig 9242: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9243: <p>If this reveals any files that are missing in
1.88 wiz 9244: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9245: </li>
9246: <li>
1.88 wiz 9247: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9248: package again and make a binary package:</p>
1.75 rillig 9249: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9250: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9251: </li>
9252: <li>
9253: <p>Delete the installed package:</p>
1.88 wiz 9254: <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 9255: </li>
9256: <li>
1.88 wiz 9257: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
9258: command, which shouldn't find anything now:</p>
1.75 rillig 9259: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9260: </li>
9261: <li>
9262: <p>Reinstall the binary package:</p>
1.93 rillig 9263: <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 9264: </li>
1.88 wiz 9265: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9266: <li>
1.91 rillig 9267: <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 9268: reports:</p>
1.75 rillig 9269: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9270: </li>
1.90 rillig 9271: <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 9272: </ul></div>
9273: </div>
9274: <div class="chapter" lang="en">
9275: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9276: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75 rillig 9277: <div class="toc">
9278: <p><b>Table of Contents</b></p>
9279: <dl>
1.90 rillig 9280: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
9281: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9282: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
9283: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
9284: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
9285: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9286: </dl>
9287: </div>
9288: <div class="sect1" lang="en">
9289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9290: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9291: <p>Our policy is that we accept binaries only from pkgsrc
9292: developers to guarantee that the packages don't contain any
9293: trojan horses etc. This is not to annoy anyone but rather to
9294: protect our users! You're still free to put up your home-made
9295: binary packages and tell the world where to get them. NetBSD
9296: developers doing bulk builds and wanting to upload them please
9297: 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>
9298: </div>
9299: <div class="sect1" lang="en">
9300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9301: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9302: <p>First, check that your package is complete, compiles and
1.90 rillig 9303: runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75 rillig 9304: 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 9305: archive that contains all files that make up the package.
1.87 wiz 9306: Finally, send this package to the pkgsrc bug tracking system,
9307: 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
9308: that, go to the web page
9309: <a href="http://www.NetBSD.org/Misc/send-pr.html" target="_top">http://www.NetBSD.org/Misc/send-pr.html</a>,
9310: which contains some instructions and a link to a form, where you
9311: can submit packages.</p>
9312: <p>In the form of the problem report, the category should be
9313: “<span class="quote">pkg</span>”, the synopsis should include the package name
9314: and version number, and the description field should contain a
9315: short description of your package (contents of the COMMENT
9316: variable or DESCR file are OK). The uuencoded package data should
9317: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9318: <p>If you want to submit several packages, please send a
9319: separate PR for each one, it's easier for us to track things
9320: that way.</p>
9321: <p>Alternatively, you can also import new packages into
9322: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
9323: homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9324: for details.</p>
9325: </div>
9326: <div class="sect1" lang="en">
9327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9328: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9329: <p>Please note all package additions, updates, moves, and
1.93 rillig 9330: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9331: important to keep this file up to date and conforming to the
9332: existing format, because it will be used by scripts to
9333: automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9334: sites. Additionally, check the
1.76 rillig 9335: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9336: for the package you updated or removed, in case it was mentioned
9337: there.</p>
9338: <p>When the <code class="varname">PKGREVISION</code> of a package is
9339: bumped, the change should appear in
1.93 rillig 9340: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9341: related or otherwise relevant. Mass bumps that result from a
9342: dependency being updated should not be mentioned. In all other
9343: cases it's the developer's decision.</p>
9344: <p>There is a make target that helps in creating proper
1.93 rillig 9345: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span><strong class="command">make
1.75 rillig 9346: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9347: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9348: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9349: file is up-to-date (to avoid having to resolve conflicts later-on)
9350: and then to <span><strong class="command">cd</strong></span> to the package directory. For
9351: package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
9352: For new packages, or package moves or removals, set the
9353: <code class="varname">CTYPE</code> variable on the command line to "Added",
9354: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.76 rillig 9355: in <code class="filename">/etc/mk.conf</code> if your local login name is
1.75 rillig 9356: not the same as your NetBSD login name. Don't forget to commit
1.93 rillig 9357: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75 rillig 9358: </div>
9359: <div class="sect1" lang="en">
9360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9361: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9362: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9363: access to the pkgsrc repository. Please remember that cvs
9364: imports files relative to the current working directory, and that
9365: the pathname that you
9366: give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
9367: to place the files in the repository. Newly created packages should be
9368: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9369: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9370: <pre class="programlisting">
9371: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9372: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
9373: </pre>
1.87 wiz 9374: <p>Remember to move the directory from which you imported out of
1.75 rillig 9375: the way, or cvs will complain the next time you “<span class="quote">cvs
9376: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9377: package to the category's <code class="filename">Makefile</code>.</p>
9378: <p>The commit message of the initial import should include part of the
1.76 rillig 9379: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9380: what the package is/does.</p>
9381: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9382: add</span>” because the former gets everything with a single command,
1.87 wiz 9383: and provides a consistent tag.</p>
1.75 rillig 9384: </div>
9385: <div class="sect1" lang="en">
9386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9387: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9388: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9389: changes between old and new versions into the commit log when updating
1.87 wiz 9390: a package. There are various reasons for this:</p>
1.75 rillig 9391: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9392: <li><p>A URL is volatile, and can change over time. It may go away completely
9393: or its information may be overwritten by newer information.</p></li>
9394: <li><p>Having the change information between old and new versions in our CVS
9395: repository is very useful for people who use either cvs or anoncvs.</p></li>
9396: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9397: repository is very useful for people who read the pkgsrc-changes mailing
9398: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9399: the package.</p></li>
1.75 rillig 9400: </ul></div>
1.87 wiz 9401: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9402: has been released, it should not automatically be upgraded in the CVS
9403: repository. We prefer to be conservative in the packages that are
9404: included in pkgsrc - development or beta packages are not really the
9405: best thing for most places in which pkgsrc is used. Please use your
9406: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9407: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9408: </div>
9409: <div class="sect1" lang="en">
9410: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9411: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75 rillig 9412: <div class="orderedlist"><ol type="1">
9413: <li><p>Make a copy of the directory somewhere else.</p></li>
9414: <li>
9415: <p>Remove all CVS dirs.</p>
1.87 wiz 9416: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9417: <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 9418: <p>and use that for further work.</p>
1.75 rillig 9419: </li>
9420: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9421: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9422: instead of “<span class="quote">../../category/package</span>”.</p></li>
9423: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
9424: place.</p></li>
9425: <li>
9426: <p>Check if any package depends on it:
9427: </p>
9428: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9429: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9430: </li>
9431: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
9432: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9433: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9434: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9435: <li>
9436: <p>Commit the changed and removed files:</p>
9437: <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 9438: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9439: </li>
9440: </ol></div>
9441: </div>
9442: </div>
9443: <div class="chapter" lang="en">
9444: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9445: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9446: <p>This section contains the answers to questions that may
9447: arise when you are writing a package. If you don't find your
9448: question answered here, first have a look in the other chapters,
9449: and if you still don't have the answer, ask on the
9450: <code class="literal">pkgsrc-users</code> mailing list.</p>
9451: <div class="qandaset">
9452: <dl>
1.93 rillig 9453: <dt>21.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9454: MAKEFLAGS, .MAKEFLAGS and
9455: MAKE_FLAGS?</a>
9456: </dt>
1.93 rillig 9457: <dt>21.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9458: MAKE, GMAKE and
9459: MAKE_PROGRAM?</a>
9460: </dt>
1.93 rillig 9461: <dt>21.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9462: CC, PKG_CC and
9463: PKGSRC_COMPILER?</a>
9464: </dt>
1.93 rillig 9465: <dt>21.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9466: BUILDLINK_LDFLAGS,
9467: BUILDLINK_LDADD and
9468: BUILDLINK_LIBS?</a>
9469: </dt>
1.93 rillig 9470: <dt>21.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9471: VARNAME=BUILDLINK_PREFIX.foo
9472: say it's empty?</a>
9473: </dt>
1.93 rillig 9474: <dt>21.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9475: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9476: don't understand the := inside
9477: it.</a>
9478: </dt>
1.93 rillig 9479: <dt>21.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9480: developers?</a>
9481: </dt>
1.93 rillig 9482: <dt>21.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9483: documentation?</a>
9484: </dt>
1.92 rillig 9485: <dt>21.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
9486: do?</a>
9487: </dt>
1.75 rillig 9488: </dl>
9489: <table border="0" summary="Q and A Set">
9490: <col align="left" width="1%">
9491: <tbody>
9492: <tr class="question">
9493: <td align="left" valign="top">
1.98 ! wiz 9494: <a name="devfaq.makeflags"></a><a name="id459757"></a><b>21.1.</b>
1.75 rillig 9495: </td>
9496: <td align="left" valign="top"><p>What is the difference between
9497: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9498: <code class="varname">MAKE_FLAGS</code>?</p></td>
9499: </tr>
9500: <tr class="answer">
1.91 rillig 9501: <td align="left" valign="top"></td>
1.75 rillig 9502: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9503: 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
9504: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9505: the <code class="varname">MAKE_PROGRAM</code> when building the
9506: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9507: </tr>
9508: <tr class="question">
9509: <td align="left" valign="top">
1.98 ! wiz 9510: <a name="devfaq.make"></a><a name="id459792"></a><b>21.2.</b>
1.75 rillig 9511: </td>
9512: <td align="left" valign="top"><p>What is the difference between
9513: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9514: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9515: </tr>
9516: <tr class="answer">
1.91 rillig 9517: <td align="left" valign="top"></td>
1.75 rillig 9518: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9519: <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
9520: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9521: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9522: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9523: Make program that is used for building the
9524: package.</p></td>
9525: </tr>
9526: <tr class="question">
9527: <td align="left" valign="top">
1.98 ! wiz 9528: <a name="devfaq.cc"></a><a name="id459830"></a><b>21.3.</b>
1.75 rillig 9529: </td>
9530: <td align="left" valign="top"><p>What is the difference between
9531: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9532: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9533: </tr>
9534: <tr class="answer">
1.91 rillig 9535: <td align="left" valign="top"></td>
1.75 rillig 9536: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9537: compiler, which can be configured by the pkgsrc user.
9538: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9539: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9540: path to a compiler, but the type of compiler that should be
1.76 rillig 9541: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9542: information about the latter variable.</p></td>
9543: </tr>
9544: <tr class="question">
9545: <td align="left" valign="top">
1.98 ! wiz 9546: <a name="devfaq.bl3flags"></a><a name="id459868"></a><b>21.4.</b>
1.75 rillig 9547: </td>
9548: <td align="left" valign="top"><p>What is the difference between
9549: <code class="varname">BUILDLINK_LDFLAGS</code>,
9550: <code class="varname">BUILDLINK_LDADD</code> and
9551: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9552: </tr>
9553: <tr class="answer">
1.91 rillig 9554: <td align="left" valign="top"></td>
1.75 rillig 9555: <td align="left" valign="top"><p>[FIXME]</p></td>
9556: </tr>
9557: <tr class="question">
9558: <td align="left" valign="top">
1.98 ! wiz 9559: <a name="devfaq.bl3prefix"></a><a name="id459888"></a><b>21.5.</b>
1.75 rillig 9560: </td>
9561: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
9562: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9563: say it's empty?</p></td>
9564: </tr>
9565: <tr class="answer">
1.91 rillig 9566: <td align="left" valign="top"></td>
1.75 rillig 9567: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9568: available in the “<span class="quote">wrapper</span>” phase and later. To
9569: “<span class="quote">simulate</span>” the wrapper phase, append
9570: <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
9571: command.</p></td>
9572: </tr>
1.78 rillig 9573: <tr class="question">
9574: <td align="left" valign="top">
1.98 ! wiz 9575: <a name="devfaq.master_sites"></a><a name="id459917"></a><b>21.6.</b>
1.78 rillig 9576: </td>
9577: <td align="left" valign="top"><p>What does
9578: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9579: don't understand the <code class="literal">:=</code> inside
9580: it.</p></td>
9581: </tr>
9582: <tr class="answer">
1.91 rillig 9583: <td align="left" valign="top"></td>
1.78 rillig 9584: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9585: assignment operator, like you might expect at first sight.
9586: Instead, it is a degenerate form of
9587: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9588: 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
9589: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9590: case of <code class="varname">MASTER_SITE_*</code>,
9591: <em class="replaceable"><code>old_string</code></em> is the empty string and
9592: <em class="replaceable"><code>new_string</code></em> is
9593: <code class="literal">package/</code>. That's where the
9594: <code class="literal">:</code> and the <code class="literal">=</code> fall
9595: together.</p></td>
9596: </tr>
9597: <tr class="question">
9598: <td align="left" valign="top">
1.98 ! wiz 9599: <a name="devfaq.mailinglists"></a><a name="id460061"></a><b>21.7.</b>
1.78 rillig 9600: </td>
9601: <td align="left" valign="top"><p>Which mailing lists are there for package
9602: developers?</p></td>
9603: </tr>
9604: <tr class="answer">
1.91 rillig 9605: <td align="left" valign="top"></td>
1.78 rillig 9606: <td align="left" valign="top"><div class="variablelist"><dl>
9607: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
9608: <dd><p>This is a list for technical discussions related
9609: to pkgsrc development, e.g. soliciting feedback for changes to
9610: pkgsrc infrastructure, proposed new features, questions related
9611: to porting pkgsrc to a new platform, advice for maintaining a
9612: package, patches that affect many packages, help requests moved
9613: from pkgsrc-users when an infrastructure bug is found,
9614: etc.</p></dd>
9615: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
9616: <dd><p>All bug reports in category "pkg" sent with
9617: <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
9618: directly; use one of the other mailing
9619: lists.</p></dd>
9620: </dl></div></td>
9621: </tr>
1.80 rillig 9622: <tr class="question">
9623: <td align="left" valign="top">
1.98 ! wiz 9624: <a name="devfaq.documentation"></a><a name="id460131"></a><b>21.8.</b>
1.80 rillig 9625: </td>
9626: <td align="left" valign="top"><p>Where is the pkgsrc
9627: documentation?</p></td>
9628: </tr>
9629: <tr class="answer">
1.91 rillig 9630: <td align="left" valign="top"></td>
1.80 rillig 9631: <td align="left" valign="top">
9632: <p>There are many places where you can find
9633: documentation about pkgsrc:</p>
9634: <div class="itemizedlist"><ul type="disc">
9635: <li><p>The pkgsrc guide (this document) is a collection
9636: of chapters that explain large parts of pkgsrc, but some
9637: chapters tend to be outdated. Which ones they are is hard to
9638: say.</p></li>
9639: <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
9640: about certain features, announcements of new parts of the pkgsrc
9641: infrastructure and sometimes even announcements that a certain
9642: feature has been marked as obsolete. The benefit here is that
9643: each message has a date appended to it.</p></li>
9644: <li><p>Many of the files in the
9645: <code class="filename">mk/</code> directory start with a comment that
9646: describes the purpose of the file and how it can be used by the
1.92 rillig 9647: pkgsrc user and package authors. An easy way to find this
9648: documentation is to run <span><strong class="command">bmake
9649: help</strong></span>.</p></li>
1.80 rillig 9650: <li><p>The CVS log messages are a rich source of
9651: information, but they tend to be highly abbreviated, especially
9652: for actions that occur often. Some contain a detailed
9653: description of what has changed, but they are geared towards the
9654: other pkgsrc developers, not towards an average pkgsrc user.
9655: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9656: don't know what has been before, these messages may not be worth
9657: too much to you.</p></li>
9658: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9659: documented</span>”, that is the documentation exists only in the
9660: mind of the developer who wrote the code. To get this
1.93 rillig 9661: information, use the <span><strong class="command">cvs annotate</strong></span> command
1.80 rillig 9662: to see who has written it and ask on the
9663: <code class="literal">tech-pkg</code> mailing list, so that others can
9664: find your questions later (see above). To be sure that the
9665: developer in charge reads the mail, you may CC him or
9666: her.</p></li>
9667: </ul></div>
9668: </td>
9669: </tr>
1.92 rillig 9670: <tr class="question">
9671: <td align="left" valign="top">
1.98 ! wiz 9672: <a name="devfaq.too-much-time"></a><a name="id460227"></a><b>21.9.</b>
1.92 rillig 9673: </td>
9674: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9675: do?</p></td>
9676: </tr>
9677: <tr class="answer">
9678: <td align="left" valign="top"></td>
9679: <td align="left" valign="top">
1.93 rillig 9680: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9681: anyway.</p>
9682: <div class="itemizedlist"><ul type="disc">
9683: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
9684: <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
9685: will tell you about newer versions of installed packages that are
9686: available, but not yet updated in pkgsrc.</p></li>
9687: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
9688: — it contains a list of suggested new packages and a list of
9689: cleanups and enhancements for pkgsrc that would be nice to
9690: have.</p></li>
9691: <li><p>Review packages for which review was requested on
9692: the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9693: mailing list.</p></li>
9694: </ul></div>
9695: </td>
9696: </tr>
1.75 rillig 9697: </tbody>
9698: </table>
9699: </div>
9700: </div>
1.85 jmmv 9701: <div class="chapter" lang="en">
9702: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9703: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9704: <div class="toc">
9705: <p><b>Table of Contents</b></p>
9706: <dl>
1.90 rillig 9707: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9708: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9709: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9710: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 9711: </dl>
9712: </div>
9713: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
9714: site</a>:</p>
9715: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9716: environment, an intuitive and attractive desktop for users, and the
9717: GNOME development platform, an extensive framework for building
9718: applications that integrate into the rest of the desktop.</p></blockquote></div>
9719: <p>pkgsrc provides a seamless way to automatically build and install
9720: a complete GNOME environment <span class="emphasis"><em>under many different
9721: platforms</em></span>. We can say with confidence that pkgsrc is one of
9722: the most advanced build and packaging systems for GNOME due to its
9723: included technologies buildlink3, the wrappers and tools framework and
9724: automatic configuration file management. Lots of efforts are put into
9725: achieving a completely clean deinstallation of installed software
9726: components.</p>
9727: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9728: the above also means that great efforts are put into making GNOME work
9729: under this operating system. Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9730: pkgsrc as its preferred packaging system, contributing lots of
9731: portability fixes to make GNOME build and install under it.</p>
9732: <p>This chapter is aimed at pkgsrc developers and other people
9733: interested in helping our GNOME porting and packaging efforts. It
9734: provides instructions on how to manage the existing packages and some
9735: important information regarding their internals.</p>
9736: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9737: <h3 class="title">We need your help!</h3>
9738: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9739: and GNOME and are willing to learn new exciting stuff, please jump
9740: straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9741: work</a> list! There is still a long way to go to get a
9742: fully-functional GNOME desktop under NetBSD and we need your help to
9743: achieve it!</p>
9744: </div>
9745: <div class="sect1" lang="en">
9746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9747: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85 jmmv 9748: <p>pkgsrc includes three GNOME-related meta packages:</p>
9749: <div class="itemizedlist"><ul type="disc">
1.91 rillig 9750: <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 9751: the core GNOME desktop environment. It only includes the necessary
9752: bits to get it to boot correctly, although it may lack important
9753: functionality for daily operation. The idea behind this package is
9754: to let end users build their own configurations on top of this one,
9755: first installing this meta package to achieve a functional setup and
9756: then adding individual applications.</p></li>
1.91 rillig 9757: <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 9758: complete installation of the GNOME platform and desktop as defined
9759: by the GNOME project; this is based on the components distributed in
9760: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9761: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9762: official FTP server. Developer-only tools found in those
9763: directories are not installed unless required by some other
9764: component to work properly. Similarly, packages from the bindings
9765: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9766: in unless required as a dependency for an end-user component. This
1.91 rillig 9767: 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>
9768: <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 9769: Installs all the tools required to build a GNOME component when
9770: fetched from the CVS repository. These are required to let the
9771: <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
9772: </ul></div>
9773: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9774: sorted in a way that eases updates: a package may depend on other
9775: packages listed before it but not on any listed after it. It is very
9776: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9777: change it to alphabetical sorting!</em></span></p>
9778: </div>
9779: <div class="sect1" lang="en">
9780: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9781: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9782: <p>Almost all GNOME applications are written in C and use a common
9783: set of tools as their build system. Things get different with the new
9784: bindings to other languages (such as Python), but the following will
9785: give you a general idea on the minimum required tools:</p>
9786: <div class="itemizedlist"><ul type="disc">
9787: <li>
9788: <p>Almost all GNOME applications use the GNU Autotools as their
9789: build system. As a general rule you will need to tell this to your
9790: package:</p>
9791: <pre class="programlisting">GNU_CONFIGURE=yes
9792: USE_LIBTOOL=yes
9793: USE_TOOLS+=gmake</pre>
9794: </li>
9795: <li>
9796: <p>If the package uses pkg-config to detect dependencies, add this
9797: tool to the list of required utilities:</p>
9798: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9799: <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 9800: the end of the build process to ensure that you did not miss to
9801: specify any dependency in your package and that the version
9802: requirements are all correct.</p>
9803: </li>
1.93 rillig 9804: <li><p>If the package uses intltool, be sure to add
9805: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9806: to handle dependencies and to force the package to use the latest
9807: available version.</p></li>
9808: <li>
9809: <p>If the package uses gtk-doc (a documentation generation
9810: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9811: tool is rather big and the distfile should come with pregenerated
9812: documentation anyway; if it does not, it is a bug that you ought to
9813: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9814: the default):</p>
9815: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9816: <p>The default location of installed HTML files
9817: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9818: and should not be changed unless the package insists on installing
9819: them somewhere else. Otherwise programs as
9820: <span><strong class="command">devhelp</strong></span> will not be able to open them. You can
9821: do that with an entry similar to:</p>
9822: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9823: </li>
9824: </ul></div>
9825: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9826: files under the installation prefix to maintain databases. In this
9827: context, shared means that those exact same directories and files are
9828: used among several different packages, leading to conflicts in the
9829: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9830: handle the most common cases, so you have to forget about using
9831: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9832: omitting shared files from them. If you find yourself doing those,
9833: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9834: <p>The following table lists the common situations that result in
9835: using shared directories or files. For each of them, the appropriate
9836: solution is given. After applying the solution be sure to
9837: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9838: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
9839: <div class="table">
1.90 rillig 9840: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9841: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9842: <colgroup>
9843: <col>
9844: <col>
9845: </colgroup>
9846: <thead><tr>
9847: <th>If the package...</th>
9848: <th>Then...</th>
9849: </tr></thead>
9850: <tbody>
9851: <tr>
9852: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.90 rillig 9853: <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 9854: </tr>
9855: <tr>
9856: <td>Installs icons under the
9857: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9858: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.90 rillig 9859: <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 9860: </tr>
9861: <tr>
9862: <td>Installs files under
9863: <code class="filename">share/mime/packages</code>.</td>
1.90 rillig 9864: <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 9865: </tr>
9866: <tr>
9867: <td>Installs <code class="filename">.desktop</code> files under
9868: <code class="filename">share/applications</code> and these include MIME
9869: information.</td>
1.90 rillig 9870: <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 9871: </tr>
9872: </tbody>
1.91 rillig 9873: </table></div>
1.85 jmmv 9874: </div>
1.91 rillig 9875: <br class="table-break">
1.85 jmmv 9876: </div>
9877: <div class="sect1" lang="en">
9878: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9879: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9880: <p>When seeing GNOME as a whole, there are two kinds of
9881: updates:</p>
9882: <div class="variablelist"><dl>
9883: <dt><span class="term">Major update</span></dt>
9884: <dd>
9885: <p>Given that there is still a very long way for GNOME 3 (if it
9886: ever appears), we consider a major update one that goes from a
9887: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9888: where <code class="literal">Y</code> is even and greater than
9889: <code class="literal">X</code>. These are hard to achieve because they
9890: introduce lots of changes in the components' code and almost all
9891: GNOME distfiles are updated to newer versions. Some of them can
9892: even break API and ABI compatibility with the previous major
9893: version series. As a result, the update needs to be done all at
9894: once to minimize breakage.</p>
9895: <p>A major update typically consists of around 80 package
9896: updates and the addition of some new ones.</p>
9897: </dd>
9898: <dt><span class="term">Minor update</span></dt>
9899: <dd>
9900: <p>We consider a minor update one that goes from a
9901: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9902: one where <code class="literal">Y</code> is greater than
9903: <code class="literal">X</code>. These are easy to achieve because they do
9904: not update all GNOME components, can be done in an incremental way
9905: and do not break API nor ABI compatibility.</p>
9906: <p>A minor update typically consists of around 50 package
9907: updates, although the numbers here may vary a lot.</p>
9908: </dd>
9909: </dl></div>
9910: <p>In order to update the GNOME components in pkgsrc to a new stable
9911: release (either major or minor), the following steps should be
9912: followed:</p>
9913: <div class="orderedlist"><ol type="1">
9914: <li>
9915: <p>Get a list of all the tarballs that form the new release by
9916: using the following commands. These will leave the full list of the
9917: components's distfiles into the <code class="filename">list.txt</code>
9918: file:</p>
1.88 wiz 9919: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9920: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9921: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9922: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9923: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9924: awk '{ print $9 }' >>list.txt</code></strong></pre>
9925: </li>
9926: <li><p>Open each meta package's <code class="filename">Makefile</code> and
9927: bump their version to the release you are updating them to. The
9928: three meta packages should be always consistent with versioning.
9929: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9930: in them.</p></li>
9931: <li>
9932: <p>For each meta package, update all its
9933: <code class="varname">DEPENDS</code> lines to match the latest versions as
9934: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9935: newer version (even if found in the FTP) because the meta packages
9936: are supposed to list the exact versions that form a specific GNOME
9937: release. Exceptions are permitted here if a newer version solves a
9938: serious issue in the overall desktop experience; these typically
9939: come in the form of a revision bump in pkgsrc, not in newer versions
9940: from the developers.</p>
9941: <p>Packages not listed in the <code class="filename">list.txt</code> file
9942: should be updated to the latest version available (if found in
9943: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 9944: 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 9945: </li>
9946: <li>
9947: <p>Generate a patch from the modified meta packages and extract the
9948: list of "new" lines. This will provide you an outline on what
9949: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9950: <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 9951: </li>
9952: <li><p>For major desktop updates it is recommended to zap all your
9953: installed packages and start over from scratch at this point.</p></li>
9954: <li><p>Now comes the longest step by far: iterate over the contents
9955: of <code class="filename">todo.txt</code> and update the packages listed in
9956: it in order. For major desktop updates none of these should be
1.93 rillig 9957: committed until the entire set is completed because there are chances
1.85 jmmv 9958: of breaking not-yet-updated packages.</p></li>
9959: <li><p>Once the packages are up to date and working, commit them to
9960: the tree one by one with appropriate log messages. At the end,
9961: commit the three meta package updates and all the corresponding
9962: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9963: <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>
9964: </ol></div>
9965: </div>
9966: <div class="sect1" lang="en">
9967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9968: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 9969: <p>GNOME is a very big component in pkgsrc which approaches 100
9970: packages. Please, it is very important that you always, always,
9971: <span class="strong"><strong>always</strong></span> feed back any portability
1.93 rillig 9972: 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 9973: their attention on portability issues and to ensure that future versions
9974: can be built out-of-the box on NetBSD. The less custom patches in
9975: pkgsrc, the easier further updates are. Those developers in charge of
9976: issuing major GNOME updates will be grateful if you do that.</p>
9977: <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
9978: Bugzilla</a>. Not all components use these to track bugs, but most
9979: of them do. Do not be short on your reports: always provide detailed
9980: explanations of the current failure, how it can be improved to achieve
9981: maximum portability and, if at all possible, provide a patch against CVS
9982: head. The more verbose you are, the higher chances of your patch being
9983: accepted.</p>
9984: <p>Also, please avoid using preprocessor magic to fix portability
9985: issues. While the FreeBSD GNOME people are doing a great job in porting
9986: GNOME to their operating system, the official GNOME sources are now
9987: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9988: and similar macros. This hurts portability. Please see our patching
1.93 rillig 9989: guidelines (<a href="#components.patches.guidelines" title="10.3.4. Patching guidelines">Section 10.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 9990: details.</p>
9991: </div>
9992: </div>
1.75 rillig 9993: </div>
9994: <div class="part" lang="en">
9995: <div class="titlepage"><div><div><h1 class="title">
9996: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
9997: <div class="partintro" lang="en">
9998: <div></div>
9999: <p>This part of the guide deals with everything
10000: from the infrastructure that is behind the interfaces described
10001: in the developer's guide. A casual package maintainer should not
10002: need anything from this part.</p>
10003: <div class="toc">
10004: <p><b>Table of Contents</b></p>
10005: <dl>
1.90 rillig 10006: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10007: <dd><dl>
1.90 rillig 10008: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
10009: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
10010: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75 rillig 10011: <dd><dl>
1.90 rillig 10012: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
10013: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75 rillig 10014: </dl></dd>
1.90 rillig 10015: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
10016: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10017: <dd><dl>
1.90 rillig 10018: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
10019: <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 10020: </dl></dd>
1.90 rillig 10021: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10022: <dd><dl>
1.90 rillig 10023: <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>
10024: <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 10025: </dl></dd>
10026: </dl></dd>
1.90 rillig 10027: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 10028: <dd><dl>
1.90 rillig 10029: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10030: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10031: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10032: <dd><dl>
1.90 rillig 10033: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10034: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10035: </dl></dd>
10036: </dl></dd>
1.90 rillig 10037: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 10038: <dd><dl>
1.90 rillig 10039: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10040: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10041: </dl></dd>
10042: </dl>
10043: </div>
10044: </div>
10045: <div class="chapter" lang="en">
10046: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10047: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10048: <div class="toc">
10049: <p><b>Table of Contents</b></p>
10050: <dl>
1.90 rillig 10051: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
10052: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
10053: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 10054: <dd><dl>
1.90 rillig 10055: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
10056: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 10057: </dl></dd>
1.90 rillig 10058: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
10059: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10060: <dd><dl>
1.90 rillig 10061: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
10062: <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 10063: </dl></dd>
1.90 rillig 10064: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10065: <dd><dl>
1.90 rillig 10066: <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>
10067: <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 10068: </dl></dd>
10069: </dl>
10070: </div>
10071: <p>The pkgsrc infrastructure consists of many small Makefile
10072: fragments. Each such fragment needs a properly specified
10073: interface. This chapter explains how such an interface looks
10074: like.</p>
10075: <div class="sect1" lang="en">
10076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10077: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10078: <p>Whenever a variable is defined in the pkgsrc
10079: infrastructure, the location and the way of definition provide
10080: much information about the intended use of that variable.
10081: Additionally, more documentation may be found in a header
10082: comment or in this pkgsrc guide.</p>
10083: <p>A special file is
10084: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10085: variables that are intended to be user-defined. They are either
10086: defined using the <code class="literal">?=</code> operator or they are
10087: left undefined because defining them to anything would
10088: effectively mean “<span class="quote">yes</span>”. All these variables may be
10089: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10090: file.</p>
10091: <p>Outside this file, the following conventions apply:
10092: Variables that are defined using the <code class="literal">?=</code>
10093: operator may be overridden by a package.</p>
10094: <p>Variables that are defined using the <code class="literal">=</code>
10095: operator may be used read-only at run-time.</p>
10096: <p>Variables whose name starts with an underscore must not be
10097: accessed outside the pkgsrc infrastructure at all. They may
10098: change without further notice.</p>
10099: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10100: <h3 class="title">Note</h3>
10101: <p>These conventions are currently not applied
10102: consistently to the complete pkgsrc
10103: infrastructure.</p>
10104: </div>
10105: </div>
10106: <div class="sect1" lang="en">
10107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10108: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10109: <p>All variables that contain lists of things should default
10110: to being empty. Two examples that do not follow this rule are
10111: <code class="varname">USE_LANGUAGES</code> and
10112: <code class="varname">DISTFILES</code>. These variables cannot simply be
10113: modified using the <code class="literal">+=</code> operator in package
10114: <code class="filename">Makefile</code>s (or other files included by
10115: them), since there is no guarantee whether the variable is
10116: already set or not, and what its value is. In the case of
10117: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10118: the default value and just define it as in the following
10119: example.</p>
10120: <pre class="programlisting">
10121: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10122: </pre>
10123: <p>Because of the selection of this default value, the same
10124: value appears in many package Makefiles. Similarly for
10125: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10126: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10127: doesn't stand out. Nevertheless it is mentioned in many
10128: files.</p>
10129: </div>
10130: <div class="sect1" lang="en">
10131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10132: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75 rillig 10133: <div class="sect2" lang="en">
10134: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10135: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75 rillig 10136: <p>Variable evaluation takes place either at load time or at
10137: runtime, depending on the context in which they occur. The
10138: contexts where variables are evaluated at load time are:</p>
10139: <div class="itemizedlist"><ul type="disc">
10140: <li><p>The right hand side of the <code class="literal">:=</code>
10141: and <code class="literal">!=</code> operators,</p></li>
10142: <li><p>Make directives like <code class="literal">.if</code> or
10143: <code class="literal">.for</code>,</p></li>
10144: <li><p>Dependency lines.</p></li>
10145: </ul></div>
10146: <p>A special exception are references to the iteration
10147: variables of <code class="literal">.for</code> loops, which are expanded
10148: inline, no matter in which context they appear.</p>
10149: <p>As the values of variables may change during load time,
10150: care must be taken not to evaluate them by accident. Typical
10151: examples for variables that should not be evaluated at load time
10152: are <code class="varname">DEPENDS</code> and
10153: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10154: clear, here is an example:</p>
10155: <pre class="programlisting">
10156: CONFIGURE_ARGS= # none
10157: CFLAGS= -O
10158: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10159:
1.75 rillig 10160: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10161:
1.75 rillig 10162: CFLAGS+= -Wall
10163: </pre>
10164: <p>This code shows how the use of the <code class="literal">:=</code>
10165: operator can quickly lead to unexpected results. The first
10166: paragraph is fairly common code. The second paragraph evaluates
10167: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10168: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10169: <code class="literal">-Wall</code> is appended to the
10170: <code class="varname">CFLAGS</code>, but this addition will not appear in
10171: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10172: paragraphs from above typically occur in completely unrelated
10173: files.</p>
10174: </div>
10175: <div class="sect2" lang="en">
10176: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10177: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75 rillig 10178: <p>After all the files have been loaded, the values of the
10179: variables cannot be changed anymore. Variables that are used in
10180: the shell commands are expanded at this point.</p>
10181: </div>
10182: </div>
10183: <div class="sect1" lang="en">
10184: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10185: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10186: <p>There are many ways in which the definition and use of a
10187: variable can be restricted in order to detect bugs and
10188: violations of the (mostly unwritten) policies. See the
10189: <code class="literal">pkglint</code> developer's documentation for further
10190: details.</p>
10191: </div>
10192: <div class="sect1" lang="en">
10193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10194: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10195: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10196: of the following classes. Cases where a file falls into more
10197: than one class should be avoided as it often leads to subtle
10198: bugs.</p>
10199: <div class="sect2" lang="en">
10200: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10201: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10202: <p>In a traditional imperative programming language some of
1.76 rillig 10203: the <code class="filename">.mk</code> files could be described as
1.89 rillig 10204: procedures. They take some input parameters and—after
10205: inclusion—provide a result in output parameters. Since all
1.76 rillig 10206: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10207: care must be taken not to use parameter names that have already
10208: another meaning. For example, <code class="varname">PKGNAME</code> is a
10209: bad choice for a parameter name.</p>
10210: <p>Procedures are completely evaluated at preprocessing time.
10211: That is, when calling a procedure all input parameters must be
10212: completely resolvable. For example,
10213: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10214: parameter since it is very likely that further text will be
10215: added after calling the procedure, which would effectively apply
10216: the procedure to only a part of the variable. Also, references
10217: to other variables wit will be modified after calling the
10218: procedure.</p>
10219: <p>A procedure can declare its output parameters either as
10220: suitable for use in preprocessing directives or as only
10221: available at runtime. The latter alternative is for variables
10222: that contain references to other runtime variables.</p>
10223: <p>Procedures shall be written such that it is possible to
10224: call the procedure more than once. That is, the file must not
10225: contain multiple-inclusion guards.</p>
10226: <p>Examples for procedures are
1.76 rillig 10227: <code class="filename">mk/bsd.options.mk</code> and
10228: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10229: that the parameters are evaluated at load time, they should be
10230: assigned using the <code class="literal">:=</code> operator, which should
10231: be used only for this purpose.</p>
10232: </div>
10233: <div class="sect2" lang="en">
10234: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10235: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10236: <p>Action files take some input parameters and may define
10237: runtime variables. They shall not define loadtime variables.
10238: There are action files that are included implicitly by the
10239: pkgsrc infrastructure, while other must be included
10240: explicitly.</p>
10241: <p>An example for action files is
1.76 rillig 10242: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10243: </div>
10244: </div>
1.81 rillig 10245: <div class="sect1" lang="en">
10246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10247: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10248: <p>Package <code class="filename">Makefile</code>s usually consist of
10249: a set of variable definitions, and include the file
10250: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10251: Before that, they may also include various other
10252: <code class="filename">*.mk</code> files if they need to query the
10253: availability of certain features like the type of compiler or
10254: the X11 implementation. Due to the heavy use of preprocessor
10255: directives like <code class="literal">.if</code> and
10256: <code class="literal">.for</code>, the order in which the files are loaded
10257: matters.</p>
10258: <p>This section describes at which point the various files
10259: are loaded and gives reasons for that order.</p>
10260: <div class="sect2" lang="en">
10261: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10262: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code>
10263: </h3></div></div></div>
10264: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10265: is to define some essential variables like
10266: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10267: <code class="varname">MACHINE_ARCH</code>.</p>
10268: <p>Then, the user settings are loaded from the file specified
10269: in <code class="varname">MAKECONF</code>. If the bmake command from pkgsrc
10270: is used, <code class="varname">MAKECONF</code> defaults to
10271: <code class="filename"><em class="replaceable"><code>${prefix}</code></em>/etc/mk.conf</code>.
10272: 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
10273: <code class="filename">/etc/mk.conf</code>. After that, those variables
10274: that have not been overridden by the user are loaded from
10275: <code class="filename">mk/defaults/mk.conf</code>.</p>
10276: <p>After the user settings, the system settings and platform
10277: settings are loaded, which may override the user
10278: settings.</p>
10279: <p>Then, the tool definitions are loaded. The tool wrappers
10280: are not yet in effect. This only happens when building a
10281: package, so the proper variables must be used instead of the
10282: direct tool names.</p>
10283: <p>As the last steps, some essential variables from the
10284: wrapper and the package system flavor are loaded, as well as the
10285: variables that have been cached in earlier phases of a package
10286: build.</p>
10287: </div>
10288: <div class="sect2" lang="en">
10289: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10290: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code>
10291: </h3></div></div></div>
1.81 rillig 10292: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10293: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10294: loaded, which fill default values for those variables that have
1.93 rillig 10295: not been defined by the package. These variables may later
1.81 rillig 10296: be used even in unrelated files.</p>
10297: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10298: provides the target <code class="literal">error-check</code> that is added
10299: as a special dependency to all other targets that use
10300: <code class="varname">DELAYED_ERROR_MSG</code> or
10301: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10302: <p>Then, the package-specific hacks from
10303: <code class="filename">hacks.mk</code> are included.</p>
10304: <p>Then, various other files follow. Most of them don't have
10305: any dependencies on what they need to have included before or
10306: after them, though some do.</p>
10307: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10308: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10309: restricts the use of these variables to all the files that have
10310: been included before. Appearances in later files will be
10311: silently ignored.</p>
10312: <p>Then, the files for the main targets are included, in the
10313: order of later execution, though the actual order should not
10314: matter.</p>
10315: <p>At last, some more files are included that don't set any
10316: interesting variables but rather just define make targets to be
10317: executed.</p>
10318: </div>
10319: </div>
1.75 rillig 10320: </div>
10321: <div class="chapter" lang="en">
10322: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10323: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75 rillig 10324: <div class="toc">
10325: <p><b>Table of Contents</b></p>
10326: <dl>
1.90 rillig 10327: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10328: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10329: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10330: <dd><dl>
1.90 rillig 10331: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10332: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10333: </dl></dd>
10334: </dl>
10335: </div>
10336: <p>The pkgsrc infrastructure consists of a large codebase,
10337: and there are many corners where every little bit of a file is
10338: well thought out, making pkgsrc likely to fail as soon as
10339: anything is changed near those parts. To prevent most changes
10340: from breaking anything, a suite of regression tests should go
10341: along with every important part of the pkgsrc infrastructure.
10342: This chapter describes how regression tests work in pkgsrc and
10343: how you can add new tests.</p>
10344: <div class="sect1" lang="en">
10345: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10346: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10347: <p></p>
10348: </div>
10349: <div class="sect1" lang="en">
10350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10351: <a name="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10352: <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 10353: provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
10354: can simply run that command, which will run all tests in the
1.76 rillig 10355: <code class="filename">regress</code> category.</p>
1.75 rillig 10356: </div>
10357: <div class="sect1" lang="en">
10358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10359: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10360: <p>Every directory in the <code class="filename">regress</code>
10361: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10362: is considered a regression test. This file is a shell program
10363: that is included by the <span><strong class="command">pkg_regress</strong></span> command.
10364: The following functions can be overridden to suit your
10365: needs.</p>
10366: <div class="sect2" lang="en">
10367: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10368: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10369: <p>These functions do not take any parameters. They are all
10370: called in “<span class="quote">set -e</span>” mode, so you should be careful
10371: to check the exitcodes of any commands you run in the
10372: test.</p>
10373: <div class="variablelist"><dl>
10374: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10375: <dd><p>This function prepares the environment for the
10376: test. By default it does nothing.</p></dd>
10377: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10378: <dd><p>This function runs the actual test. By default,
10379: it calls <code class="varname">TEST_MAKE</code> with the arguments
10380: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10381: error messages into the file
10382: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10383: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10384: <dd><p>This function is run after the test and is
10385: typically used to compare the actual output from the one that is
10386: expected. It can make use of the various helper functions from
10387: the next section.</p></dd>
10388: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10389: <dd><p>This function cleans everything up after the
10390: test has been run. By default it does nothing.</p></dd>
10391: </dl></div>
10392: </div>
10393: <div class="sect2" lang="en">
10394: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10395: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10396: <div class="variablelist"><dl>
10397: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10398: <dd><p>This function compares the exitcode of the
10399: <span><strong class="command">do_test()</strong></span> function with its first parameter.
10400: If they differ, the test will fail.</p></dd>
10401: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10402: <dd><p>This function checks for each of its parameters
10403: if the output from <span><strong class="command">do_test()</strong></span> matches the
10404: extended regular expression. If it does not, the test will
10405: fail.</p></dd>
10406: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10407: <dd><p>This function checks for each of its parameters
10408: if the output from <span><strong class="command">do_test()</strong></span> does
10409: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10410: If any of the regular expressions matches, the test will
10411: fail.</p></dd>
10412: </dl></div>
10413: </div>
10414: </div>
10415: </div>
10416: <div class="chapter" lang="en">
10417: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10418: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10419: <div class="toc">
10420: <p><b>Table of Contents</b></p>
10421: <dl>
1.90 rillig 10422: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10423: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10424: </dl>
10425: </div>
10426: <p>The pkgsrc system has already been ported to many
10427: operating systems, hardware architectures and compilers. This
10428: chapter explains the necessary steps to make pkgsrc even more
10429: portable.</p>
10430: <div class="sect1" lang="en">
10431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10432: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10433: <p>To port pkgsrc to a new operating system (called
10434: <code class="literal">MyOS</code> in this example), you need to touch the
10435: following files:</p>
10436: <div class="variablelist"><dl>
1.93 rillig 10437: <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 10438: <dd><p>This file contains some basic definitions, for
10439: example the name of the C
10440: compiler.</p></dd>
1.76 rillig 10441: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10442: <dd><p>Insert code that defines the variables
10443: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10444: <code class="varname">LOWER_OS_VERSION</code>,
10445: <code class="varname">LOWER_VENDOR</code>,
10446: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10447: <code class="varname">APPEND_ELF</code>, and the other variables that
10448: appear in this file.</p></dd>
1.93 rillig 10449: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10450: <dd><p>This file contains the platform-specific
10451: definitions that are used by pkgsrc. Start by copying one of the
10452: other files and edit it to your
10453: needs.</p></dd>
1.93 rillig 10454: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10455: <dd><p>This file contains a list of directories,
10456: together with their permission bits and ownership. These
10457: directories will be created automatically with every package
1.98 ! wiz 10458: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
! 10459: be removed.</p></dd>
1.93 rillig 10460: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10461: <dd><p>Just copy one of the pre-existing x11.dist files
10462: to your
1.76 rillig 10463: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10464: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10465: <dd><p>On some operating systems, the tools that are
10466: provided with the base system are not good enough for pkgsrc.
10467: 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
10468: narrow limit on the line length they can process. Therefore
10469: pkgsrc brings its own tools, which can be enabled
10470: here.</p></dd>
1.93 rillig 10471: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10472: <dd><p>This file defines the paths to all the tools
10473: that are needed by one or the other package in pkgsrc, as well
10474: as by pkgsrc itself. Find out where these tools are on your
10475: platform and add them.</p></dd>
10476: </dl></div>
10477: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10478: <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 10479: </div>
10480: <div class="sect1" lang="en">
10481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10482: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10483: <p>TODO</p>
10484: </div>
10485: </div>
10486: </div>
10487: <div class="appendix" lang="en">
10488: <div class="titlepage"><div><div><h2 class="title">
10489: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10490: <div class="toc">
10491: <p><b>Table of Contents</b></p>
10492: <dl>
10493: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10494: <dd><dl>
10495: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10496: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10497: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10498: <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>
10499: </dl></dd>
10500: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10501: </dl>
10502: </div>
10503: <p>We checked to find a piece of software that wasn't in the packages
10504: collection, and picked GNU bison. Quite why someone would want to have
10505: <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
10506: present in the tree is beyond us, but it's useful for the purposes of
10507: this exercise.</p>
10508: <div class="sect1" lang="en">
10509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10510: <a name="example-files"></a>A.1. files</h2></div></div></div>
10511: <div class="sect2" lang="en">
10512: <div class="titlepage"><div><div><h3 class="title">
10513: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10514: <pre class="programlisting">
1.51 rillig 10515: # $NetBSD$
10516: #
1.1 grant 10517:
1.51 rillig 10518: DISTNAME= bison-1.25
10519: CATEGORIES= devel
10520: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10521:
1.51 rillig 10522: MAINTAINER= thorpej@NetBSD.org
10523: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10524: COMMENT= GNU yacc clone
1.1 grant 10525:
1.51 rillig 10526: GNU_CONFIGURE= yes
10527: INFO_FILES= bison.info
1.1 grant 10528:
1.51 rillig 10529: .include "../../mk/bsd.pkg.mk"
1.1 grant 10530: </pre>
1.75 rillig 10531: </div>
10532: <div class="sect2" lang="en">
10533: <div class="titlepage"><div><div><h3 class="title">
10534: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10535: <pre class="programlisting">
1.51 rillig 10536: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.75 rillig 10537: 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 10538: of the NetBSD source tree is beyond me.
1.1 grant 10539: </pre>
1.75 rillig 10540: </div>
10541: <div class="sect2" lang="en">
10542: <div class="titlepage"><div><div><h3 class="title">
10543: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10544: <pre class="programlisting">
1.51 rillig 10545: @comment $NetBSD$
10546: bin/bison
10547: man/man1/bison.1.gz
10548: share/bison.simple
10549: share/bison.hairy
1.1 grant 10550: </pre>
1.75 rillig 10551: </div>
10552: <div class="sect2" lang="en">
10553: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10554: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
10555: </h3></div></div></div>
1.75 rillig 10556: <p>The NetBSD package system comes with
1.91 rillig 10557: <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 10558: which helps to check the contents of these
10559: files. After installation it is quite easy to use, just change to the
10560: directory of the package you wish to examine and execute
10561: <span><strong class="command">pkglint</strong></span>:</p>
10562: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10563: looks fine.</pre>
10564: <p>Depending on the supplied command line arguments (see pkglint(1)),
10565: more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
10566: -Wall</strong></span> for a very thorough check.</p>
10567: </div>
10568: </div>
10569: <div class="sect1" lang="en">
10570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10571: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10572: <p>Create the directory where the package lives,
10573: plus any auxiliary directories:</p>
10574: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10575: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10576: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10577: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10578: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90 rillig 10579: <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 10580: then continue with fetching the distfile:</p>
10581: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10582: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10583: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10584: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10585: ftp: Error retrieving file: 500 Internal error
10586:
10587: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10588: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10589: ftp: Error retrieving file: 500 Internal error
10590:
10591: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10592: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10593: Successfully retrieved file.</pre>
10594: <p>Generate the checksum of the distfile into
1.76 rillig 10595: <code class="filename">distinfo</code>:</p>
1.88 wiz 10596: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10597: <p>Now compile:</p>
10598: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10599: >> Checksum OK for bison-1.25.tar.gz.
10600: ===> Extracting for bison-1.25
10601: ===> Patching for bison-1.25
10602: ===> Ignoring empty patch directory
10603: ===> Configuring for bison-1.25
10604: creating cache ./config.cache
10605: checking for gcc... cc
10606: checking whether we are using GNU C... yes
10607: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10608: checking how to run the C preprocessor... cc -E
10609: checking for minix/config.h... no
10610: checking for POSIXized ISC... no
10611: checking whether cross-compiling... no
10612: checking for ANSI C header files... yes
10613: checking for string.h... yes
10614: checking for stdlib.h... yes
10615: checking for memory.h... yes
10616: checking for working const... yes
10617: checking for working alloca.h... no
10618: checking for alloca... yes
10619: checking for strerror... yes
10620: updating cache ./config.cache
10621: creating ./config.status
10622: creating Makefile
10623: ===> Building for bison-1.25
10624: 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
10625: 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
10626: 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
10627: 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
10628: 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 10629: 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 10630: 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
10631: 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
10632: 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
10633: 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
10634: 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
10635: 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
10636: 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
10637: 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
10638: 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
10639: 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
10640: 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
10641: 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
10642: 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
10643: 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
10644: 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
10645: 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
10646: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10647: rm -f bison.s1
1.75 rillig 10648: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10649: <p>Everything seems OK, so install the files:</p>
10650: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10651: >> Checksum OK for bison-1.25.tar.gz.
10652: ===> Installing for bison-1.25
10653: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10654: rm -f /usr/pkg/bin/bison
10655: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10656: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10657: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10658: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10659: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10660: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10661: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10662: ===> Registering installation for bison-1.25</pre>
10663: <p>You can now use bison, and also - if you decide so - remove it with
10664: <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
10665: binary package, do this now:</p>
10666: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10667: >> Checksum OK for bison-1.25.tar.gz.
10668: ===> Building package for bison-1.25
10669: Creating package bison-1.25.tgz
10670: Registering depends:.
1.75 rillig 10671: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10672: <p>Now that you don't need the source and object files
10673: any more, clean up:</p>
10674: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10675: ===> Cleaning for bison-1.25</pre>
10676: </div>
10677: </div>
10678: <div class="appendix" lang="en">
10679: <div class="titlepage"><div><div><h2 class="title">
10680: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10681: <div class="toc">
10682: <p><b>Table of Contents</b></p>
10683: <dl>
10684: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10685: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10686: </dl>
10687: </div>
10688: <div class="sect1" lang="en">
10689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10690: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10691: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10692: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10693: => figlet221.tar.gz doesn't seem to exist on this system.
10694: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10695: => [172219 bytes]
10696: Connected to ftp.plig.net.
10697: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10698: 331 Guest login ok, send your complete e-mail address as password.
10699: 230-You are user #5 of 500 simultaneous users allowed.
10700: 230-
1.68 rillig 10701: 230- ___ _ _ _
10702: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10703: 230- | _| _| . |_| . | | | . |_| . | _| . |
10704: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10705: 230- |_| |_| |___| |___|
10706: 230-
10707: 230-** Welcome to ftp.plig.org **
10708: 230-
10709: 230-Please note that all transfers from this FTP site are logged. If you
10710: 230-do not like this, please disconnect now.
10711: 230-
10712: 230-This arhive is available via
10713: 230-
10714: 230-HTTP: http://ftp.plig.org/
10715: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10716: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10717: 230-
10718: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10719: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10720: 230-
10721: 230-
10722: 230 Logged in anonymously.
10723: Remote system type is UNIX.
10724: Using binary mode to transfer files.
10725: 200 Type okay.
10726: 250 "/pub" is new cwd.
10727: 250-"/pub/figlet" is new cwd.
10728: 250-
10729: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10730: 250-
1.75 rillig 10731: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10732: 250-
10733: 250-The official FIGlet web page is:
1.75 rillig 10734: 250- http://www.figlet.org/
1.1 grant 10735: 250-
10736: 250-If you have questions, please mailto:info@figlet.org. If you want to
10737: 250-contribute a font or something else, you can email us.
1.68 rillig 10738: 250
1.1 grant 10739: 250 "/pub/figlet/program" is new cwd.
10740: 250 "/pub/figlet/program/unix" is new cwd.
10741: local: figlet221.tar.gz remote: figlet221.tar.gz
10742: 502 Unimplemented command.
10743: 227 Entering Passive Mode (195,40,6,41,246,104)
10744: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10745: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10746: 226 Transfer completed.
10747: 172219 bytes received in 00:02 (75.99 KB/s)
10748: 221 Goodbye.
10749: => Checksum OK for figlet221.tar.gz.
10750: ===> Extracting for figlet-2.2.1nb2
10751: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10752: ===> Patching for figlet-2.2.1nb2
10753: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10754: ===> Overriding tools for figlet-2.2.1nb2
10755: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10756: ===> Configuring for figlet-2.2.1nb2
10757: ===> Building for figlet-2.2.1nb2
10758: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10759: chmod a+x figlet
10760: gcc -O2 -o chkfont chkfont.c
10761: => Unwrapping files-to-be-installed.
1.14 xtraeme 10762: <code class="prompt">#</code>
1.75 rillig 10763: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10764: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10765: ===> Installing for figlet-2.2.1nb2
10766: install -d -o root -g wheel -m 755 /usr/pkg/bin
10767: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10768: mkdir -p /usr/pkg/share/figlet
10769: cp figlet /usr/pkg/bin
10770: cp chkfont /usr/pkg/bin
10771: chmod 555 figlist showfigfonts
10772: cp figlist /usr/pkg/bin
10773: cp showfigfonts /usr/pkg/bin
10774: cp fonts/*.flf /usr/pkg/share/figlet
10775: cp fonts/*.flc /usr/pkg/share/figlet
10776: cp figlet.6 /usr/pkg/man/man6
10777: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10778: <code class="prompt">#</code></pre>
10779: </div>
10780: <div class="sect1" lang="en">
10781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10782: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10783: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10784: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10785: ===> Packaging figlet-2.2.1nb2
10786: ===> Building binary package for figlet-2.2.1nb2
10787: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10788: Using SrcDir value of /usr/pkg
1.68 rillig 10789: Registering depends:.
1.75 rillig 10790: <code class="prompt">#</code></pre>
10791: </div>
10792: </div>
10793: <div class="appendix" lang="en">
10794: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10795: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10796: <div class="toc">
10797: <p><b>Table of Contents</b></p>
10798: <dl>
10799: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10800: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10801: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10802: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10803: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
10804: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 rillig 10805: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10806: source packages</a></span></dt>
10807: </dl>
10808: </div>
10809: <p>As in other big projects, the directory layout of pkgsrc
10810: is quite complex for newbies. This chapter explains where you
10811: find things on the FTP server. The base directory on
1.89 rillig 10812: <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>.
10813: On other servers it may be different, but inside this directory,
10814: everything should look the same, no matter on which server you
10815: are. This directory contains some subdirectories, which are
10816: explained below.</p>
1.76 rillig 10817: <div class="sect1" lang="en">
10818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10819: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
10820: <p>For those who only want to manage binary packages on
10821: systems other than NetBSD, we provide the package management
10822: tools in a separate, small tar file.</p>
10823: </div>
10824: <div class="sect1" lang="en">
10825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10826: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10827: <p>The directory <code class="filename">distfiles</code> contains lots
10828: of archive files from all pkgsrc packages, which are mirrored
10829: here. The subdirectories are called after their package names
10830: and are used when the distributed files have names that don't
10831: explicitly contain a version number or are otherwise too generic
10832: (for example <code class="filename">release.tar.gz</code>).</p>
10833: </div>
10834: <div class="sect1" lang="en">
10835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10836: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10837: <p>This directory is currently not in use.</p>
10838: </div>
10839: <div class="sect1" lang="en">
10840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10841: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10842: <p>This directory contains things that individual pkgsrc
10843: developers find worth publishing.</p>
10844: </div>
10845: <div class="sect1" lang="en">
10846: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10847: <a name="ftp-packages"></a>C.5. <code class="filename">packages*</code>: Binary packages</h2></div></div></div>
10848: <p>These directories contain binary packages. Those
10849: directories that have a branch name
10850: (200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>)
10851: contain packages from that particular branch. The directory
10852: <code class="filename">packages</code> contains binary packages from
10853: pkgsrc-current. (However, this does not necessarily mean that
10854: the packages are still current anymore.)</p>
10855: <p>Below the <code class="filename">packages*</code> directories are
10856: directories that distinguish the packages by operating system
10857: and version, the next directory level specifies the hardware
10858: architecture.</p>
10859: <p>In each of the platform-specific directories, there is a
10860: whole binary packages collection. It has a directory called
10861: <code class="filename">All</code> which contains all binary packages.
10862: Besides that, there are various category directories that
10863: contain symbolic links to the real binary packages.</p>
10864: </div>
10865: <div class="sect1" lang="en">
10866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10867: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
1.93 rillig 10868: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10869: source packages</h2></div></div></div>
10870: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
10871: that is the files that define how to create binary packages from
10872: source archives.</p>
10873: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10874: snapshot of the CVS repository, which is updated regularly. The
10875: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10876: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10877: <p>In the directories for the quarterly branches, there is an
10878: additional file called
10879: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10880: which contains the state of pkgsrc when it was branched.</p>
10881: </div>
1.75 rillig 10882: </div>
10883: <div class="appendix" lang="en">
10884: <div class="titlepage"><div><div><h2 class="title">
10885: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
10886: <div class="toc">
10887: <p><b>Table of Contents</b></p>
10888: <dl>
1.79 rillig 10889: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10890: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10891: </dl>
10892: </div>
1.79 rillig 10893: <p>This section contains information on editing the pkgsrc
10894: guide itself.</p>
1.75 rillig 10895: <div class="sect1" lang="en">
10896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10897: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10898: <p>The pkgsrc guide's source code is stored in
10899: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10900: are created from it:</p>
10901: <div class="itemizedlist"><ul type="disc">
10902: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10903: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10904: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/</a></p></li>
10905: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</a>:
10906: The PDF version of the pkgsrc guide.</p></li>
10907: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</a>:
10908: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10909: </ul></div>
10910: </div>
10911: <div class="sect1" lang="en">
10912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10913: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10914: <p>The procedure to edit the pkgsrc guide is:</p>
10915: <div class="procedure"><ol type="1">
10916: <li><p>Make sure you have the packages needed to
1.83 wiz 10917: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 10918: 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
10919: 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 10920: PostScript and PDF versions. You will need both packages
10921: installed, to make sure documentation is consistent across all
10922: formats.</p></li>
10923: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
10924: right directory. All further steps will take place
10925: here.</p></li>
10926: <li><p>Edit the XML file(s) in
10927: <code class="filename">files/</code>.</p></li>
10928: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
10929: guide for valid XML and to build the final output files. If you
10930: get any errors at this stage, you can just edit the files, as
10931: there are only symbolic links in the working directory, pointing
10932: to the files in <code class="filename">files/</code>.</p></li>
10933: <li><p><span><strong class="command">(cd files && cvs
10934: commit)</strong></span></p></li>
10935: <li><p>Run <span><strong class="command">bmake clean && bmake</strong></span> to
10936: regenerate the output files with the proper RCS
10937: Ids.</p></li>
1.91 rillig 10938: <li>
10939: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
10940: commit the files in both <code class="filename">pkgsrc/doc</code> and
10941: <code class="filename">htdocs</code>.</p>
10942: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10943: <h3 class="title">Note</h3>
10944: <p>If you have added, removed or renamed some chapters,
1.83 wiz 10945: you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
10946: <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91 rillig 10947: directory.</p>
10948: </div>
10949: </li>
1.79 rillig 10950: </ol></div>
1.75 rillig 10951: </div>
10952: </div>
10953: </div></body>
1.1 grant 10954: </html>
CVSweb <webmaster@jp.NetBSD.org>