Annotation of pkgsrc/doc/pkgsrc.html, revision 1.93
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
6: <link rel="stylesheet" href="/NetBSD.css" type="text/css">
7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
21: <div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
27: <div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
33: <div><p class="copyright">Copyright © 1994-2006 The NetBSD Foundation, Inc</p></div>
1.92 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.24 2006/11/11 05:39:09 rillig Exp $</p></div>
1.76 rillig 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
48: <dl>
49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
70: </dl></dd>
71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
72: <dd><dl>
73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
75: </dl></dd>
76: </dl></dd>
77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
78: <dd><dl>
1.82 rillig 79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
82: <dd><dl>
83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 90: </dl></dd>
91: </dl></dd>
92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
93: <dd><dl>
94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 104: </dl></dd>
105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
106: <dd><dl>
107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
110: </dl></dd>
111: </dl></dd>
112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
113: <dd><dl>
114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 116: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 117: <dd><dl>
1.89 rillig 118: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
119: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
120: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 121: </dl></dd>
1.78 rillig 122: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
123: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 124: </dl></dd>
125: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
126: <dd><dl>
127: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
128: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
129: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
130: <dd><dl>
131: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
132: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
133: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
134: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
135: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
136: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
137: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
138: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
139: </dl></dd>
140: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
142: </dl></dd>
1.90 rillig 143: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
1.75 rillig 144: <dd><dl>
1.91 rillig 145: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90 rillig 146: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
147: </dl></dd>
148: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
149: <dd><dl>
150: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
151: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
152: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
153: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
154: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
155: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
156: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
157: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
158: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
159: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
160: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 161: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
164: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
165: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
166: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
167: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 169: </dl></dd>
170: </dl></dd>
171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
172: <dd><dl>
1.90 rillig 173: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 174: <dd><dl>
175: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
176: <dd><dl>
177: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
178: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
179: </dl></dd>
180: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
181: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
182: </dl></dd>
1.90 rillig 183: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 184: <dd><dl>
1.90 rillig 185: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
186: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
187: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
188: <dd><dl>
1.93 ! rillig 189: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
! 190: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
! 191: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
! 192: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
! 193: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 194: </dl></dd>
195: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
196: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
197: <dd><dl>
198: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
199: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
200: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
201: </dl></dd>
202: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
203: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
204: </dl></dd>
205: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
206: <dd><dl>
207: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
208: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
209: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
210: <dd><dl>
211: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
212: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
213: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
214: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
215: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
216: </dl></dd>
217: </dl></dd>
218: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
219: <dd><dl>
220: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
221: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
222: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
223: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
224: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
225: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
226: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
227: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
228: </dl></dd>
229: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
230: <dd><dl>
231: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
232: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
233: <dd><dl>
234: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
235: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
236: </dl></dd>
237: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
238: <dd><dl>
239: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
240: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
241: </dl></dd>
242: </dl></dd>
243: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
244: <dd><dl>
245: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
246: <dd><dl>
247: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
248: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
249: </dl></dd>
250: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
251: <dd><dl>
252: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
253: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
254: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
255: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
256: </dl></dd>
257: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
258: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
259: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
260: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
261: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
262: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
263: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
264: </dl></dd>
265: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
266: <dd><dl>
267: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
268: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
269: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
270: </dl></dd>
271: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
272: <dd><dl>
273: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
274: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
275: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
276: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
277: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
278: <dd><dl>
279: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
280: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
281: </dl></dd>
282: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
283: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
284: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
285: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
286: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
287: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
288: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
289: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
293: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
294: </dl></dd>
295: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
296: <dd><dl>
297: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
298: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
299: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
300: </dl></dd>
301: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
302: <dd><dl>
303: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
304: <dd><dl>
305: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
306: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
307: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
308: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
309: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
310: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
311: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
312: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
313: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
314: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
315: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
316: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
317: </dl></dd>
318: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
319: <dd><dl>
320: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
321: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
322: </dl></dd>
323: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
324: <dd><dl>
325: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
326: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
327: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
328: </dl></dd>
329: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
330: <dd><dl>
331: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
332: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
333: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
334: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
335: </dl></dd>
336: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
337: <dd><dl>
338: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
339: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
340: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
341: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
342: </dl></dd>
343: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
344: <dd><dl>
345: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
346: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
347: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
348: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
349: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
350: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
351: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
352: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
353: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
354: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
355: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
356: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
357: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
358: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
359: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
360: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
361: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 362: emulation</a></span></dt>
1.90 rillig 363: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
364: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77 rillig 365: </dl></dd>
1.90 rillig 366: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 367: </dl></dd>
1.90 rillig 368: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
369: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 370: <dd><dl>
1.90 rillig 371: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
372: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
373: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
374: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
375: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
376: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
377: </dl></dd>
378: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
379: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
380: <dd><dl>
381: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
382: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
383: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
384: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 385: </dl></dd>
1.75 rillig 386: </dl></dd>
387: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
388: <dd><dl>
1.90 rillig 389: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 390: <dd><dl>
1.90 rillig 391: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
392: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
393: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 394: <dd><dl>
1.90 rillig 395: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
396: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 397: </dl></dd>
1.90 rillig 398: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
399: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 400: <dd><dl>
1.90 rillig 401: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
402: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 403: </dl></dd>
1.90 rillig 404: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 405: <dd><dl>
1.90 rillig 406: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
407: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 408: </dl></dd>
409: </dl></dd>
1.90 rillig 410: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 411: <dd><dl>
1.90 rillig 412: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
413: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
414: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 415: <dd><dl>
1.90 rillig 416: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
417: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 418: </dl></dd>
419: </dl></dd>
1.90 rillig 420: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 421: <dd><dl>
1.90 rillig 422: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
423: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 424: </dl></dd>
425: </dl></dd>
426: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
427: <dd><dl>
428: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
429: <dd><dl>
430: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
431: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
432: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
433: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
434: </dl></dd>
435: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
436: </dl></dd>
437: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
438: <dd><dl>
439: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
440: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
441: </dl></dd>
1.76 rillig 442: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
443: <dd><dl>
444: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
445: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
446: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
447: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
448: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
449: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 ! rillig 450: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 451: source packages</a></span></dt>
452: </dl></dd>
1.75 rillig 453: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
454: <dd><dl>
1.79 rillig 455: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 456: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
457: </dl></dd>
458: </dl>
459: </div>
1.82 rillig 460: <div class="list-of-tables">
461: <p><b>List of Tables</b></p>
462: <dl>
463: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
464: </dt>
465: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
466: </dt>
1.90 rillig 467: <dt>10.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 468: </dt>
1.90 rillig 469: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 470: </dt>
1.82 rillig 471: </dl>
472: </div>
1.75 rillig 473: <div class="chapter" lang="en">
474: <div class="titlepage"><div><div><h2 class="title">
475: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
476: <div class="toc">
477: <p><b>Table of Contents</b></p>
478: <dl>
479: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 480: <dd><dl>
481: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
482: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
483: </dl></dd>
1.75 rillig 484: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
485: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 486: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 487: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
488: </dl>
489: </div>
490: <div class="sect1" lang="en">
491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
492: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 493: <p>There is a lot of software freely available for Unix-based
494: systems, which is usually available in form of the source code. Before
495: such software can be used, it needs to be configured to the local
496: system, compiled and installed, and this is exactly what The NetBSD
497: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
498: to handle binary packages, so that not every user has to build the
499: packages for himself, which is a time-costly task.</p>
1.75 rillig 500: <p>pkgsrc currently contains several thousand packages,
501: including:</p>
502: <div class="itemizedlist"><ul type="disc">
1.91 rillig 503: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.75 rillig 504: web server</p></li>
1.91 rillig 505: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75 rillig 506: web browser</p></li>
1.91 rillig 507: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75 rillig 508: Desktop Environment</p></li>
1.91 rillig 509: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.75 rillig 510: Desktop Environment</p></li>
511: </ul></div>
512: <p>...just to name a few.</p>
513: <p>pkgsrc has built-in support for handling varying dependencies,
514: such as pthreads and X11, and extended features such as IPv6 support on
515: a range of platforms.</p>
1.82 rillig 516: <div class="sect2" lang="en">
517: <div class="titlepage"><div><div><h3 class="title">
518: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
519: <p>
520: pkgsrc provides the following key features:
521: </p>
522: <div class="itemizedlist"><ul type="disc">
523: <li><p>Easy building of software from source as well as the creation
524: and installation of binary packages. The source and latest
525: patches are retrieved from a master or mirror download site, checksum
526: verified, then built on your system. Support for binary-only
527: distributions is available for both native platforms and NetBSD
528: emulated platforms.</p></li>
529: <li><p>All packages are installed in a consistent directory tree,
530: including binaries, libraries, man pages and other
531: documentation.</p></li>
532: <li><p>Package dependencies, including when performing package updates,
533: are handled automatically. The configuration files of various
534: packages are handled automatically during updates, so local changes
535: are preserved.</p></li>
536: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
537: consists of highly portable code. This allows the greatest speed of
538: development when porting to new a platform. This portability also
539: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
540: platforms</em></span>.</p></li>
541: <li><p>The installation prefix, acceptable software licenses,
542: international encryption requirements and build-time options for a
543: large number of packages are all set in a simple, central
544: configuration file.</p></li>
545: <li><p>The entire source (not including the distribution files) is
546: freely available under a BSD license, so you may extend and adapt
547: pkgsrc to your needs. Support for local packages and patches is
548: available right out of the box, so you can configure it specifically
549: for your environment.</p></li>
550: </ul></div>
1.91 rillig 551: <p>The following principles are basic to pkgsrc:</p>
552: <div class="itemizedlist"><ul type="disc">
553: <li><p>“<span class="quote">It should only work if it's right.</span>”
554: — That means, if a package contains bugs, it's better to find
555: them and to complain about them rather than to just install the package
556: and hope that it works. There are numerous checks in pkgsrc that try to
557: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
558: of shell scripts), and post-installation checks (installed files,
559: references to shared libraries, script interpreters).</p></li>
560: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
561: — Like NetBSD has been ported to many hardware architectures,
562: pkgsrc has been ported to many operating systems. Care is taken that
563: packages behave the same on all platforms.</p></li>
564: </ul></div>
1.82 rillig 565: </div>
566: <div class="sect2" lang="en">
567: <div class="titlepage"><div><div><h3 class="title">
568: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
569: <p>pkgsrc consists of both a source distribution and a binary
570: distribution for these operating systems. After retrieving the required
571: source or binaries, you can be up and running with pkgsrc in just
572: minutes!</p>
1.75 rillig 573: <p>pkgsrc was derived from FreeBSD's ports system, and
574: initially developed for NetBSD only. Since then, pkgsrc has
575: grown a lot, and now supports the following platforms:</p>
1.82 rillig 576: <div class="table">
577: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 578: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 579: <colgroup>
580: <col>
581: <col>
582: </colgroup>
583: <thead><tr>
584: <th>Platform</th>
585: <th>Date Support Added</th>
586: </tr></thead>
587: <tbody>
588: <tr>
589: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
590: <td align="center">Aug 1997</td>
591: </tr>
592: <tr>
593: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
594: <td align="center">Mar 1999</td>
595: </tr>
596: <tr>
597: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
598: <td align="center">Jun 1999</td>
599: </tr>
600: <tr>
601: <td>
602: <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
603: (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
604: </td>
605: <td align="center">Oct 2001</td>
606: </tr>
607: <tr>
608: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
609: <td align="center">Nov 2002</td>
610: </tr>
611: <tr>
612: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
613: <td align="center">Nov 2002</td>
614: </tr>
615: <tr>
616: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
617: <td align="center">Dec 2002</td>
618: </tr>
619: <tr>
620: <td>BSD/OS</td>
621: <td align="center">Dec 2003</td>
622: </tr>
623: <tr>
624: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
625: <td align="center">Dec 2003</td>
626: </tr>
627: <tr>
628: <td>
629: <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
630: (Microsoft Windows Services for Unix)
631: </td>
632: <td align="center">Mar 2004</td>
633: </tr>
634: <tr>
635: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
636: <td align="center">Oct 2004</td>
637: </tr>
638: <tr>
639: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
640: <td align="center">Nov 2004</td>
641: </tr>
642: </tbody>
1.91 rillig 643: </table></div>
1.82 rillig 644: </div>
1.91 rillig 645: <br class="table-break">
1.82 rillig 646: </div>
1.75 rillig 647: </div>
648: <div class="sect1" lang="en">
649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
650: <a name="overview"></a>1.2. Overview</h2></div></div></div>
651: <p>This document is divided into three parts. The first,
652: <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
653: describes how one can use one of the packages in the Package
654: Collection, either by installing a precompiled binary package,
1.93 ! rillig 655: or by building one's own copy using the NetBSD package system.
1.75 rillig 656: The second part, <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
657: package so it can be easily built by other NetBSD users without
658: knowing about the package's building details. The third part,
659: <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
660: is intended for those who want to understand how pkgsrc is
661: implemented.</p>
662: <p>This document is available in various formats:
663: <span class="simplelist"><a href="index.html" target="_top">HTML</a>, <a href="pkgsrc.pdf" target="_top">PDF</a>, <a href="pkgsrc.ps" target="_top">PS</a>, <a href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
664: </div>
665: <div class="sect1" lang="en">
666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
667: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
668: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
669: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
670: terminology used within this document.</p>
671: <div class="variablelist"><dl>
672: <dt><span class="term">Package</span></dt>
673: <dd><p>A set of files and building instructions
674: that describe what's necessary
675: to build a certain piece of software using
676: pkgsrc. Packages are traditionally stored under
1.76 rillig 677: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 678: <dt><span class="term">The NetBSD package system</span></dt>
1.87 wiz 679: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
680: is part of the NetBSD operating system and can be bootstrapped
681: to run on non-NetBSD operating systems as well. It handles
682: building (compiling), installing, and removing of
683: packages.</p></dd>
1.75 rillig 684: <dt><span class="term">Distfile</span></dt>
685: <dd><p>This term describes the file or files that are
686: provided by the author of the piece of software to
687: distribute his work. All the changes necessary to build on
688: NetBSD are reflected in the corresponding package. Usually
689: the distfile is in the form of a compressed tar-archive,
690: but other types are possible, too. Distfiles are usually
691: stored below
1.76 rillig 692: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 693: <dt><span class="term">Port</span></dt>
694: <dd><p>This is the term used by FreeBSD and OpenBSD people
695: for what we call a package.
696: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
697: architecture.</p></dd>
698: <dt><span class="term">Precompiled/binary package</span></dt>
699: <dd>
700: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 701: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 702: file so it can be installed on machines of the same
703: machine architecture without the need to
704: recompile. Packages are usually generated in
1.76 rillig 705: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.75 rillig 706: an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
707: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
708: especially in the context of precompiled packages.</p>
709: </dd>
710: <dt><span class="term">Program</span></dt>
1.88 wiz 711: <dd><p>The piece of software to be installed which will be
712: constructed from all the files in the distfile by the
713: actions defined in the corresponding package.</p></dd>
1.75 rillig 714: </dl></div>
715: <div class="sect2" lang="en">
716: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 717: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75 rillig 718: <div class="variablelist"><dl>
719: <dt><span class="term">pkgsrc users</span></dt>
720: <dd>
721: <p>The
722: pkgsrc users are people who use the packages provided by pkgsrc.
723: Typically they are system administrators. The people using the
724: software that is inside the packages (maybe called “<span class="quote">end
725: users</span>”) are not covered by the pkgsrc guide.</p>
726: <p>There are two kinds of pkgsrc users: Some only want to
727: install pre-built binary packages. Others build the pkgsrc
728: packages from source, either for installing them directly or for
729: building binary packages themselves. For pkgsrc users <a href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
730: documentation.</p>
731: </dd>
732: <dt><span class="term">package maintainers</span></dt>
733: <dd><p>A
734: package maintainer creates packages as described in <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
735: <dt><span class="term">infrastructure developers</span></dt>
736: <dd><p>These people are involved in all those files
1.76 rillig 737: that live in the <code class="filename">mk/</code> directory and below.
1.75 rillig 738: Only these people should need to read through <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
739: too.</p></dd>
740: </dl></div>
741: </div>
742: </div>
743: <div class="sect1" lang="en">
744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
745: <a name="typography"></a>1.4. Typography</h2></div></div></div>
746: <p>When giving examples for commands, shell prompts are used to
747: show if the command should/can be issued as root, or if
748: “<span class="quote">normal</span>” user privileges are sufficient. We use a
749: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
750: shell prompt, assuming they use the C-shell or tcsh.</p>
751: </div>
752: </div>
753: <div class="part" lang="en">
754: <div class="titlepage"><div><div><h1 class="title">
755: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
756: <div class="toc">
757: <p><b>Table of Contents</b></p>
758: <dl>
759: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
760: <dd><dl>
761: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
762: <dd><dl>
763: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
764: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
765: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
766: </dl></dd>
767: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
768: <dd><dl>
769: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
770: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
771: </dl></dd>
772: </dl></dd>
773: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
774: <dd><dl>
1.82 rillig 775: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
776: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
777: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
778: <dd><dl>
779: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
780: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
781: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
782: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
783: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
784: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
785: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 786: </dl></dd>
787: </dl></dd>
788: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
789: <dd><dl>
790: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
791: <dd><dl>
792: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
793: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 794: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
795: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
796: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
797: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
798: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
799: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 800: </dl></dd>
801: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
802: <dd><dl>
803: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
804: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
805: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
806: </dl></dd>
807: </dl></dd>
808: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
809: <dd><dl>
810: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
811: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 812: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 813: <dd><dl>
1.89 rillig 814: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
815: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
816: <dt><span class="sect2"><a href="#conf.ldflags">5.3.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 817: </dl></dd>
1.78 rillig 818: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
819: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 820: </dl></dd>
821: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
822: <dd><dl>
823: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
824: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
825: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
826: <dd><dl>
827: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
828: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
829: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
830: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
831: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
832: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
833: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
834: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
835: </dl></dd>
836: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
837: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
838: </dl></dd>
1.90 rillig 839: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
840: <dd><dl>
1.91 rillig 841: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90 rillig 842: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
843: </dl></dd>
844: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
1.75 rillig 845: <dd><dl>
1.90 rillig 846: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
847: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
848: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
849: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
850: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
851: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
852: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
853: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
854: <dt><span class="sect1"><a href="#passive-ftp">8.9. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
855: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
856: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 857: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 858: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.12. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
859: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
860: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
861: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
862: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
863: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
864: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.18. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 865: </dl></dd>
866: </dl>
867: </div>
868: <div class="chapter" lang="en">
869: <div class="titlepage"><div><div><h2 class="title">
870: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
871: <div class="toc">
872: <p><b>Table of Contents</b></p>
873: <dl>
874: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
875: <dd><dl>
876: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
877: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
878: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
879: </dl></dd>
880: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
881: <dd><dl>
882: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
883: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
884: </dl></dd>
885: </dl>
886: </div>
1.91 rillig 887: <p>Before you download and extract the files, you need to decide
888: where you want to extract them. When using pkgsrc as root user, pkgsrc
889: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
890: free to install the sources and binary packages wherever you want in
891: your filesystem, provided that the pathname does not contain white-space
892: or other characters that are interpreted specially by the shell and some
893: other programs. A safe bet is to use only letters, digits, underscores
894: and dashes.</p>
1.75 rillig 895: <div class="sect1" lang="en">
896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
897: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
898: <p>Before you download any pkgsrc files, you should decide
899: whether you want the <span class="emphasis"><em>current</em></span> branch or the
900: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
901: quarterly basis from the current branch and only gets modified
902: for security updates. The names of the stable branches are built
903: from the year and the quarter, for example
1.93 ! rillig 904: <code class="literal">2006Q3</code>.</p>
1.75 rillig 905: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
906: want to download pkgsrc. You can get it as a tar file, via SUP,
907: or via CVS. All three ways are described here.</p>
908: <div class="sect2" lang="en">
909: <div class="titlepage"><div><div><h3 class="title">
910: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
911: <p>The primary download location for all pkgsrc files is
912: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
913: number of subdirectories for different purposes, which are
1.76 rillig 914: described in detail in <a href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.75 rillig 915: <p>The tar file for the current branch is in the directory
1.76 rillig 916: <code class="filename">current</code> and is called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75 rillig 917: It is autogenerated daily.</p>
1.93 ! rillig 918: <p>The tar file for the stable branch 2006Q3 is in the
! 919: directory <code class="filename">pkgsrc-2006Q3</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2006Q3/pkgsrc-2006Q3.tar.gz" target="_top"><code class="filename">pkgsrc-2006Q3.tar.gz</code></a>.</p>
1.75 rillig 920: <p>After downloading the tar file, change to the directory
921: where you want to have pkgsrc. This is usually
1.91 rillig 922: <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
923: pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
1.75 rillig 924: </div>
925: <div class="sect2" lang="en">
926: <div class="titlepage"><div><div><h3 class="title">
927: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
928: <p>As an alternative to the tar file, you can get pkgsrc via
929: the Software Update Protocol, SUP. To do so, make sure your
930: supfile has a line
1.1 grant 931:
1.75 rillig 932: </p>
933: <pre class="programlisting">
1.51 rillig 934: release=pkgsrc
1.1 grant 935: </pre>
1.75 rillig 936: <p>
1.1 grant 937:
1.75 rillig 938: in it, see the examples in
1.76 rillig 939: <code class="filename">/usr/share/examples/supfiles</code>, and that the
940: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.75 rillig 941: run <span><strong class="command">sup -v
942: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
943: </div>
944: <div class="sect2" lang="en">
945: <div class="titlepage"><div><div><h3 class="title">
946: <a name="getting-via-cvs"></a>2.1.3. Via CVS</h3></div></div></div>
947: <p>To get pkgsrc via CVS, make sure you have <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cvs</span>(1)</span></a>
948: installed. To do an initial (full) checkout of pkgsrc, you first
949: have to set some environment variables. For the C-Shell,
950: type:</p>
951: <pre class="screen">
952: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
953: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
954: </pre>
955: <p>Or, the same for the bourne shell:</p>
956: <pre class="screen">
957: <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
958: <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
959: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
960: </pre>
961: <p>Then, you change to the directory where you want to have
962: your copy of pkgsrc. In most cases this is
1.76 rillig 963: <code class="filename">/usr</code>. In that directory you run the
1.75 rillig 964: checkout command, which is <span><strong class="command">cvs -q checkout -P
965: pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1.93 ! rillig 966: checkout -rpkgsrc-2006Q3 -P pkgsrc</strong></span> for the stable
1.75 rillig 967: branch. This command will create a directory called
1.76 rillig 968: <code class="filename">pkgsrc</code> with all the pkgsrc files in
1.75 rillig 969: it.</p>
970: </div>
971: </div>
972: <div class="sect1" lang="en">
973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
974: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
975: <p>The preferred way to keep pkgsrc up-to-date is via CVS
976: (which also works if you have first installed it via a tar
977: file). It saves bandwidth and hard disk activity, compared to
978: downloading the tar file again.</p>
979: <div class="sect2" lang="en">
980: <div class="titlepage"><div><div><h3 class="title">
981: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
982: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
983: <h3 class="title">Warning</h3>
1.77 rillig 984: <p>When updating from a tar file, you first need to
985: completely remove the old pkgsrc directory. Otherwise those
986: files that have been removed from pkgsrc in the mean time will
987: not be removed on your local disk, resulting in inconsistencies.
988: When removing the old files, any changes that you have done to
989: the pkgsrc files will be lost after updating. Therefore updating
990: via CVS is strongly recommended.</p>
1.75 rillig 991: </div>
1.82 rillig 992: <p>Note that by default the distfiles and the binary packages
993: are saved in the pkgsrc tree, so don't forget to rescue them
994: before updating. You can also configure pkgsrc to use other than
995: the default directories by setting the
996: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
997: variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 998: <p>To update pkgsrc from a tar file, download the tar file as
999: explained above. Then, make sure that you have not made any
1000: changes to the files in the pkgsrc directory. Remove the pkgsrc
1001: directory and extract the new tar file. Done.</p>
1002: </div>
1003: <div class="sect2" lang="en">
1004: <div class="titlepage"><div><div><h3 class="title">
1005: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1006: <p>To update pkgsrc via CVS, make sure the environment
1007: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1008: change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1.77 rillig 1009: -dP</strong></span>.</p>
1.75 rillig 1010: <div class="sect3" lang="en">
1011: <div class="titlepage"><div><div><h4 class="title">
1012: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1013: <p>When updating pkgsrc, the CVS program keeps track of the
1014: branch you selected. But if you, for whatever reason, want to
1015: switch from the stable branch to the current one, you can do it
1016: by adding the option “<span class="quote">-A</span>” after the
1017: “<span class="quote">update</span>” keyword. To switch from the current branch
1018: back to the stable branch, add the
1.93 ! rillig 1019: “<span class="quote">-rpkgsrc-2006Q3</span>” option.</p>
1.75 rillig 1020: </div>
1021: <div class="sect3" lang="en">
1022: <div class="titlepage"><div><div><h4 class="title">
1023: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1024: <p>When you update pkgsrc, the CVS program will only touch
1025: those files that are registered in the CVS repository. That
1026: means that any packages that you created on your own will stay
1027: unmodified. If you change files that are managed by CVS, later
1028: updates will try to merge your changes with those that have been
1029: done by others. See the CVS manual, chapter
1030: “<span class="quote">update</span>” for details.</p>
1031: </div>
1032: </div>
1033: </div>
1034: </div>
1035: <div class="chapter" lang="en">
1036: <div class="titlepage"><div><div><h2 class="title">
1037: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1038: <div class="toc">
1039: <p><b>Table of Contents</b></p>
1040: <dl>
1.82 rillig 1041: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1042: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1043: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1044: <dd><dl>
1045: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1046: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1047: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1048: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1049: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1050: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1051: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1052: </dl></dd>
1053: </dl>
1054: </div>
1055: <div class="sect1" lang="en">
1056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1057: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1058: <p>
1059: We provide a bootstrap kit in both source and binary form for other
1060: platforms than NetBSD, consisting of the pkg administration tools and other
1061: tools required to use pkgsrc and build packages.
1062: </p>
1063: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1064: <h3 class="title">Note</h3>
1065: <p>
1066: Older binary snapshots are available in the
1067: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
1068: directory on ftp.NetBSD.org.</p>
1069: </div>
1070: <div class="table">
1071: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1.91 rillig 1072: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1.82 rillig 1073: <colgroup>
1074: <col>
1075: <col>
1076: <col>
1077: <col>
1078: </colgroup>
1079: <thead><tr>
1080: <th>Platform</th>
1081: <th>Latest snapshot</th>
1082: <th>Binary kit</th>
1083: <th>Binary packages</th>
1084: </tr></thead>
1085: <tbody>
1086: <tr>
1087: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
1088: <td class="date">20021209</td>
1089: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-5.5-powerpc-20021209.tar.gz" target="_top">binary kit</a></td>
1090: <td class="binary-pkgs-url"> </td>
1091: </tr>
1092: <tr>
1093: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
1094: <td class="date">20030623</td>
1095: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-6.6-powerpc-20030623.tar.gz" target="_top">binary kit</a></td>
1096: <td class="binary-pkgs-url"> </td>
1097: </tr>
1098: <tr>
1099: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
1100: <td class="date">20041219</td>
1101: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.6.0-powerpc-20041219.tar.gz" target="_top">binary kit</a></td>
1102: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
1103: </tr>
1104: <tr>
1105: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
1106: <td class="date">20050320</td>
1107: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.8.0-powerpc-20050320.tar.gz" target="_top">binary kit</a></td>
1108: <td class="binary-pkgs-url"> </td>
1109: </tr>
1110: <tr>
1111: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
1112: <td class="date">20050625</td>
1113: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-8.1.0-powerpc-20050625.tar.gz" target="_top">binary kit</a></td>
1114: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-8.1/powerpc/current/" target="_top">binary packages</a></td>
1115: </tr>
1116: <tr>
1117: <td class="osname">Debian GNU Linux/i386</td>
1118: <td class="date">20031023</td>
1119: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-debian-i386-20031023.tar.gz" target="_top">binary kit</a></td>
1120: <td class="binary-pkgs-url"> </td>
1121: </tr>
1122: <tr>
1123: <td class="osname">Fedora Core 2 Linux/i386</td>
1124: <td class="date">20050618</td>
1125: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.10-i386-fc2-20050618.tar.gz" target="_top">binary kit</a></td>
1126: <td class="binary-pkgs-url"> </td>
1127: </tr>
1128: <tr>
1129: <td class="osname">Fedora Core 4 Linux/i386</td>
1130: <td class="date">20060105</td>
1131: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.11-i386-fc4-20060105.tar.gz" target="_top">binary kit</a></td>
1132: <td class="binary-pkgs-url"> </td>
1133: </tr>
1134: <tr>
1135: <td class="osname">FreeBSD 3.5/i386</td>
1136: <td class="date">20030411</td>
1137: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-3.5-STABLE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1138: <td class="binary-pkgs-url"> </td>
1139: </tr>
1140: <tr>
1141: <td class="osname">FreeBSD 4.7/i386</td>
1142: <td class="date">20021211</td>
1143: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-4.7-RELEASE-i386-20021211.tar.gz" target="_top">binary kit</a></td>
1144: <td class="binary-pkgs-url"> </td>
1145: </tr>
1146: <tr>
1147: <td class="osname">FreeBSD 5.0/i386</td>
1148: <td class="date">20030411</td>
1149: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.0-RELEASE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1150: <td class="binary-pkgs-url"> </td>
1151: </tr>
1152: <tr>
1153: <td class="osname">FreeBSD 5.1/i386</td>
1154: <td class="date">20030630</td>
1155: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.1-RELEASE-i386-20030630.tar.gz" target="_top">binary kit</a></td>
1156: <td class="binary-pkgs-url"> </td>
1157: </tr>
1158: <tr>
1159: <td class="osname">FreeBSD 5.2.1/i386</td>
1160: <td class="date">20040227</td>
1161: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.2.1-RELEASE-i386-20040227.tar.gz" target="_top">binary kit</a></td>
1162: <td class="binary-pkgs-url"> </td>
1163: </tr>
1164: <tr>
1165: <td class="osname">FreeBSD 5.3/i386</td>
1166: <td class="date">20050119</td>
1167: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.3-RELEASE-i386-20050119.tar" target="_top">binary kit</a></td>
1168: <td class="binary-pkgs-url"> </td>
1169: </tr>
1170: <tr>
1171: <td class="osname">Interix 3.5</td>
1.93 ! rillig 1172: <td class="date">20061106</td>
! 1173: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Interix-3.5-i386-20061106.tar.gz" target="_top">binary kit</a></td>
! 1174: <td class="binary-pkgs-url"> </td>
1.82 rillig 1175: </tr>
1176: <tr>
1177: <td class="osname">IRIX 6.5 n32-bit ABI</td>
1178: <td class="date">20040911</td>
1179: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX-6.5-mips-20040911.tar.gz" target="_top">binary kit</a></td>
1180: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
1181: </tr>
1182: <tr>
1183: <td class="osname">IRIX 6.5 64-bit ABI</td>
1184: <td class="date">20040912</td>
1185: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX64-6.5-mips-20040912.tar.gz" target="_top">binary kit</a></td>
1186: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
1187: </tr>
1188: <tr>
1189: <td class="osname">OpenBSD 3.2/i386</td>
1190: <td class="date">20030420</td>
1191: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.2-i386-20030420.tar.gz" target="_top">binary kit</a></td>
1192: <td class="binary-pkgs-url"> </td>
1193: </tr>
1194: <tr>
1195: <td class="osname">OpenBSD 3.3/i386</td>
1196: <td class="date">20030503</td>
1197: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.3-i386-20030503.tar.gz" target="_top">binary kit</a></td>
1198: <td class="binary-pkgs-url"> </td>
1199: </tr>
1200: <tr>
1201: <td class="osname">OpenBSD 3.5/i386</td>
1.93 ! rillig 1202: <td class="date">20040703</td>
1.82 rillig 1203: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.5-i386-20040703.tar.gz" target="_top">binary kit</a></td>
1204: <td class="binary-pkgs-url"> </td>
1205: </tr>
1206: <tr>
1207: <td class="osname">Slackware Linux 8.1/i386</td>
1208: <td class="date">20030417</td>
1209: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.18-slackware-20030417.tar.gz" target="_top">binary kit</a></td>
1210: <td class="binary-pkgs-url"> </td>
1211: </tr>
1212: <tr>
1213: <td class="osname">Slackware Linux 9/i386</td>
1.93 ! rillig 1214: <td class="date">20040703</td>
1.82 rillig 1215: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-i386-slackware9-20040703.tar.gz" target="_top">binary kit</a></td>
1216: <td class="binary-pkgs-url"> </td>
1217: </tr>
1218: <tr>
1219: <td class="osname">Solaris 8/sparc</td>
1220: <td class="date">20050220</td>
1221: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-sparc-20050220.tar.gz" target="_top">binary kit</a></td>
1222: <td class="binary-pkgs-url"> </td>
1223: </tr>
1224: <tr>
1225: <td class="osname">Solaris 8/i386</td>
1226: <td class="date">20050220</td>
1227: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-i386-20050220.tar.gz" target="_top">binary kit</a></td>
1228: <td class="binary-pkgs-url"> </td>
1229: </tr>
1230: <tr>
1231: <td class="osname">Solaris 9/sparc</td>
1.93 ! rillig 1232: <td class="date">20060713</td>
! 1233: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-sparc-pkgsrc-2006Q2.tar.gz" target="_top">binary kit</a></td>
! 1234: <td class="binary-pkgs-url"> </td>
1.82 rillig 1235: </tr>
1236: <tr>
1237: <td class="osname">Solaris 9/i386</td>
1238: <td class="date">20030411</td>
1239: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1240: <td class="binary-pkgs-url"> </td>
1241: </tr>
1242: </tbody>
1.91 rillig 1243: </table></div>
1.82 rillig 1244: </div>
1.91 rillig 1245: <br class="table-break"><p>
1.82 rillig 1246: Simply download the binary kit for your platform, and extract it into
1247: <code class="filename">/</code> e.g.
1248: </p>
1249: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
1250: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
1251: | tar -xpf -</code></strong></pre>
1252: <p>
1253: Of course, as with any binary distributions, you should verify the
1254: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
1255: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
1256: file and inspect the contents before extracting it.
1257: </p>
1258: </div>
1259: <div class="sect1" lang="en">
1260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1261: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1262: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1263: <pre class="screen">
1264: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1265: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1266: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1267: </pre>
1.75 rillig 1268: <p>See <a href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.87 wiz 1269: pkgsrc before bootstrapping. The given
1270: <span><strong class="command">bootstrap</strong></span> command will use the defaults of
1271: <code class="filename">/usr/pkg</code> for the
1272: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1273: and <code class="filename">/var/db/pkg</code> for the package database
1274: directory where pkgsrc will do its internal bookkeeping.
1275: However, these can also be set using command-line
1276: arguments.</p>
1.75 rillig 1277: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1.87 wiz 1278: available for supported platforms. An up-to-date list of these can be
1279: found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
1280: Note that this only works for privileged builds that install
1281: into <code class="filename">/usr/pkg</code>.</p>
1.75 rillig 1282: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1283: <h3 class="title">Note</h3>
1284: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1.87 wiz 1285: Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
1286: For examples in this guide, use <span><strong class="command">bmake</strong></span>
1287: instead of “<span class="quote">make</span>”.</p>
1.75 rillig 1288: </div>
1289: </div>
1290: <div class="sect1" lang="en">
1291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1292: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1293: <p>Here are some platform-specific notes you should be aware of.</p>
1294: <div class="sect2" lang="en">
1295: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1296: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85 jmmv 1297: <p>Darwin 5.x and up are supported. There are two methods of using
1.82 rillig 1298: pkgsrc on Mac OS X, by using a <a href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1.89 rillig 1299: image</a>, or a <a href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75 rillig 1300: partition</a>.</p>
1301: <p>Before you start, you will need to download and install the Mac OS X Developer
1.87 wiz 1302: Tools from Apple's Developer Connection. See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1303: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1304: from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1305: if you intend to build packages that use the X11 Window System.</p>
1.89 rillig 1306: <p>If you already have a UFS or HFSX partition, or have a spare partition
1307: that you can format as UFS or HFSX, it is recommended to use that instead of
1.87 wiz 1308: the disk image. It'll be somewhat faster and will mount automatically
1309: at boot time, where you must manually mount a disk image.</p>
1.75 rillig 1310: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1311: <h3 class="title">Note</h3>
1.85 jmmv 1312: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89 rillig 1313: requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
1.75 rillig 1314: </div>
1315: <div class="sect3" lang="en">
1316: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1317: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75 rillig 1318: <p>Create the disk image:</p>
1319: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.85 jmmv 1320: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 512</code></strong> # megabytes - season to taste
1321: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75 rillig 1322: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85 jmmv 1323: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1324: <h3 class="title">Note</h3>
1.89 rillig 1325: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid. In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page. In the case of HFSX, it will disable journalling.</p>
1.85 jmmv 1326: </div>
1.89 rillig 1327: <p>Allow suid:</p>
1328: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.75 rillig 1329: </div>
1330: <div class="sect3" lang="en">
1331: <div class="titlepage"><div><div><h4 class="title">
1.89 rillig 1332: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76 rillig 1333: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87 wiz 1334: system, normally HFS+. It is possible to use the default
1335: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1336: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89 rillig 1337: or HFSX file system. Obviously, another symlink is required if you want to
1.87 wiz 1338: place the package database directory outside the
1339: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75 rillig 1340: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1341: <p>If you created your partitions at the time of installing Mac OS X
1.89 rillig 1342: and formatted the target partition as UFS or HFSX, it should automatically
1.87 wiz 1343: mount on <code class="filename">/Volumes/<volume name></code> when the
1.89 rillig 1344: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87 wiz 1345: to ensure that the partition map correctly reflects
1.89 rillig 1346: “<span class="quote">Apple_UFS</span>” or “<span class="quote">Apple_HFSX</span>” and not “<span class="quote">Apple_HFS</span>”.</p>
1.75 rillig 1347: <p>The problem is that none of the disk tools will let you touch a
1.87 wiz 1348: disk that is booted from. You can unmount the partition, but even if
1349: you newfs it, the partition type will be incorrect and the
1350: automounter won't mount it. It can be mounted manually, but it won't
1351: appear in Finder.</p>
1.75 rillig 1352: <p>You'll need to boot off of the OS X Installation (User) CD. When
1.87 wiz 1353: the Installation program starts, go up to the menu and select Disk
1354: Utility. Now, you will be able to select the partition you want
1.89 rillig 1355: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1356: installer which will reboot your machine. The new UFS or HFSX file system
1.87 wiz 1357: will appear in Finder.</p>
1.75 rillig 1358: <p>Be aware that the permissions on the new file system will be writable
1.87 wiz 1359: by root only.</p>
1.75 rillig 1360: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87 wiz 1361: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75 rillig 1362: </div>
1363: </div>
1364: <div class="sect2" lang="en">
1365: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1366: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1367: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1368: other versions may work.</p>
1.75 rillig 1369: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1370: with the FreeBSD userland tools. There are several steps:</p>
1.75 rillig 1371: <div class="orderedlist"><ol type="1">
1372: <li><p>FreeBSD stores its ports pkg database in
1.87 wiz 1373: <code class="filename">/var/db/pkg</code>. It is therefore
1374: recommended that you choose a different location (e.g.
1375: <code class="filename">/usr/pkgdb</code>) by
1376: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1377: <li>
1378: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1379: good idea to move them out of the way to avoid confusion, e.g.</p>
1380: <pre class="screen">
1381: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1382: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1383: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1384: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1385: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1386: </pre>
1.75 rillig 1387: </li>
1.76 rillig 1388: <li><p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87 wiz 1389: <code class="filename">/etc/mk.conf.example</code> file
1390: when you use the bootstrap script.</p></li>
1.75 rillig 1391: </ol></div>
1392: </div>
1393: <div class="sect2" lang="en">
1394: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1395: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1396: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1397: providing a Unix-like environment with a tighter kernel integration than
1398: available with Cygwin. It is part of the Windows Services for Unix
1399: package, available for free for any licensed copy of Windows 2000, XP
1400: (not including XP Home), or 2003. SFU can be downloaded from <a href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93 ! rillig 1401: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
! 1402: are not officially supported. (The main difference in 3.0/3.1 is lack
! 1403: of pthreads, but other parts of libc may also be lacking.)</p>
! 1404: <p>Services for Unix Applications (aka SUA) is an integrated component
! 1405: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
! 1406: Interix 5.x subsystem not been tested with pkgsrc.</p>
1.75 rillig 1407: <div class="sect3" lang="en">
1408: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1409: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1410: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1411: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75 rillig 1412: <div class="itemizedlist"><ul type="disc">
1413: <li><p>Utilities -> Base Utilities</p></li>
1414: <li><p>Interix GNU Components -> (all)</p></li>
1415: <li><p>Remote Connectivity</p></li>
1416: <li><p>Interix SDK</p></li>
1417: </ul></div>
1418: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1419: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1420: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1421: pkgsrc (or from a binary package).</p>
1.75 rillig 1422: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1423: not need to be installed, but Remote Connectivity itself should be
1424: installed in order to have a working inetd.</p>
1.75 rillig 1425: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1426: behavior for Interix programs, and whether to make pathnames default to
1427: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1428: enabled. (Without case-sensitivity, a large number of packages including
1429: perl will not build.)</p>
1.75 rillig 1430: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1431: works (via the Data Execution Prevention feature). In order to use
1432: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1433: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1434: must be installed. Hotfixes are available from Microsoft through a
1435: support contract; however, a NetBSD developer has made most Interix
1436: hotfixes available for personal use from <a href="http://www.duh.org/interix/hotfixes.php" target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
1.93 ! rillig 1437: <p>In addition to the hotfix noted above, it may be necessary to
! 1438: disable Data Execution Prevention entirely to make Interix functional.
! 1439: This may happen only with certain types of CPUs; the cause is not fully
! 1440: understood at this time. If gcc or other applications still segfault
! 1441: repeatedly after installing one of the hotfixes note above, the
! 1442: following option can be added to the appropriate "boot.ini" line on the
! 1443: Windows boot drive: /NoExecute=AlwaysOff
! 1444: (WARNING, this will disable DEP completely, which may be a security
! 1445: risk if applications are often run as a user in the Administrators
! 1446: group!)</p>
1.75 rillig 1447: </div>
1448: <div class="sect3" lang="en">
1449: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1450: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75 rillig 1451: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1452: with pkgsrc, note the following things.</p>
1.75 rillig 1453: <div class="itemizedlist"><ul type="disc">
1454: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1455: Windows Services for UNIX, then click Change. In the installer, choose
1456: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.75 rillig 1457: <li>
1458: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1459: change the following registry key:</p>
1.75 rillig 1460: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1461: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1462: </li>
1463: <li>
1464: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1465: following registry key:</p>
1.75 rillig 1466: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1467: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1468: </li>
1469: </ul></div>
1470: </div>
1471: <div class="sect3" lang="en">
1472: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1473: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1474: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1475: running "pkg_add") must be a member of the local Administrators
1476: group. Such a user must also be used to run the bootstrap. This is
1477: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1478: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1479: automatically complain if this is not the case. This ensures that
1480: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1481: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1482: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1483: NOT be used in conjunction with pkgsrc. If you choose to use them at
1484: the same time as the pkgsrc packages, ensure that you use the proper
1485: pkg_* tools for each type of binary package.</p>
1.75 rillig 1486: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1487: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1488: don't have a termcap/terminfo entry for it, but the following .termcap
1489: entry provides adequate emulation in most cases:</p>
1.75 rillig 1490: <pre class="programlisting">
1.87 wiz 1491: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1492: </pre>
1.75 rillig 1493: </div>
1494: <div class="sect3" lang="en">
1495: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1496: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1497: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1498: for a full Unix-like platform, it has some drawbacks that should
1499: be noted for those desiring to make the most of Interix.</p>
1.75 rillig 1500: <div class="itemizedlist"><ul type="disc">
1501: <li>
1502: <p><span class="strong"><strong>X11:</strong></span></p>
1503: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1504: and can run X11 based applications, but it does
1505: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1506: <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1507: <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1508: (available in a trimmed version for Interix from Interop Systems as the
1509: <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1510: and the free X11 server included with
1511: <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1512: </li>
1513: <li>
1514: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1515: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1516: Win32 applications, it does not currently support various X11
1517: protocol extensions for acceleration (such as MIT-SHM or DGA).
1518: Most interactive applications to a local X server will run
1519: reasonably fast, but full motion video and other graphics
1520: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1521: </li>
1522: <li>
1523: <p><span class="strong"><strong>Audio:</strong></span></p>
1524: <p>Interix has no native support for audio output. For audio
1.87 wiz 1525: support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
1526: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1527: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.87 wiz 1528: <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
1529: server component. To output audio via an Interix host, the
1.91 rillig 1530: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1.87 wiz 1531: must also be installed.</p>
1.75 rillig 1532: </li>
1533: <li>
1534: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1535: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1536: is not currently possible to access CD/DVD drives, USB devices,
1537: or SCSI devices through non-filesystem means. Among other things,
1538: this makes it impossible to use Interix directly for CD/DVD
1539: burning.</p>
1.75 rillig 1540: </li>
1541: <li>
1542: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1543: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1544: drives are also not directly accessible in Interix. However,
1545: support is in work to make tape drive access possible by using
1546: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1547: esound server).</p>
1.75 rillig 1548: </li>
1549: </ul></div>
1550: </div>
1551: <div class="sect3" lang="en">
1552: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1553: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1554: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1555: Windows system; any member of the local Administrators group will
1556: suffice. However, some packages currently assume that the user
1557: named "root" is the privileged user. To accommodate these, you
1558: may create such a user; make sure it is in the local group
1559: Administrators (or your language equivalent).</p>
1560: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
1561: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1562: time being, install packages as the local Administrator (or
1563: your language equivalent), or run the following command after
1564: installing a package to work around the issue:</p>
1.75 rillig 1565: <pre class="screen">
1.87 wiz 1566: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1567: </pre>
1.75 rillig 1568: </div>
1569: </div>
1570: <div class="sect2" lang="en">
1571: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1572: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1573: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1574: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1575: according to your preference. If you do not have a license for the MIPSpro
1576: compiler suite, you can download a gcc tardist file from <a href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75 rillig 1577: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87 wiz 1578: version of IRIX providing support for <a href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1579: etc.</p>
1.86 schwarz 1580: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1581: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1582: you start out using "abi=n32", that's what all your packages will be built
1583: with.</p>
1584: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1585: <code class="varname">CFLAGS</code> in your environment or the
1586: <code class="filename">/etc/mk.conf</code>. Particularly, make sure that you do not
1587: try to link n32 object files with lib64 or vice versa. Check your
1588: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1589: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1590: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1591: as it appears that IRIX linker occasionally runs into issues when trying to
1592: link over a network-mounted file system.</p>
1.75 rillig 1593: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1594: as imake(1), but you may want to set some options depending on your local
1595: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1596: course, your compiler's man pages for details.</p>
1.75 rillig 1597: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1598:
1.87 wiz 1599: </p>
1.75 rillig 1600: <pre class="programlisting">
1.87 wiz 1601: PKGSRC_COMPILER= mipspro
1602: </pre>
1.75 rillig 1603: <p>
1.1 grant 1604:
1.87 wiz 1605: in <code class="filename">/etc/mk.conf</code>. Otherwise, pkgsrc will assume you
1606: are using gcc and may end up passing invalid flags to the compiler. Note that
1607: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1608: default.</p>
1.75 rillig 1609: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 ! rillig 1610: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1611: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1612: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1613: '--preserve-path' flag.</p>
1.75 rillig 1614: </div>
1615: <div class="sect2" lang="en">
1616: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1617: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1618: <p>Some versions of Linux (for example Debian GNU/Linux) need
1619: either libtermcap or libcurses (libncurses). Installing the
1620: distributions libncurses-dev package (or equivalent) should fix
1621: the problem.</p>
1622: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1623: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1624: i386 have been tested.</p>
1.75 rillig 1625: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1626: directory:</p>
1.75 rillig 1627: <pre class="programlisting">
1.87 wiz 1628: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1629: ac_cv___attribute__=yes ./bootstrap
1630: </pre>
1.75 rillig 1631: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1632: <h3 class="title">Note</h3>
1633: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1634: </div>
1635: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1636: function, which icc does not support. #undef'ing __attribute__ has the
1637: unfortunate side-effect of breaking many of the Linux header files, which
1638: cannot be compiled properly without __attribute__. The test must be
1639: overridden so that __attribute__ is assumed supported by the
1640: compiler.</p>
1.75 rillig 1641: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.87 wiz 1642: in <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 1643: <pre class="programlisting">
1.87 wiz 1644: PKGSRC_COMPILER= icc
1645: </pre>
1.75 rillig 1646: <p>The default installation directory for icc is
1.87 wiz 1647: <code class="filename">/opt/intel_cc_80</code>, which
1648: is also the pkgsrc default. If you have installed it into a different
1649: directory, set <code class="varname">ICCBASE</code> in
1650: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 1651: <pre class="programlisting">
1.87 wiz 1652: ICCBASE= /opt/icc
1653: </pre>
1.75 rillig 1654: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1655: provided by icc, so binaries can be run on other systems which do not
1656: have the shared libraries installed.</p>
1657: <p>Libtool, however, extracts a list of libraries from the
1658: <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1659: records it, throwing away the -Bstatic and -Bdynamic options
1660: interspersed between the libraries. This means that
1661: libtool-linked C++ shared libraries will have a runtime
1662: dependency on the icc libraries until this is fixed in
1663: libtool.</p>
1.75 rillig 1664: </div>
1665: <div class="sect2" lang="en">
1666: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1667: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1668: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1669: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1670: with the OpenBSD userland tools. There are several steps:</p>
1.75 rillig 1671: <div class="orderedlist"><ol type="1">
1672: <li><p>OpenBSD stores its ports pkg database in
1.87 wiz 1673: <code class="filename">/var/db/pkg</code>. It is therefore
1674: recommended that you choose a different location (e.g.
1675: <code class="filename">/usr/pkgdb</code>) by
1676: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1677: <li>
1678: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1679: good idea to move them out of the way to avoid confusion, e.g.</p>
1680: <pre class="screen">
1681: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1682: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1683: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1684: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1685: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1686: </pre>
1.75 rillig 1687: </li>
1688: <li>
1.76 rillig 1689: <p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87 wiz 1690: <code class="filename">/etc/mk.conf.example</code> file
1691: when you use the bootstrap script. OpenBSD's make program uses
1692: <code class="filename">/etc/mk.conf</code>
1693: as well. You can work around this by enclosing all the pkgsrc-specific parts
1694: of the file with:</p>
1695: <pre class="programlisting">
1696: .ifdef BSD_PKG_MK
1697: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1698: .else
1699: # OpenBSD stuff
1700: .endif
1701: </pre>
1.75 rillig 1702: </li>
1703: </ol></div>
1704: </div>
1705: <div class="sect2" lang="en">
1706: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1707: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1708: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1709: You will need a working C compiler. Both gcc 2.95.3 and
1710: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1711: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1712: process and to build packages.</p>
1.75 rillig 1713: <div class="itemizedlist"><ul type="disc">
1714: <li><p>SUNWsprot</p></li>
1715: <li><p>SUNWarc</p></li>
1716: <li><p>SUNWbtool</p></li>
1717: <li><p>SUNWtoo</p></li>
1718: <li><p>SUNWlibm</p></li>
1719: </ul></div>
1.78 rillig 1720: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1721: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1722: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1723: your $prefix are in your <code class="varname">PATH</code>. This includes
1724: <code class="filename">/usr/ccs/{bin,lib}</code>
1725: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75 rillig 1726: <div class="sect3" lang="en">
1727: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1728: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1729: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1730: for building all packages.</p>
1.75 rillig 1731: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1732: then either build gcc from
1.91 rillig 1733: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
1.87 wiz 1734: package, then remove gcc used during bootstrapping.</p>
1.93 ! rillig 1735: <p>Binary packages of gcc can be found through <a href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75 rillig 1736: </div>
1737: <div class="sect3" lang="en">
1738: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1739: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1740: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1741: 5.0)</p>
1.75 rillig 1742: <div class="itemizedlist"><ul type="disc">
1743: <li><p>SPROcc
1.87 wiz 1744: - Sun WorkShop Compiler C 5.0</p></li>
1.75 rillig 1745: <li><p>SPROcpl
1.87 wiz 1746: - Sun WorkShop Compiler C++ 5.0</p></li>
1.75 rillig 1747: <li><p>SPROild
1.87 wiz 1748: - Sun WorkShop Incremental Linker</p></li>
1.75 rillig 1749: <li><p>SPROlang
1.87 wiz 1750: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1751: </ul></div>
1752: <p>You should set <code class="varname">CC</code>, <code class="varname">CXX</code> and
1.87 wiz 1753: optionally, <code class="varname">CPP</code> in <code class="filename">/etc/mk.conf</code>,
1754: e.g.:</p>
1.75 rillig 1755: <pre class="programlisting">
1.87 wiz 1756: CC= cc
1757: CXX= CC
1758: CPP= /usr/ccs/lib/cpp
1759: </pre>
1.75 rillig 1760: </div>
1761: <div class="sect3" lang="en">
1762: <div class="titlepage"><div><div><h4 class="title">
1.93 ! rillig 1763: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.75 rillig 1764: <p>Building 64-bit binaries is a little trickier. First, you
1765: need to bootstrap pkgsrc in 64-bit mode. One problem here is
1766: that while building one of the programs in the bootstrap kit
1.76 rillig 1767: (<code class="filename">bmake</code>), the <code class="varname">CFLAGS</code>
1.75 rillig 1768: variable is not honored, even if it is set in the environment.
1769: To work around this bug, you can create a simple shell script
1.76 rillig 1770: called <code class="filename">cc64</code> and put it somewhere in the
1.75 rillig 1771: <code class="varname">PATH</code>:</p>
1772: <pre class="programlisting">
1.87 wiz 1773: #! /bin/sh
1774: exec /opt/SUNWspro/bin/cc -xtarget=ultra -xarch=v9 ${1+"$@"}
1775: </pre>
1.75 rillig 1776: <p>Then, pass the definition for <code class="varname">CC</code> in the
1777: environment of the <span><strong class="command">bootstrap</strong></span> command:</p>
1778: <pre class="programlisting">
1.87 wiz 1779: <code class="prompt">$</code> <strong class="userinput"><code>cd bootstrap</code></strong>
1780: <code class="prompt">$</code> <strong class="userinput"><code>CC=cc64 ./bootstrap</code></strong>
1781: </pre>
1.75 rillig 1782: <p>After bootstrapping, there are two alternative ways,
1783: depending on whether you want to find bugs in packages or get
1784: your system ready quickly. If you just want a running system,
1.76 rillig 1785: add the following lines to your <code class="filename">mk.conf</code>
1.75 rillig 1786: file:</p>
1787: <pre class="programlisting">
1.87 wiz 1788: CC= cc64
1789: CXX= CC64
1790: PKGSRC_COMPILER= sunpro
1791: </pre>
1.75 rillig 1792: <p>This way, all calls to the compiler will be intercepted by
1793: the above wrapper and therefore get the necessary ABI options
1794: automatically. (Don't forget to create the shell script
1.76 rillig 1795: <code class="filename">CC64</code>, too.)</p>
1.75 rillig 1796: <p>To find packages that ignore the user-specified
1797: <code class="varname">CFLAGS</code> and <code class="varname">CXXFLAGS</code>, add
1.76 rillig 1798: the following lines to your <code class="filename">mk.conf</code>
1.75 rillig 1799: file:</p>
1800: <pre class="programlisting">
1.87 wiz 1801: CC= cc
1802: CXX= CC
1803: PKGSRC_COMPILER= sunpro
1804: CFLAGS= -xtarget=ultra -xarch=v9
1805: CXXFLAGS= -xtarget=ultra -xarch=v9
1806: LDFLAGS= -xtarget=ultra -xarch=v9
1807: </pre>
1.75 rillig 1808: <p>Packages that don't use the flags provided in the
1809: configuration file will try to build 32-bit binaries and fail
1810: during linking. Detecting this is useful to prevent bugs on
1811: other platforms where the error would not show up but pass
1812: silently.</p>
1813: </div>
1814: <div class="sect3" lang="en">
1815: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1816: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75 rillig 1817: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87 wiz 1818: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1819: The workaround is to use another shell for the configure
1.91 rillig 1820: 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 1821: to your <code class="filename">mk.conf</code>:</p>
1822: <pre class="programlisting">
1823: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1824: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1825: </pre>
1.91 rillig 1826: <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 1827: </div>
1828: </div>
1829: </div>
1830: </div>
1831: <div class="chapter" lang="en">
1832: <div class="titlepage"><div><div><h2 class="title">
1833: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1834: <div class="toc">
1835: <p><b>Table of Contents</b></p>
1836: <dl>
1837: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1838: <dd><dl>
1839: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1840: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1841: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1842: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1843: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1844: <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>
1845: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1846: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1847: </dl></dd>
1848: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1849: <dd><dl>
1850: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1851: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1852: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1853: </dl></dd>
1854: </dl>
1855: </div>
1856: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1857: is to only install the package tools and to use binary packages
1858: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1859: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1860: of pkgsrc, too. Then you are able to build your own packages,
1861: and you can still use binary packages from someone else.</p>
1.75 rillig 1862: <div class="sect1" lang="en">
1863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1864: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1865: <p>To use binary packages, you need some tools to manage
1.88 wiz 1866: them. On NetBSD, these tools are already installed. On all other
1867: operating systems, you need to install them first. For the
1868: following platforms, prebuilt versions of the package tools
1869: are available and can simply be downloaded and unpacked in the
1870: <code class="filename">/</code> directory:</p>
1.75 rillig 1871: <div class="informaltable">
1872: <a name="binary-bootstrap-kits"></a><table border="1">
1873: <colgroup>
1874: <col>
1875: <col>
1876: </colgroup>
1877: <thead><tr>
1878: <th>Platform</th>
1879: <th>URL</th>
1880: </tr></thead>
1881: <tbody>
1882: <tr>
1883: <td>Solaris 9</td>
1.76 rillig 1884: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1885: </tr>
1886: <tr>
1887: <td>Solaris 10</td>
1.76 rillig 1888: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1889: </tr>
1890: </tbody>
1891: </table>
1892: </div>
1.82 rillig 1893: <p>These pre-built package tools use
1.88 wiz 1894: <code class="filename">/usr/pkg</code> for the base directory, and
1895: <code class="filename">/var/db/pkg</code> for the database of installed
1896: packages. If you cannot use these directories for whatever
1897: reasons (maybe because you're not root), you have to build the
1898: 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 1899: <div class="sect2" lang="en">
1900: <div class="titlepage"><div><div><h3 class="title">
1901: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1902: <p>To install binary packages, you first need to know from
1.88 wiz 1903: where to get them. You can get them on CD-ROMs, DVDs, or via FTP
1904: or HTTP.</p>
1.81 rillig 1905: <p>The binary packages can be found at the following
1.88 wiz 1906: locations.</p>
1.75 rillig 1907: <div class="informaltable">
1908: <a name="binary-packages"></a><table border="1">
1909: <colgroup>
1910: <col>
1911: <col>
1912: </colgroup>
1913: <thead><tr>
1914: <th>Platform</th>
1915: <th>URL</th>
1916: </tr></thead>
1917: <tbody>
1918: <tr>
1.81 rillig 1919: <td>NetBSD</td>
1920: <td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
1921: </tr>
1922: <tr>
1.75 rillig 1923: <td>Solaris 9</td>
1.76 rillig 1924: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
1.75 rillig 1925: </tr>
1926: <tr>
1927: <td>Solaris 10</td>
1.76 rillig 1928: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/</code></td>
1.75 rillig 1929: </tr>
1930: </tbody>
1931: </table>
1932: </div>
1.81 rillig 1933: <p>Most of these directories contain binary packages for
1.88 wiz 1934: multiple platforms. Select the appropriate subdirectories,
1935: according to your machine architecture and operating system,
1936: until you find a directory called <code class="filename">All</code>. This
1937: directory contains all the binary packages. Further, there are
1938: subdirectories for categories that contain symbolic links that
1939: point to the actual binary package in
1940: <code class="filename">../All</code>. This directory layout is used for
1941: all package repositories, no matter if they are accessed via
1942: HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
1.75 rillig 1943: </div>
1944: <div class="sect2" lang="en">
1945: <div class="titlepage"><div><div><h3 class="title">
1946: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87 wiz 1947: <p>If you have the files on a CD-ROM or downloaded them to
1.88 wiz 1948: your hard disk, you can install them with the following command
1949: (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75 rillig 1950: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87 wiz 1951: <p>If you have FTP access and you don't want to download the
1.88 wiz 1952: packages via FTP prior to installation, you can do this
1953: automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.82 rillig 1954: <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 1955: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1956: package in question will be installed, too, assuming they are
1957: present where you install from.</p>
1.75 rillig 1958: <p>To save some typing, you can set the
1.88 wiz 1959: <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
1960: list of paths (including remote URLs); trailing slashes are not allowed.
1961: </p>
1.76 rillig 1962: <p>Additionally to the <code class="filename">All</code> directory
1.88 wiz 1963: there exists a <code class="filename">vulnerable</code> directory to
1964: which binary packages with known vulnerabilities are
1965: moved, since removing them could cause missing dependencies. To
1966: use these packages, add the <code class="filename">vulnerable</code>
1967: directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91 rillig 1968: <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 1969: especially after installing new packages, and verify that the
1970: vulnerabilities are acceptable for your configuration. An example
1971: <code class="varname">PKG_PATH</code> would be:
1972: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
1973: Please note that semicolon (';') is a shell meta-character, so
1974: you'll probably have to quote it.</p>
1.75 rillig 1975: <p>After you've installed packages, be sure to have
1.88 wiz 1976: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1977: <code class="varname">PATH</code> so you can actually start the just
1978: installed program.</p>
1.75 rillig 1979: </div>
1980: <div class="sect2" lang="en">
1981: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1982: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1983: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1984: installed from source code or from a binary package. The
1985: <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
1986: To delete a package, you can just run <span><strong class="command">pkg_delete
1987: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1988: name can be given with or without version number. Wildcards can
1989: also be used to deinstall a set of packages, for example
1990: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1991: so that the shell does not expand them before
1992: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1993: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1994: removes all the packages that require the package in question
1995: and then removes the package itself. For example:
1.82 rillig 1996:
1.88 wiz 1997: </p>
1.82 rillig 1998: <pre class="screen">
1.88 wiz 1999: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
2000: </pre>
1.82 rillig 2001: <p>
2002:
1.88 wiz 2003: will remove jpeg and all the packages that used it; this allows
2004: upgrading the jpeg package.</p>
1.82 rillig 2005: </div>
2006: <div class="sect2" lang="en">
2007: <div class="titlepage"><div><div><h3 class="title">
2008: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
2009: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88 wiz 2010: installed packages or binary package files.</p>
1.82 rillig 2011: </div>
2012: <div class="sect2" lang="en">
2013: <div class="titlepage"><div><div><h3 class="title">
2014: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
2015: <p>
1.88 wiz 2016: The NetBSD Security-Officer and Packages Groups maintain a list of
2017: known security vulnerabilities to packages which are (or have been)
2018: included in pkgsrc. The list is available from the NetBSD
2019: FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
2020: </p>
1.82 rillig 2021: <p>
1.93 ! rillig 2022: 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 2023: this list can be downloaded
2024: automatically, and a security audit of all packages installed on a system
2025: can take place.
2026: </p>
1.82 rillig 2027: <p>
1.93 ! rillig 2028: There are two components to
1.91 rillig 2029: <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 2030: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
2031: the list of vulnerabilities from the NetBSD FTP site. The second
2032: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
2033: installed packages are vulnerable. If a package is vulnerable, you
2034: will see output similar to the following:
2035: </p>
1.82 rillig 2036: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 2037: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 2038: <p>
1.91 rillig 2039: 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 2040: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
2041: file daily, and include a package audit in the daily security script.
2042: 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 2043: 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 2044: </p>
1.82 rillig 2045: </div>
2046: <div class="sect2" lang="en">
2047: <div class="titlepage"><div><div><h3 class="title">
2048: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
2049: <p>
1.93 ! rillig 2050: 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 2051: <span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
2052: argument to check if your packages are up-to-date, e.g.
2053: </p>
2054: <pre class="screen">
2055: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 2056: ...
1.88 wiz 2057: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
2058: </pre>
1.82 rillig 2059: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88 wiz 2060: package on your system and rebuild any dependencies.
2061: </p>
1.82 rillig 2062: </div>
2063: <div class="sect2" lang="en">
2064: <div class="titlepage"><div><div><h3 class="title">
2065: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
2066: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88 wiz 2067: administrative functions on the package system.</p>
1.82 rillig 2068: </div>
2069: <div class="sect2" lang="en">
2070: <div class="titlepage"><div><div><h3 class="title">
2071: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 2072: <p>Please pay very careful attention to the warnings
1.88 wiz 2073: 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
2074: inherent dangers of installing binary packages which you did
2075: not create yourself, and the security holes that can be
2076: introduced onto your system by indiscriminate adding of such
2077: files.</p>
1.75 rillig 2078: <p>The same warning of course applies to every package you
1.88 wiz 2079: install from source when you haven't completely read and
2080: understood the source code of the package, the compiler that
2081: is used to build the package and all the other tools that are
2082: involved.</p>
1.75 rillig 2083: </div>
2084: </div>
2085: <div class="sect1" lang="en">
2086: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2087: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 2088: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
2089: directory now contains a set of packages, organized into
2090: categories. You can browse the online index of packages, or run
2091: <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
2092: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 2093: 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 2094: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
2095: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
2096: should do so by setting <code class="varname">LOCALBASE</code> in
2097: <code class="filename">mk.conf</code>. You should not try to use multiple
2098: different <code class="varname">LOCALBASE</code> definitions on the same
2099: system (inside a chroot is an exception). </p>
2100: <p>The rest of this chapter assumes that the package is already
2101: 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
2102: instructions how to create your own packages.</p>
1.75 rillig 2103: <div class="sect2" lang="en">
2104: <div class="titlepage"><div><div><h3 class="title">
2105: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 2106: <p>To build packages from source, you need a working C
1.88 wiz 2107: compiler. On NetBSD, you need to install the
2108: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
2109: sets. If you want to build X11-related packages, the
2110: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
2111: sets are required, too.</p>
1.75 rillig 2112: </div>
2113: <div class="sect2" lang="en">
2114: <div class="titlepage"><div><div><h3 class="title">
2115: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
2116: <p>The first step for building a package is downloading the
1.88 wiz 2117: distfiles (i.e. the unmodified source). If they have not yet been
2118: downloaded, pkgsrc will fetch them automatically.</p>
2119: <p>If you have all files that you need in the
2120: <code class="filename">distfiles</code> directory,
2121: you don't need to connect. If the distfiles are on CD-ROM, you can
2122: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
2123: </p>
1.82 rillig 2124: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
2125: <p>
1.88 wiz 2126: to your <code class="filename">mk.conf</code>.</p>
1.91 rillig 2127: <p>By default a list of distribution sites will be randomly
2128: intermixed to prevent huge load on servers which holding popular
2129: packages (for example, SourceForge.net mirrors). Thus, every
2130: time when you need to fetch yet another distfile all the mirrors
2131: will be tried in new (random) order. You can turn this feature
2132: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
2133: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 2134: <p>You can overwrite some of the major distribution sites to
2135: fit to sites that are close to your own. By setting one or two
2136: variables you can modify the order in which the master sites are
2137: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
2138: delimited list of domain suffixes.
2139: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
2140: contains a whitespace delimited list of regular expressions. It
2141: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
2142: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
2143: some examples. This may save some of your bandwidth and
2144: time.</p>
1.75 rillig 2145: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 2146: if you want to keep the settings, by editing the
2147: <code class="filename">/etc/mk.conf</code> file,
2148: and adding the definitions there.</p>
1.82 rillig 2149: <p>
1.88 wiz 2150: If a package depends on many other packages (such as
1.93 ! rillig 2151: <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 2152: alternate between periods of
2153: downloading source, and compiling. To ensure you have all the source
2154: downloaded initially you can run the command:
2155: </p>
1.82 rillig 2156: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
2157: <p>
1.88 wiz 2158: which will output and run a set of shell commands to fetch the
2159: necessary files into the <code class="filename">distfiles</code> directory. You can
2160: also choose to download the files manually.
2161: </p>
1.75 rillig 2162: </div>
2163: <div class="sect2" lang="en">
2164: <div class="titlepage"><div><div><h3 class="title">
2165: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 2166: <p>
1.88 wiz 2167: Once the software has downloaded, any patches will be applied, then it
2168: will be compiled for you. This may take some time depending on your
2169: computer, and how many other packages the software depends on and their
2170: compile time.
2171: </p>
1.75 rillig 2172: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2173: <h3 class="title">Note</h3>
2174: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88 wiz 2175: use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
2176: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 2177: </div>
1.87 wiz 2178: <p>For example, type</p>
1.88 wiz 2179: <pre class="screen">
2180: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2181: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2182: </pre>
1.75 rillig 2183: <p>at the shell prompt to build the various components of the
1.88 wiz 2184: package.</p>
1.82 rillig 2185: <p>The next stage is to actually install the newly compiled
1.88 wiz 2186: program onto your system. Do this by entering:
1.82 rillig 2187:
1.88 wiz 2188: </p>
1.82 rillig 2189: <pre class="screen">
1.88 wiz 2190: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2191: </pre>
1.82 rillig 2192: <p>
2193:
1.88 wiz 2194: while you are still in the directory for whatever package you
2195: are installing.</p>
1.82 rillig 2196: <p>Installing the package on your system may require you to
1.88 wiz 2197: be root. However, pkgsrc has a
2198: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2199: to only become root for the actual installation step.</p>
1.82 rillig 2200: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2201: You can now enter:
1.82 rillig 2202:
1.88 wiz 2203: </p>
1.82 rillig 2204: <pre class="screen">
1.88 wiz 2205: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2206: </pre>
1.82 rillig 2207: <p>
2208:
1.88 wiz 2209: to remove the compiled files in the work directory, as you shouldn't need
2210: them any more. If other packages were also added to your system
2211: (dependencies) to allow your program to compile, you can tidy these up
2212: also with the command:</p>
1.82 rillig 2213: <pre class="screen">
1.88 wiz 2214: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2215: </pre>
1.75 rillig 2216: <p>Taking the figlet utility as an example, we can install it on our
1.88 wiz 2217: system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
2218: <p>The program is installed under the default root of the
2219: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2220: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2221: variable in your environment, and it will use that value as the
2222: root of your packages tree. So, to use
2223: <code class="filename">/usr/local</code>, set
2224: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2225: Please note that you should use a directory which is dedicated to
2226: packages and not shared with other programs (i.e., do not try and
2227: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2228: to add any of your own files or directories (such as
2229: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2230: <code class="filename">pkgsrc/</code>) below the
2231: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2232: conflicts between programs and other files installed by the
2233: package system and whatever else may have been installed
2234: there.</p>
2235: <p>Some packages look in <code class="filename">/etc/mk.conf</code> to
2236: alter some configuration options at build time. Have a look at
2237: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2238: of what will be set there by default. Environment variables such
2239: as <code class="varname">LOCALBASE</code> can be set in
2240: <code class="filename">/etc/mk.conf</code> to save having to remember to
2241: set them each time you want to use pkgsrc.</p>
2242: <p>Occasionally, people want to “<span class="quote">look under the
2243: covers</span>” to see what is going on when a package is building
2244: or being installed. This may be for debugging purposes, or out of
2245: simple curiosity. A number of utility values have been added to
2246: help with this.</p>
1.75 rillig 2247: <div class="orderedlist"><ol type="1">
2248: <li>
1.88 wiz 2249: <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
2250: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2251: information will be displayed. For example,</p>
1.75 rillig 2252: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2253: <p>will show all the commands that are invoked, up to and
2254: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 2255: </li>
2256: <li>
1.88 wiz 2257: <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>
2258: definition, then the <code class="varname">VARNAME</code> definition
2259: should be used, in conjunction with the show-var
2260: 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>
2261: variable <code class="varname">LOCALBASE</code>:</p>
2262: <pre class="screen">
2263: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2264: /usr/pkg
2265: <code class="prompt">%</code>
1.88 wiz 2266: </pre>
1.75 rillig 2267: </li>
2268: </ol></div>
2269: <p>If you want to install a binary package that you've either
1.88 wiz 2270: created yourself (see next section), that you put into
2271: pkgsrc/packages manually or that is located on a remote FTP
2272: server, you can use the "bin-install" target. This target will
2273: 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>,
2274: else do a <span><strong class="command">make package</strong></span>. The list of remote FTP
2275: sites searched is kept in the variable
2276: <code class="varname">BINPKG_SITES</code>, which defaults to
2277: 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>
2278: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2279: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2280: details.</p>
2281: <p>A final word of warning: If you set up a system that has a
2282: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2283: set that before any packages are installed, as you cannot use
2284: several directories for the same purpose. Doing so will result in
2285: pkgsrc not being able to properly detect your installed packages,
2286: and fail miserably. Note also that precompiled binary packages are
2287: usually built with the default <code class="varname">LOCALBASE</code> of
2288: <code class="filename">/usr/pkg</code>, and that you should
2289: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2290: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2291: </div>
2292: </div>
2293: </div>
2294: <div class="chapter" lang="en">
2295: <div class="titlepage"><div><div><h2 class="title">
2296: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2297: <div class="toc">
2298: <p><b>Table of Contents</b></p>
2299: <dl>
2300: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2301: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 2302: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2303: <dd><dl>
1.89 rillig 2304: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
2305: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2306: <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 2307: </dl></dd>
1.78 rillig 2308: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
2309: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 2310: </dl>
2311: </div>
1.89 rillig 2312: <p>The whole pkgsrc system is configured in a single file, usually
2313: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2314: that file depends on the installation. On NetBSD, when you use
2315: <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
2316: <code class="filename">/etc/</code>. In all other cases the default location is
2317: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2318: bootstrap program to install the binary packages.</p>
2319: <p>During the bootstrap, an example configuration file is created. To
2320: use that, you have to create the directory
2321: <code class="filename">${PREFIX}/etc</code> and copy the example file
2322: there.</p>
2323: <p>The format of the configuration file is that of the usual
2324: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2325: is done by setting variables in this file. Note that you can define all
2326: kinds of variables, and no special error checking (for example for
2327: spelling mistakes) takes place, so you have to try it out to see if it
2328: works.</p>
1.75 rillig 2329: <div class="sect1" lang="en">
2330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2331: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2332: <p>In this section, you can find some variables that apply to all
1.89 rillig 2333: pkgsrc packages. A complete list of the variables that can be
2334: configured by the user is available in
2335: <code class="filename">mk/defaults/mk.conf</code>, together with some
2336: comments that describe each variable's intent.</p>
1.75 rillig 2337: <div class="itemizedlist"><ul type="disc">
2338: <li><p><code class="varname">LOCALBASE</code>: Where
2339: packages will be installed. The default is
1.76 rillig 2340: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2341: with different <code class="varname">LOCALBASE</code>s!</p></li>
2342: <li><p><code class="varname">CROSSBASE</code>: Where
2343: “<span class="quote">cross</span>” category packages will be
2344: installed. The default is
1.76 rillig 2345: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2346: <li><p><code class="varname">X11BASE</code>: Where
2347: X11 is installed on the system. The default is
1.76 rillig 2348: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2349: <li><p><code class="varname">DISTDIR</code>: Where to store the
2350: downloaded copies of the original source distributions used
2351: for building pkgsrc packages. The default is
1.76 rillig 2352: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.75 rillig 2353: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2354: If set, override the packages'
2355: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2356: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2357: Backup location(s) for distribution files and patch files
2358: if not found locally or in
1.76 rillig 2359: <code class="filename">${MASTER_SITES}</code> or
2360: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2361: The defaults are
1.76 rillig 2362: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2363: and
1.76 rillig 2364: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2365: <li><p><code class="varname">BINPKG_SITES</code>:
1.93 ! rillig 2366: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
! 2367: <em class="replaceable"><code>arch</code></em> are replaced with OS
! 2368: release (“<span class="quote">2.0</span>”, etc.) and architecture
! 2369: (“<span class="quote">mipsel</span>”, etc.).</p></li>
1.82 rillig 2370: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2371: List of acceptable licenses. Whenever you try to build a package
2372: whose license is not in this list, you will get an error message
2373: that includes instructions on how to change this variable.</p></li>
1.75 rillig 2374: </ul></div>
2375: </div>
2376: <div class="sect1" lang="en">
2377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2378: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2379: <p>XXX
2380: </p>
2381: <div class="itemizedlist"><ul type="disc">
2382: <li><p><code class="varname">PACKAGES</code>: The top level
2383: directory for the binary packages. The default is
1.76 rillig 2384: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2385: <li><p><code class="varname">WRKOBJDIR</code>:
2386: The top level directory where, if defined, the separate
2387: working directories will get created, and symbolically
1.76 rillig 2388: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2389: This is useful for building packages on several
1.76 rillig 2390: architectures, then <code class="filename">${PKGSRCDIR}</code>
2391: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2392: is local to every architecture. (It should be noted that
2393: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.89 rillig 2394: — it is an internal definition which refers to the
1.75 rillig 2395: root of the pkgsrc tree. It is possible to have many
2396: pkgsrc tree instances.)</p></li>
2397: <li><p><code class="varname">LOCALPATCHES</code>:
2398: Directory for local patches that aren't part of pkgsrc.
1.90 rillig 2399: See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more
1.93 ! rillig 2400: information.</p></li>
1.75 rillig 2401: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.76 rillig 2402: the <code class="filename">mk.conf</code> file used by a package's
1.75 rillig 2403: BSD-style Makefile. If this is not set,
2404: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2405: <code class="filename">/dev/null</code> to avoid picking up
2406: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2407: <li><p><code class="varname">DEPENDS_TARGET</code>:
2408: By default, dependencies are only installed, and no binary
2409: package is created for them. You can set this variable to
2410: <code class="literal">package</code> to automatically create binary
2411: packages after installing dependencies.</p></li>
1.75 rillig 2412: </ul></div>
2413: </div>
2414: <div class="sect1" lang="en">
2415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78 rillig 2416: <a name="conf.compiler"></a>5.3. Selecting and configuring the compiler</h2></div></div></div>
2417: <div class="sect2" lang="en">
2418: <div class="titlepage"><div><div><h3 class="title">
1.89 rillig 2419: <a name="selecting-the-compiler"></a>5.3.1. Selecting the compiler</h3></div></div></div>
2420: <p>By default, pkgsrc will use GCC to build packages. This may be
2421: overridden by setting the following variables in /etc/mk.conf:</p>
2422: <div class="variablelist"><dl>
2423: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2424: <dd>
2425: <p>This is a list of values specifying the chain of
2426: compilers to invoke when building packages. Valid values
2427: are:</p>
2428: <div class="itemizedlist"><ul type="disc">
2429: <li><p><code class="varname">distcc</code>:
2430: distributed C/C++ (chainable)</p></li>
2431: <li><p><code class="varname">ccache</code>:
2432: compiler cache (chainable)</p></li>
2433: <li><p><code class="varname">gcc</code>:
2434: GNU C/C++ Compiler</p></li>
2435: <li><p><code class="varname">mipspro</code>:
2436: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2437: <li><p><code class="varname">mipspro</code>:
2438: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2439: <li><p><code class="varname">sunpro</code>:
2440: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2441: </ul></div>
2442: <p>The default is
2443: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2444: <code class="varname">ccache</code> and/or
2445: <code class="varname">distcc</code> with an appropriate
2446: <code class="varname">PKGSRC_COMPILER</code> setting,
2447: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
2448: variable should always be
2449: terminated with a value for a real compiler.</p>
2450: </dd>
2451: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2452: <dd><p>This specifies the minimum version of GCC to use
2453: when building packages. If the system GCC doesn't
2454: satisfy this requirement, then pkgsrc will build and
2455: install one of the GCC packages to use instead.</p></dd>
2456: </dl></div>
2457: </div>
2458: <div class="sect2" lang="en">
2459: <div class="titlepage"><div><div><h3 class="title">
2460: <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 2461: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2462: please make sure to use the <code class="literal">+=</code> operator
2463: instead of the <code class="literal">=</code> operator:</p>
2464: <pre class="programlisting">
2465: CFLAGS+= -your -flags
2466: </pre>
2467: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2468: “<span class="quote">+</span>”) may lead to problems with packages that need
2469: to add their own flags. Also, you may want to take a look at
1.91 rillig 2470: 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 2471: you're interested in optimization for the current CPU.</p>
2472: </div>
1.88 wiz 2473: <div class="sect2" lang="en">
2474: <div class="titlepage"><div><div><h3 class="title">
1.89 rillig 2475: <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 2476: <p>If you want to pass flags to the linker, both in the configure
2477: step and the build step, you can do this in two ways. Either set
2478: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2479: between the two is that <code class="varname">LIBS</code> will be appended to
2480: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2481: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2482: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2483: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2484: <code class="varname">CFLAGS</code>, if you do not wish to override these
2485: settings, use the <code class="literal">+=</code> operator:</p>
2486: <pre class="programlisting">
2487: LDFLAGS+= -your -linkerflags
2488: </pre>
2489: </div>
1.78 rillig 2490: </div>
2491: <div class="sect1" lang="en">
2492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2493: <a name="developer-advanced-settings"></a>5.4. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2494: <p>XXX
2495: </p>
2496: <div class="itemizedlist"><ul type="disc">
2497: <li>
2498: <p><code class="varname">PKG_DEVELOPER</code>:
2499: Run some sanity checks that package developers want:
2500: </p>
2501: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2502: <li><p>make sure patches apply with zero
2503: fuzz</p></li>
2504: <li><p>run check-shlibs to see that all
2505: binaries will find their shared libs.</p></li>
1.75 rillig 2506: </ul></div>
2507: <p>
1.87 wiz 2508: </p>
1.75 rillig 2509: </li>
1.88 wiz 2510: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2511: of debugging output which is displayed whilst making and
2512: installing the package. The default value for this is 0,
2513: which will not display the commands as they are executed
2514: (normal, default, quiet operation); the value 1 will display
2515: all shell commands before their invocation, and the value 2
2516: will display both the shell commands before their invocation,
2517: and their actual execution progress with <span><strong class="command">set
2518: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2519: </ul></div>
2520: <p>
2521: </p>
2522: </div>
2523: <div class="sect1" lang="en">
2524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78 rillig 2525: <a name="selecting-build-options"></a>5.5. Selecting Build Options</h2></div></div></div>
1.88 wiz 2526: <p>Some packages have build time options, usually to select
2527: between different dependencies, enable optional support for big
2528: dependencies or enable experimental features.</p>
1.75 rillig 2529: <p>To see which options, if any, a package supports, and which
1.88 wiz 2530: options are mutually exclusive, run <span><strong class="command">make
2531: show-options</strong></span>, for example:</p>
1.75 rillig 2532: <pre class="programlisting">
2533: The following options are supported by this package:
2534: ssl Enable SSL support.
2535: Exactly one of the following gecko options is required:
2536: firefox Use firefox as gecko rendering engine.
2537: mozilla Use mozilla as gecko rendering engine.
2538: At most one of the following database options may be selected:
2539: mysql Enable support for MySQL database.
2540: pgsql Enable support for PostgreSQL database.
1.1 grant 2541:
1.75 rillig 2542: These options are enabled by default: firefox
2543: These options are currently enabled: mozilla ssl
1.1 grant 2544: </pre>
1.75 rillig 2545: <p>The following variables can be defined in
1.88 wiz 2546: <code class="filename">/etc/mk.conf</code> to select which options to
2547: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2548: which can be used to select or disable options for all packages
2549: that support them, and
2550: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2551: which can be used to select or disable options specifically for
2552: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2553: these variables are selected, options preceded by “<span class="quote">-</span>”
2554: are disabled. A few examples:</p>
1.75 rillig 2555: <pre class="screen">
2556: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" /etc/mk.conf</strong></span>
2557: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2558: PKG_OPTIONS.kdebase= debug -sasl
2559: PKG_OPTIONS.apache= suexec </pre>
1.88 wiz 2560: <p>The following settings are consulted in the order given, and
2561: the last setting that selects or disables an option is
2562: used:</p>
1.75 rillig 2563: <div class="orderedlist"><ol type="1">
2564: <li><p>the default options as suggested by the package
1.88 wiz 2565: maintainer</p></li>
1.75 rillig 2566: <li><p>the options implied by the settings of legacy
1.88 wiz 2567: variables (see below)</p></li>
1.75 rillig 2568: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2569: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2570: </ol></div>
2571: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2572: selected is used, all others are automatically disabled. If an
2573: option of the group is explicitly disabled, the previously
2574: selected option, if any, is used. It is an error if no option
2575: from a required group of options is selected, and building the
2576: package will fail.</p>
2577: <p>Before the options framework was introduced, build options
2578: were selected by setting a variable (often named
2579: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
2580: <code class="filename">/etc/mk.conf</code> for each option. To ease
2581: transition to the options framework for the user, these legacy
2582: variables are converted to the appropriate options setting
2583: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2584: automatically. A warning is issued to prompt the user to update
2585: <code class="filename">/etc/mk.conf</code> to use the options framework
2586: directly. Support for the legacy variables will be removed
2587: eventually.</p>
1.75 rillig 2588: </div>
2589: </div>
2590: <div class="chapter" lang="en">
2591: <div class="titlepage"><div><div><h2 class="title">
2592: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2593: <div class="toc">
2594: <p><b>Table of Contents</b></p>
2595: <dl>
2596: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2597: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2598: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
2599: <dd><dl>
2600: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
2601: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
2602: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
2603: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
2604: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
2605: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2606: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
2607: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
2608: </dl></dd>
2609: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2610: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
2611: </dl>
2612: </div>
2613: <div class="sect1" lang="en">
2614: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2615: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2616: <p>Once you have built and installed a package, you can create
2617: a <span class="emphasis"><em>binary package</em></span> which can be installed on
2618: 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
2619: the same package on a group of hosts and wasting CPU time. It also
2620: provides a simple means for others to install your package, should
2621: you distribute it.</p>
2622: <p>To create a binary package, change into the appropriate
2623: directory in pkgsrc, and run <span><strong class="command">make
2624: package</strong></span>:</p>
2625: <pre class="screen">
2626: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2627: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2628: </pre>
2629: <p>This will build and install your package (if not already done),
2630: and then build a binary package from what was installed. You can
2631: then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
2632: it. Binary packages are created by default in
2633: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2634: gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2635: 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 2636: <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 2637: such a binary package.</p>
1.75 rillig 2638: </div>
2639: <div class="sect1" lang="en">
2640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2641: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90 rillig 2642: <p>See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, “Other helpful targets”</a>.</p>
1.75 rillig 2643: </div>
2644: <div class="sect1" lang="en">
2645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2646: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
2647: <p>If you want to get a full set of precompiled binary
1.87 wiz 2648: packages, this section describes how to get them. Beware that
2649: the bulk build will remove all currently installed packages from
2650: your system!</p>
1.75 rillig 2651: <p>Having an FTP server configured either on the
1.87 wiz 2652: machine doing the bulk builds or on a nearby NFS server can help
2653: to make the packages available to other machines that can then
2654: 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
2655: more information. If you use a remote NFS server's storage, be
2656: sure to not actually compile on NFS storage, as this slows
2657: things down a lot.</p>
1.75 rillig 2658: <div class="sect2" lang="en">
2659: <div class="titlepage"><div><div><h3 class="title">
2660: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
2661: <div class="sect3" lang="en">
2662: <div class="titlepage"><div><div><h4 class="title">
1.93 ! rillig 2663: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code>
! 2664: </h4></div></div></div>
1.76 rillig 2665: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2666: configuration file for bulk builds. You can configure how your
2667: copy of pkgsrc is kept up to date, how the distfiles are
2668: downloaded, how the packages are built and how the report is
2669: generated. You can find an annotated example file in
2670: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2671: it, copy <code class="filename">build.conf-example</code> to
2672: <code class="filename">build.conf</code> and edit it, following the
2673: comments in that file.</p>
1.75 rillig 2674: </div>
2675: <div class="sect3" lang="en">
2676: <div class="titlepage"><div><div><h4 class="title">
2677: <a name="binary.mk.conf"></a>6.3.1.2. /etc/mk.conf</h4></div></div></div>
2678: <p>You may want to set variables in
1.87 wiz 2679: <code class="filename">/etc/mk.conf</code>.
2680: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2681: details of the default settings. You will want to ensure that
2682: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2683: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
2684: accepts <span class="emphasis"><em>all</em></span> licenses.</p>
2685: <pre class="programlisting">
2686: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2687: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2688: BSDSRCDIR= /usr/src
2689: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2690: OBJHOSTNAME?= yes # use work.`hostname`
2691: FAILOVER_FETCH= yes # insist on the correct checksum
2692: PKG_DEVELOPER?= yes
2693: _ACCEPTABLE= yes
2694: </pre>
1.75 rillig 2695: <p>Some options that are especially useful for bulk builds
2696: can be found at the top lines of the file
1.76 rillig 2697: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2698: options of these are briefly described here.</p>
2699: <div class="itemizedlist"><ul type="disc">
2700: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2701: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2702: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2703: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2704: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2705: to the directory where all log files are created. Otherwise the
2706: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2707: <li><p>Another important variable is
1.87 wiz 2708: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2709: should be always available while building other
2710: packages.</p></li>
1.75 rillig 2711: </ul></div>
2712: <p>Some other options are scattered in the pkgsrc
2713: infrastructure:</p>
2714: <div class="itemizedlist"><ul type="disc">
2715: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2716: should be set to <code class="literal">yes</code>. The purpose of the bulk
2717: builds is creating binary packages, no matter if they are
2718: vulnerable or not. When uploading the packages to a public
2719: server, the vulnerable packages will be put into a directory of
2720: their own. Leaving this variable unset would prevent the bulk
2721: build system from even trying to build them, so possible
2722: building errors would not show up.</p></li>
1.75 rillig 2723: <li><p><code class="varname">CHECK_FILES</code>
1.93 ! rillig 2724: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87 wiz 2725: “<span class="quote">yes</span>” to check that the installed set of files
2726: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2727: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93 ! rillig 2728: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87 wiz 2729: “<span class="quote">yes</span>” to check that the installed
2730: “<span class="quote">#!</span>”-scripts will find their
2731: interpreter.</p></li>
1.91 rillig 2732: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2733: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2734: package's self-test before installing it. Note that some
2735: packages make heavy use of “<span class="quote">good</span>” random
2736: numbers, so you need to assure that the machine on which you
2737: are doing the bulk builds is not completely idle. Otherwise
2738: some test programs will seem to hang, while they are just
2739: waiting for new random data to be
2740: available.</p></li>
1.75 rillig 2741: </ul></div>
2742: </div>
2743: <div class="sect3" lang="en">
2744: <div class="titlepage"><div><div><h4 class="title">
1.93 ! rillig 2745: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
! 2746: </h4></div></div></div>
1.75 rillig 2747: <p>It is possible to configure the bulk build to perform
1.87 wiz 2748: certain site-specific tasks at the end of the pre-build
2749: stage. If the file
2750: <code class="filename">pre-build.local</code> exists in
2751: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2752: (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
2753: stage. An example use of
2754: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2755: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2756: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2757: <p>to prevent the system from trying to build a particular package
1.87 wiz 2758: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2759: </div>
2760: </div>
2761: <div class="sect2" lang="en">
2762: <div class="titlepage"><div><div><h3 class="title">
2763: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2764: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2765: deleted at the start of bulk builds, make sure your login
2766: shell is placed somewhere else. Either drop it into
2767: <code class="filename">/usr/local/bin</code> (and adjust your login
2768: shell in the passwd file), or (re-)install it via
2769: <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
2770: you can login after a reboot (remember that your current
2771: process won't die if the package is removed, you just can't
2772: start any new instances of the shell any more). Also, if you
2773: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2774: version of ssh for some reason, be sure to install ssh before
2775: starting it from <code class="filename">rc.local</code>:</p>
2776: <pre class="programlisting">
2777: ( cd /usr/pkgsrc/security/ssh ; make bulk-install )
2778: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2779: /usr/pkg/etc/rc.d/sshd
2780: fi
2781: </pre>
1.75 rillig 2782: <p>Not doing so will result in you being not able to log in
1.87 wiz 2783: via ssh after the bulk build is finished or if the machine
2784: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2785: </div>
2786: <div class="sect2" lang="en">
2787: <div class="titlepage"><div><div><h3 class="title">
2788: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
2789: <p>Make sure you don't need any of the packages still
1.87 wiz 2790: installed.</p>
1.75 rillig 2791: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2792: <h3 class="title">Warning</h3>
2793: <p>During the bulk build, <span class="emphasis"><em>all packages will be
1.87 wiz 2794: removed!</em></span></p>
1.75 rillig 2795: </div>
2796: <p>Be sure to remove all other things that might
1.87 wiz 2797: interfere with builds, like some libs installed in
2798: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2799: <pre class="screen">
2800: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2801: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2802: </pre>
1.75 rillig 2803: <p>If for some reason your last build didn't complete (power
1.87 wiz 2804: failure, system panic, ...), you can continue it by
2805: running:</p>
1.75 rillig 2806: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2807: <p>At the end of the bulk build, you will get a summary via mail,
2808: and find build logs in the directory specified by
2809: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2810: file.</p>
1.75 rillig 2811: </div>
2812: <div class="sect2" lang="en">
2813: <div class="titlepage"><div><div><h3 class="title">
2814: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
2815: <p>The bulk builds consist of three steps:</p>
2816: <div class="variablelist"><dl>
2817: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2818: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2819: cleans out any broken distfiles, and removes all
2820: packages installed.</p></dd>
1.75 rillig 2821: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2822: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2823: an optimised order in which packages will be
2824: built. Packages that don't require other packages will
2825: be built first, and packages with many dependencies will
2826: be built later.</p></dd>
1.75 rillig 2827: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2828: <dd><p>Generates a report that's placed in the directory
2829: specified in the <code class="filename">build.conf</code> file
2830: named <code class="filename">broken.html</code>, a short version
2831: of that report will also be mailed to the build's
2832: admin.</p></dd>
1.75 rillig 2833: </dl></div>
1.87 wiz 2834: <p>During the build, a list of broken packages will be compiled
2835: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2836: <code class="filename">.../.broken.${MACHINE}</code> if
2837: <code class="varname">OBJMACHINE</code> is set), individual build logs
2838: of broken builds can be found in the package's
2839: directory. These files are used by the bulk-targets to mark
2840: broken builds to not waste time trying to rebuild them, and
2841: they can be used to debug these broken package builds
2842: later.</p>
1.75 rillig 2843: </div>
2844: <div class="sect2" lang="en">
2845: <div class="titlepage"><div><div><h3 class="title">
2846: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
2847: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2848: NetBSD 2.0/i386:</p>
1.75 rillig 2849: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2850: <li><p>10 GB - distfiles (NFS ok)</p></li>
2851: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2852: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2853: </ul></div>
2854: <p>Note that all pkgs will be de-installed as soon as they are
2855: turned into a binary package, and that sources are removed,
2856: so there is no excessively huge demand to disk
2857: space. Afterwards, if the package is needed again, it will
2858: 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
2859: there are no cycles wasted by recompiling.</p>
1.75 rillig 2860: </div>
2861: <div class="sect2" lang="en">
2862: <div class="titlepage"><div><div><h3 class="title">
2863: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2864: <p>If you don't want all the packages nuked from a machine
2865: (rendering it useless for anything but pkg compiling), there
2866: is the possibility of doing the package bulk build inside a
2867: chroot environment.</p>
2868: <p>The first step is to set up a chroot sandbox,
2869: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2870: using null mounts, or manually.</p>
2871: <p>There is a shell script called
2872: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2873: up the sandbox environment using null mounts. It will also
2874: create a script called <code class="filename">sandbox</code> in the
2875: root of the sandbox environment, which will allow the null
2876: mounts to be activated using the <span><strong class="command">sandbox
2877: mount</strong></span> command and deactivated using the
2878: <span><strong class="command">sandbox umount</strong></span> command.</p>
2879: <p>To set up a sandbox environment by hand, after extracting all
2880: the sets from a NetBSD installation or doing a <span><strong class="command">make
2881: distribution DESTDIR=/usr/sandbox</strong></span> in
2882: <code class="filename">/usr/src/etc</code>, be sure the following items
2883: are present and properly configured:</p>
1.75 rillig 2884: <div class="procedure"><ol type="1">
2885: <li>
2886: <p>Kernel</p>
2887: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2888: </li>
2889: <li>
1.76 rillig 2890: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2891: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2892: </li>
2893: <li>
1.91 rillig 2894: <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 2895: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2896: </li>
2897: <li>
2898: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2899: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2900: </li>
2901: <li>
1.91 rillig 2902: <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 2903: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2904: </li>
2905: <li>
1.76 rillig 2906: <p><code class="filename">/usr/src</code> (system sources,
1.91 rillig 2907: 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 2908: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2909: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2910: </li>
2911: <li>
1.76 rillig 2912: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2913: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2914: </li>
2915: <li>
1.76 rillig 2916: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2917: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2918: </li>
2919: <li>
2920: <p>Checkout pkgsrc via cvs into
1.87 wiz 2921: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2922: <pre class="screen">
2923: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2924: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2925: </pre>
1.75 rillig 2926: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2927: you do development in, as this will likely cause problems!</p>
1.75 rillig 2928: </li>
2929: <li><p>Make
1.87 wiz 2930: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2931: <code class="filename">.../distfiles</code> point somewhere
2932: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.76 rillig 2933: <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>
2934: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2935: </ol></div>
2936: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2937: the build with the following steps:</p>
2938: <pre class="screen">
2939: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2940: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2941: </pre>
2942: <p>This will just jump inside the sandbox and start building. At
2943: the end of the build, mail will be sent with the results of
2944: the build. Created binary pkgs will be in
2945: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2946: (wherever that points/mounts to/from).</p>
1.75 rillig 2947: </div>
2948: <div class="sect2" lang="en">
2949: <div class="titlepage"><div><div><h3 class="title">
2950: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2951: <p>In addition to building a complete set of all packages in
2952: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2953: may be used to build a subset of the packages contained in
2954: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
2955: in <code class="filename">/etc/mk.conf</code>, the variables</p>
1.75 rillig 2956: <div class="itemizedlist"><ul type="disc">
2957: <li><p>SITE_SPECIFIC_PKGS</p></li>
2958: <li><p>HOST_SPECIFIC_PKGS</p></li>
2959: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2960: <li><p>USER_SPECIFIC_PKGS</p></li>
2961: </ul></div>
1.87 wiz 2962: <p>will define the set of packages which should be built.
2963: The bulk build code will also include any packages which are
2964: needed as dependencies for the explicitly listed packages.</p>
2965: <p>One use of this is to do a bulk build with
2966: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2967: periodically to have a complete set of the binary packages
2968: needed for your site available without the overhead of
2969: building extra packages that are not needed.</p>
1.75 rillig 2970: </div>
2971: <div class="sect2" lang="en">
2972: <div class="titlepage"><div><div><h3 class="title">
2973: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2974: <p>This section describes how pkgsrc developers can upload binary
2975: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2976: <p>If you would like to automatically create checksum files for the
2977: binary packages you intend to upload, remember to set
2978: <code class="varname">MKSUMS=yes</code> in your
2979: <code class="filename">mk/bulk/build.conf</code>.</p>
2980: <p>If you would like to PGP sign the checksum files (highly
2981: recommended!), remember to set
2982: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2983: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2984: your GPG password to sign the files before uploading everything.</p>
2985: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2986: set properly in your <code class="filename">mk/bulk/build.conf</code>
2987: file, i.e. adjust it to something like one of the following:</p>
1.93 ! rillig 2988: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
! 2989: <p>Please use appropriate values for "packages-200xQy",
1.87 wiz 2990: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2991: is different from your local login, write your login directly
2992: into the variable, e.g. my local account is "feyrer", but for my
2993: login "hubertf", I use:</p>
1.93 ! rillig 2994: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 2995: <p>A separate <code class="filename">upload</code> directory is used
2996: here to allow "closing" the directory during upload. To do
2997: so, run the following command on ftp.NetBSD.org next:</p>
1.93 ! rillig 2998: <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 2999: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
3000: only appropriate for packages for the NetBSD operating
3001: system. Binary packages for other operating systems should go
3002: into <code class="filename">/pub/pkgsrc</code>.</p>
3003: <p>Before uploading the binary pkgs, ssh authentication needs
3004: to be set up. This example shows how to set up temporary keys
3005: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
3006: (assuming that no keys should be present there usually):</p>
3007: <pre class="screen">
3008: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 3009: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
3010: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 3011: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
3012: </pre>
3013: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
3014: append it to your <code class="filename">~/.ssh/authorized_keys</code>
3015: file on ftp.NetBSD.org. You can remove the key after the
3016: upload is done!</p>
3017: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 3018: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 3019: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
3020: <p>Now after all this works, you can exit the sandbox and start
3021: the upload:</p>
3022: <pre class="screen">
3023: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 3024: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 3025: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3026: </pre>
3027: <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
3028: <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
3029: upload. The upload script will take care of not uploading
3030: restricted packages and putting vulnerable packages into the
3031: <code class="filename">vulnerable</code> subdirectory.</p>
3032: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 3033: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 3034: Gdd:x! </pre>
3035: <p>Use whatever is needed to remove the key you've entered
3036: before! Last, move the uploaded packages out of the
3037: <code class="filename">upload</code> directory to have them accessible
3038: to everyone:</p>
3039: <pre class="screen">
1.93 ! rillig 3040: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 3041: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3042: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 3043: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
3044: </pre>
1.75 rillig 3045: </div>
3046: </div>
3047: <div class="sect1" lang="en">
3048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3049: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 3050: <p>After your pkgsrc bulk-build has completed, you may wish to
3051: create a CD-ROM set of the resulting binary packages to assist
3052: in installing packages on other machines. The
1.91 rillig 3053: <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 3054: a simple tool for creating the ISO 9660 images.
3055: <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
3056: way that keeps all the dependencies for a given package on the same
3057: CD as that package.</p>
1.75 rillig 3058: <div class="sect2" lang="en">
3059: <div class="titlepage"><div><div><h3 class="title">
3060: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 3061: <p>Complete documentation for cdpack is found in the cdpack(1)
3062: man page. The following short example assumes that the binary
3063: packages are left in
3064: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3065: sufficient disk space exists in <code class="filename">/u2</code> to
3066: hold the ISO 9660 images.</p>
3067: <pre class="screen">
3068: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3069: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3070: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3071: </pre>
3072: <p>If you wish to include a common set of files
3073: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3074: etc.) on each CD in the collection, then you need to create a
3075: directory which contains these files. e.g.</p>
3076: <pre class="screen">
3077: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3078: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3079: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3080: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3081: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3082: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3083: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3084: </pre>
1.75 rillig 3085: <p>Now create the images:</p>
3086: <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 3087: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3088: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3089: in their root directories.</p>
1.75 rillig 3090: </div>
3091: </div>
3092: </div>
3093: <div class="chapter" lang="en">
3094: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3095: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
3096: <div class="toc">
3097: <p><b>Table of Contents</b></p>
3098: <dl>
1.91 rillig 3099: <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 3100: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
3101: </dl>
3102: </div>
3103: <p>The files that are installed by pkgsrc are organized in a way that
3104: is similar to what you find in the <code class="filename">/usr</code> directory
3105: of the base system. But some details are different. This is because
3106: pkgsrc initially came from FreeBSD and had adopted its file system
3107: hierarchy. Later it was largely influenced by NetBSD. But no matter
3108: which operating system you are using pkgsrc with, you can expect the
3109: same layout for pkgsrc.</p>
1.91 rillig 3110: <p>There are mainly four root directories for pkgsrc, which are all
3111: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3112: When pkgsrc has been installed as root, the default locations
3113: are:</p>
3114: <pre class="programlisting">
3115: LOCALBASE= /usr/pkg
3116: PKG_SYSCONFBASE= /usr/pkg/etc
3117: VARBASE= /var
1.93 ! rillig 3118: PKG_DBDIR= /var/db/pkg
1.91 rillig 3119: </pre>
3120: <p>In unprivileged mode (when pkgsrc has been installed as any other
3121: user), the default locations are:</p>
3122: <pre class="programlisting">
3123: LOCALBASE= ${HOME}/pkg
3124: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3125: VARBASE= ${HOME}/pkg/var
1.93 ! rillig 3126: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3127: </pre>
3128: <p>What these four directories are for, and what they look like is
3129: explained below.</p>
1.90 rillig 3130: <div class="itemizedlist"><ul type="disc">
3131: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3132: <code class="filename">/usr</code> directory in the base system. It is the
3133: “<span class="quote">main</span>” directory where the files are installed and contains
3134: the well-known subdirectories like <code class="filename">bin</code>,
3135: <code class="filename">include</code>, <code class="filename">lib</code>,
3136: <code class="filename">share</code> and
3137: <code class="filename">sbin</code>.</p></li>
3138: <li><p><code class="varname">VARBASE</code> corresponds to
3139: <code class="filename">/var</code> in the base system. Some programs (especially
3140: games, network daemons) need write access to it during normal
3141: operation.</p></li>
3142: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3143: <code class="filename">/etc</code> in the base system. It contains configuration
3144: files of the packages, as well as pkgsrc's <code class="filename">mk.conf</code>
3145: itself.</p></li>
3146: </ul></div>
3147: <div class="sect1" lang="en">
3148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 ! rillig 3149: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code>
! 3150: </h2></div></div></div>
1.90 rillig 3151: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3152: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3153: <div class="variablelist"><dl>
3154: <dt><span class="term"><code class="filename">bin</code></span></dt>
3155: <dd><p>Contains executable programs that are intended to be
3156: directly used by the end user.</p></dd>
3157: <dt><span class="term"><code class="filename">emul</code></span></dt>
3158: <dd><p>Contains files for the emulation layers of various other
3159: operating systems, especially for
3160: NetBSD.</p></dd>
3161: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3162: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3163: <dd><p>Contains
3164: the configuration files.</p></dd>
3165: <dt><span class="term"><code class="filename">include</code></span></dt>
3166: <dd><p>Contains headers for the C and C++ programming
3167: languages.</p></dd>
3168: <dt><span class="term"><code class="filename">info</code></span></dt>
3169: <dd><p>Contains GNU info files of various
3170: packages.</p></dd>
3171: <dt><span class="term"><code class="filename">lib</code></span></dt>
3172: <dd><p>Contains shared and static
3173: libraries.</p></dd>
3174: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3175: <dd><p>Contains data files that don't change after
3176: installation. Other data files belong into
3177: <code class="filename">${VARBASE}</code>.</p></dd>
3178: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3179: <dd><p>Contains programs that are not intended to be used by
3180: end users, such as helper programs or network
3181: daemons.</p></dd>
3182: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3183: <dd><p>Contains programs that are intended to be executed as
3184: CGI scripts by a web server.</p></dd>
3185: <dt><span class="term"><code class="filename">man</code> (the usual value of
3186: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3187: <dd><p>Contains brief
3188: documentation in form of manual pages.</p></dd>
3189: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3190: <dd><p>Contains programs that are intended to be used only by
3191: the super-user.</p></dd>
3192: <dt><span class="term"><code class="filename">share</code></span></dt>
3193: <dd><p>Contains platform-independent data files that don't
3194: change after installation.</p></dd>
3195: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3196: <dd><p>Contains documentation files provided by the
3197: packages.</p></dd>
3198: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3199: <dd><p>Contains example files provided by the packages. Among
3200: others, the original configuration files are saved here and copied to
3201: <code class="filename">${PKG_SYSCONFDIR}</code> during
3202: installation.</p></dd>
3203: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3204: <dd><p>Contains the original files for rc.d
3205: scripts.</p></dd>
3206: <dt><span class="term"><code class="filename">var</code> (the usual location of
3207: <code class="filename">${VARBASE}</code>)</span></dt>
3208: <dd><p>Contains files
3209: that may be modified after
3210: installation.</p></dd>
3211: </dl></div>
3212: </div>
3213: <div class="sect1" lang="en">
3214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 ! rillig 3215: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code>
! 3216: </h2></div></div></div>
1.90 rillig 3217: <div class="variablelist"><dl>
3218: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3219: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3220: <dd><p>Contains
3221: information about the currently installed
3222: packages.</p></dd>
3223: <dt><span class="term"><code class="filename">games</code></span></dt>
3224: <dd><p>Contains highscore
3225: files.</p></dd>
3226: <dt><span class="term"><code class="filename">log</code></span></dt>
3227: <dd><p>Contains log files.</p></dd>
3228: <dt><span class="term"><code class="filename">run</code></span></dt>
3229: <dd><p>Contains informational files about daemons that are
3230: currently running.</p></dd>
3231: </dl></div>
3232: </div>
3233: </div>
3234: <div class="chapter" lang="en">
3235: <div class="titlepage"><div><div><h2 class="title">
3236: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3237: <div class="toc">
3238: <p><b>Table of Contents</b></p>
3239: <dl>
1.90 rillig 3240: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3241: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
3242: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
3243: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
3244: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
3245: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
3246: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
3247: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
3248: <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>
3249: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
3250: <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 3251: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 3252: <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>
3253: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
3254: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
3255: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
3256: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3257: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
3258: <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 3259: </dl>
3260: </div>
3261: <p>This section contains hints, tips & tricks on special things in
3262: pkgsrc that we didn't find a better place for in the previous chapters, and
3263: it contains items for both pkgsrc users and developers.</p>
3264: <div class="sect1" lang="en">
3265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3266: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3267: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3268: <div class="itemizedlist"><ul type="disc">
1.78 rillig 3269: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
3270: This is a general purpose list for most issues regarding
3271: pkgsrc, regardless of platform, e.g. soliciting user help
3272: for pkgsrc configuration, unexpected build failures, using
3273: particular packages, upgrading pkgsrc installations,
3274: questions regarding the pkgsrc release branches, etc. General announcements or
3275: proposals for changes that impact the pkgsrc user community,
3276: e.g. major infrastructure changes, new features, package
3277: removals, etc., may also be posted.</p></li>
1.75 rillig 3278: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
3279: A list where the results of pkgsrc bulk builds are sent and
3280: discussed.</p></li>
3281: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
3282: This list is for those who are interested in getting a
3283: commit message for every change committed to pkgsrc. It is
3284: also available in digest form, meaning one daily message
3285: containing all commit messages for changes to the package
3286: source tree in that 24 hour period.</p></li>
3287: </ul></div>
3288: <p>To subscribe, do:</p>
3289: <pre class="programlisting">
3290: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3291: </pre>
3292: <p>Archives for all these mailing lists are available from
3293: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
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="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3298: <p>Pkgviews is tightly integrated with buildlink. You can find a
3299: pkgviews User's guide in
1.76 rillig 3300: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3301: </div>
3302: <div class="sect1" lang="en">
3303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3304: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3305: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3306: a number of useful utilities for both users and developers of pkgsrc. This
3307: section attempts only to make the reader aware of the utilities and when
3308: they might be useful, and not to duplicate the documentation that comes
3309: with each package.</p>
3310: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 rillig 3311: <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 3312: Symlinks for use by buildlink.</p></li></ul></div>
3313: <p>OS tool augmentation (automatically installed when needed):</p>
3314: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3315: <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 3316: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 rillig 3317: <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 3318: Compatibility library for pkgsrc tools.</p></li>
1.91 rillig 3319: <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 3320: non-BSD systems due to lack of native mtree.</p></li>
1.91 rillig 3321: <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 3322: Up-to-date replacement for
1.76 rillig 3323: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3324: systems where pkg_install is not present.</p></li>
3325: </ul></div>
3326: <p>Utilities used by pkgsrc (not automatically installed):</p>
3327: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3328: <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 3329: Create a binary package from an
3330: already-installed package. Used by <span><strong class="command">make replace</strong></span> to
3331: save the old package.</p></li>
1.91 rillig 3332: <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 3333: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3334: from multiple locations. It currently supports the following
3335: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 rillig 3336: <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 3337: packages someplace else (enabled by default).</p></li>
1.91 rillig 3338: <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 3339: best compiler flags to optimise code for your current CPU and
3340: compiler.</p></li>
3341: </ul></div>
3342: <p>Utilities for keeping track of installed packages, being up to date,
3343: etc:</p>
3344: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3345: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75 rillig 3346: packages whose installed versions do not match the latest pkgsrc
3347: entries.</p></li>
1.91 rillig 3348: <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 3349: dependency graphs of packages, to aid in choosing a strategy for
3350: updating.</p></li>
1.91 rillig 3351: <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
3352: 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>
3353: <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 3354: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3355: does various checks on the complete pkgsrc system.</p></li>
1.91 rillig 3356: <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 3357: packages you have installed.</p></li>
3358: </ul></div>
3359: <p>Utilities for people maintaining or creating individual packages:</p>
3360: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3361: <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 3362: making and maintaining patches for a package (includes pkgdiff,
3363: pkgvi, mkpatches, etc.).</p></li>
1.91 rillig 3364: <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>,
3365: <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 3366: converting to pkgsrc.</p></li>
1.91 rillig 3367: <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 3368: pkgsrc to a Solaris package.</p></li>
3369: </ul></div>
3370: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3371: utilities)</p>
3372: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3373: <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 3374: packages in a chrooted area.</p></li>
1.91 rillig 3375: <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 3376: kernel version for chrooted cross builds.</p></li>
3377: </ul></div>
3378: </div>
3379: <div class="sect1" lang="en">
3380: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3381: <a name="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3382: <p>If you want to use pkgsrc as non-root user, you can set some
3383: variables to make pkgsrc work under these conditions. At the very least,
3384: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3385: will turn on unprivileged mode and set multiple related variables to allow
3386: installation of packages as non-root.</p>
3387: <p>In case the defaults are not enough, you may want to tune some other
3388: variables used. For example, if the automatic user/group detection leads
3389: to incorrect values (or not the ones you would like to use), you can change
3390: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3391: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3392: <p>As regards bootstrapping, please note that the
3393: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
3394: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3395: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 ! rillig 3396: installation targets. These directories can be overridden by the
1.75 rillig 3397: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3398: that allow finer tuning of the tree layout.</p>
3399: </div>
3400: <div class="sect1" lang="en">
3401: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3402: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3403: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3404: enable this feature by adding the option
3405: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.76 rillig 3406: <code class="filename">/etc/mk.conf</code>. If, during a fetch step, an incomplete
1.75 rillig 3407: distfile is found, pkgsrc will try to resume it.</p>
3408: <p>You can also
3409: 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
3410: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3411: <code class="varname">FETCH_RESUME_ARGS</code> and
3412: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3413: values.</p>
3414: <p>For example, if you want to use
1.76 rillig 3415: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75 rillig 3416: like:</p>
3417: <pre class="programlisting">
3418: FETCH_CMD= wget
3419: FETCH_BEFORE_ARGS= --passive-ftp
3420: FETCH_RESUME_ARGS= -c
3421: FETCH_OUTPUT_ARGS= -O
1.1 grant 3422: </pre>
1.75 rillig 3423: </div>
3424: <div class="sect1" lang="en">
3425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3426: <a name="XFree86-from-pkgsrc"></a>8.6. How can I install/use XFree86 from pkgsrc?</h2></div></div></div>
1.75 rillig 3427: <p>If you want to use XFree86 from pkgsrc instead of your system's own
1.76 rillig 3428: X11 (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>,
1.75 rillig 3429: ...), you will have to add the following line into
1.76 rillig 3430: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3431: <pre class="programlisting">
3432: X11_TYPE=XFree86
1.1 grant 3433: </pre>
1.75 rillig 3434: </div>
3435: <div class="sect1" lang="en">
3436: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3437: <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 3438: <p>If you want to use X.org from pkgsrc instead of your system's own X11
1.76 rillig 3439: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3440: you will have to add the following line into
1.76 rillig 3441: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3442: <pre class="programlisting">
3443: X11_TYPE=xorg
1.1 grant 3444: </pre>
1.75 rillig 3445: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3446: <h3 class="title">Note</h3>
3447: <p>The DragonFly operating system defaults to using
1.87 wiz 3448: this X.org X11 implementation from pkgsrc.</p>
1.75 rillig 3449: </div>
3450: </div>
3451: <div class="sect1" lang="en">
3452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3453: <a name="fetch-behind-firewall"></a>8.8. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3454: <p>If you are sitting behind a firewall which does not allow direct
3455: connections to Internet hosts (i.e. non-NAT), you may specify the
3456: relevant proxy hosts. This is done using an environment variable in the
3457: form of a URL, e.g. in Amdahl, the machine
3458: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3459: port 80 as the proxy port number. So the proxy environment variables
3460: are:</p>
3461: <pre class="programlisting">
3462: ftp_proxy=ftp://orpheus.amdahl.com:80/
3463: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3464: </pre>
1.75 rillig 3465: </div>
3466: <div class="sect1" lang="en">
3467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3468: <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 3469: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3470: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3471: the first available command from the following list:</p>
3472: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3473: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3474: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3475: </ul></div>
3476: <p>On a default NetBSD installation, this will be
1.76 rillig 3477: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3478: connections first, and falls back to active connections if the server
3479: refuses to do passive. For the other tools, add the following to your
1.76 rillig 3480: <code class="filename">/etc/mk.conf</code> file:
1.75 rillig 3481: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3482: <p>Having that option present will prevent
1.76 rillig 3483: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3484: transfers.</p>
3485: </div>
3486: <div class="sect1" lang="en">
3487: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3488: <a name="fetching-all-distfiles"></a>8.10. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3489: <p>You would like to download all the distfiles in a single batch
3490: from work or university, where you can't run a <span><strong class="command">make
3491: 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 3492: but downloading the entire directory may not be appropriate.</p>
3493: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76 rillig 3494: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3495: resulting list to your machine at work/school and use it there. If you
3496: 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
3497: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3498: URL:</p>
3499: <p>At home:</p>
3500: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3501: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3502: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3503: <p>At work:</p>
3504: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3505: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3506: home.</p>
3507: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3508: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3509: machine architecture), you can do so by using the above-mentioned
3510: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
3511: directly by running:</p>
1.75 rillig 3512: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3513: <p>If you even decide to ignore
3514: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3515: by running:</p>
3516: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3517: </div>
3518: <div class="sect1" lang="en">
3519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3520: <a name="tmac.andoc-missing"></a>8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 3521: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 rillig 3522: <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 3523: package, you get the error from make that it doesn't know how to make
1.76 rillig 3524: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3525: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3526: the NetBSD base distribution on your machine. It is recommended to do
3527: that to format man pages.</p>
1.91 rillig 3528: <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 3529: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.76 rillig 3530: environment or in <code class="filename">/etc/mk.conf</code>.</p>
1.75 rillig 3531: </div>
3532: <div class="sect1" lang="en">
3533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3534: <a name="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 3535: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3536: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3537: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3538: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3539: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3540: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.75 rillig 3541: the one that corresponds to your release (determine via <span><strong class="command">uname
3542: -r</strong></span>).</p>
3543: </div>
3544: <div class="sect1" lang="en">
3545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3546: <a name="using-sudo-with-pkgsrc"></a>8.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3547: <p>When installing packages as non-root user and using the just-in-time
3548: <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
3549: password for each required package installed. To avoid this, the sudo
3550: package can be used, which does password caching over a limited time. To
3551: use it, install sudo (either as binary package or from
1.91 rillig 3552: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the following
1.76 rillig 3553: into your <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3554: <pre class="programlisting">
3555: .if exists(${LOCALBASE}/bin/sudo)
3556: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3557: .endif
1.1 grant 3558: </pre>
1.75 rillig 3559: </div>
3560: <div class="sect1" lang="en">
3561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3562: <a name="faq.conf"></a>8.14. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3563: <p>As the system administrator, you can choose where configuration files
3564: are installed. The default settings make all these files go into
1.76 rillig 3565: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3566: be suboptimal depending on your expectations (e.g., a read-only,
3567: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3568: configuration of the provided packages).</p>
3569: <p>In order to change the defaults, you can modify the
3570: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.76 rillig 3571: <code class="filename">/etc/mk.conf</code>) to point to your preferred configuration
3572: directory; some common examples include <code class="filename">/etc</code> or
3573: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3574: <p>Furthermore, you can change this value on a per-package basis by
3575: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3576: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3577: package you would like to modify, that is, the contents of
3578: <code class="varname">PKGBASE</code>.</p>
3579: <p>Note that after changing these settings, you must rebuild and
3580: reinstall any affected packages.</p>
3581: </div>
3582: <div class="sect1" lang="en">
3583: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3584: <a name="audit-packages"></a>8.15. Automated security checks</h2></div></div></div>
1.75 rillig 3585: <p>Please be aware that there can often be bugs in third-party software,
3586: and some of these bugs can leave a machine vulnerable to exploitation by
3587: attackers. In an effort to lessen the exposure, the NetBSD packages team
3588: maintains a database of known-exploits to packages which have at one time
3589: been included in pkgsrc. The database can be downloaded automatically, and
3590: a security audit of all packages installed on a system can take place. To
1.91 rillig 3591: 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 3592: components:</p>
3593: <div class="orderedlist"><ol type="1">
3594: <li>
3595: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
3596: download a list of the security vulnerabilities information. This list
3597: is kept up to date by the NetBSD security officer and the NetBSD
3598: packages team, and is distributed from the NetBSD ftp server:</p>
3599: <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>
3600: </li>
3601: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
3602: current machine, checking each vulnerability which is known. If a
3603: vulnerable package is installed, it will be shown by output to stdout,
3604: including a description of the type of vulnerability, and a URL
3605: containing more information.</p></li>
3606: </ol></div>
1.91 rillig 3607: <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 3608: package is strongly recommended! After
3609: “<span class="quote">audit-packages</span>” is installed, please read
3610: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3611: audit-packages</code></strong>.</p>
1.87 wiz 3612: <p>If this package is installed, pkgsrc builds will use it to
3613: 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
3614: check.</p>
1.75 rillig 3615: </div>
3616: <div class="sect1" lang="en">
3617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3618: <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 3619: <p>When you add your own preferences to the
3620: <code class="varname">CFLAGS</code> variable in your
1.76 rillig 3621: <code class="filename">mk.conf</code>, these flags are passed in
3622: environment variables to the <code class="filename">./configure</code>
1.75 rillig 3623: 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
3624: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3625: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3626: package.</p>
3627: <p>Currently there is no solution to this problem. If you
3628: really need the package to use your <code class="varname">CFLAGS</code>
3629: you should run <span><strong class="command">make patch</strong></span> in the package
1.76 rillig 3630: directory and then inspect any <code class="filename">Makefile</code> and
3631: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3632: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3633: these lines. But be aware that some “<span class="quote">smart</span>”
3634: programmers write so bad code that it only works for the
3635: specific combination of <code class="varname">CFLAGS</code> they have
3636: chosen.</p>
3637: </div>
1.80 rillig 3638: <div class="sect1" lang="en">
3639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3640: <a name="ufaq-fail"></a>8.17. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3641: <div class="procedure"><ol type="1">
3642: <li><p>Make sure that your copy of pkgsrc is consistent. A
3643: case that occurs often is that people only update pkgsrc in
3644: parts, because of performance reasons. Since pkgsrc is one large
3645: system, not a collection of many small systems, there are
3646: sometimes changes that only work when the whole pkgsrc tree is
3647: updated.</p></li>
3648: <li><p>Make sure that you don't have any CVS conflicts.
3649: Search for “<span class="quote"><<<<<<</span>” or
3650: “<span class="quote">>>>>>></span>” in all your pkgsrc
3651: files.</p></li>
3652: <li><p>Make sure that you don't have old copies of the packages
3653: extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
3654: verify this.</p></li>
3655: <li><p>If the problem still exists, write a mail to the
3656: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3657: </ol></div>
3658: </div>
1.88 wiz 3659: <div class="sect1" lang="en">
3660: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3661: <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 3662: <p>You have modified a file from pkgsrc, and someone else has
3663: modified that same file afterwards in the CVS repository. Both changes
3664: are in the same region of the file, so when you updated pkgsrc, the
3665: <code class="literal">cvs</code> command marked the conflicting changes in the
3666: file. Because of these markers, the file is no longer a valid
3667: <code class="filename">Makefile</code>.</p>
3668: <p>Have a look at that file, and if you don't need your local changes
3669: anymore, you can remove that file and run <span><strong class="command">cvs -q update
3670: -dP</strong></span> in that directory to download the current version.</p>
3671: </div>
1.75 rillig 3672: </div>
3673: </div>
3674: <div class="part" lang="en">
3675: <div class="titlepage"><div><div><h1 class="title">
3676: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3677: <div class="partintro" lang="en">
3678: <div></div>
3679: <p>This part of the book deals with creating and
3680: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3681: guide on creating a new package. The remaining chapters are more
3682: like a reference manual for pkgsrc.</p>
1.75 rillig 3683: <div class="toc">
3684: <p><b>Table of Contents</b></p>
3685: <dl>
1.90 rillig 3686: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3687: <dd><dl>
3688: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3689: <dd><dl>
3690: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3691: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3692: </dl></dd>
3693: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3694: <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>
3695: </dl></dd>
1.90 rillig 3696: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 3697: <dd><dl>
1.90 rillig 3698: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
3699: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
3700: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
3701: <dd><dl>
1.93 ! rillig 3702: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
! 3703: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
! 3704: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
! 3705: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
! 3706: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 3707: </dl></dd>
3708: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
3709: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
3710: <dd><dl>
3711: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
3712: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
3713: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
3714: </dl></dd>
3715: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
3716: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
3717: </dl></dd>
3718: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3719: <dd><dl>
3720: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
3721: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
3722: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
3723: <dd><dl>
3724: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
3725: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
3726: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
3727: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
3728: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
3729: </dl></dd>
3730: </dl></dd>
3731: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
3732: <dd><dl>
3733: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
3734: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3735: <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>
3736: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
3737: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
3738: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3739: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
3740: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
3741: </dl></dd>
3742: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
3743: <dd><dl>
3744: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
3745: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3746: <dd><dl>
3747: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3748: <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>
3749: </dl></dd>
3750: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3751: <dd><dl>
3752: <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>
3753: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3754: </dl></dd>
3755: </dl></dd>
3756: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
3757: <dd><dl>
3758: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
3759: <dd><dl>
3760: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
3761: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
3762: </dl></dd>
3763: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
3764: <dd><dl>
3765: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3766: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
3767: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
3768: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
3769: </dl></dd>
3770: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
3771: <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>
3772: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
3773: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
3774: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
3775: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
3776: <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>
3777: </dl></dd>
3778: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
3779: <dd><dl>
3780: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
3781: <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>
3782: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
3783: </dl></dd>
3784: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
3785: <dd><dl>
3786: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
3787: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
3788: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
3789: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
3790: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3791: <dd><dl>
3792: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
3793: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
3794: </dl></dd>
3795: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3796: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3797: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3798: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3799: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3800: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3801: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3802: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3803: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3804: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3805: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
3806: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
3807: </dl></dd>
3808: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
3809: <dd><dl>
3810: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3811: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3812: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3813: </dl></dd>
3814: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
3815: <dd><dl>
3816: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
3817: <dd><dl>
3818: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
3819: <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>
3820: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
3821: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
3822: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
3823: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
3824: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
3825: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
3826: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
3827: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
3828: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3829: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3830: </dl></dd>
3831: <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>
3832: <dd><dl>
3833: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3834: <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>
3835: </dl></dd>
3836: <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>
3837: <dd><dl>
3838: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
3839: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3840: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
3841: </dl></dd>
3842: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
3843: <dd><dl>
3844: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
3845: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
3846: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
3847: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
3848: </dl></dd>
3849: <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>
3850: <dd><dl>
3851: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
3852: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
3853: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3854: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
3855: </dl></dd>
3856: <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>
3857: <dd><dl>
3858: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
3859: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
3860: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
3861: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
3862: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
3863: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
3864: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
3865: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
3866: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
3867: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
3868: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
3869: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
3870: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
3871: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
3872: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
3873: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
3874: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 3875: emulation</a></span></dt>
1.90 rillig 3876: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
3877: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77 rillig 3878: </dl></dd>
1.90 rillig 3879: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3880: </dl></dd>
1.90 rillig 3881: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
3882: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 3883: <dd><dl>
1.90 rillig 3884: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
3885: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3886: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
3887: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
3888: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
3889: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
3890: </dl></dd>
3891: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
3892: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3893: <dd><dl>
3894: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3895: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3896: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3897: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 3898: </dl></dd>
1.75 rillig 3899: </dl>
3900: </div>
1.77 rillig 3901: </div>
3902: <div class="chapter" lang="en">
3903: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3904: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3905: <div class="toc">
3906: <p><b>Table of Contents</b></p>
3907: <dl>
3908: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3909: <dd><dl>
3910: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3911: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3912: </dl></dd>
3913: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3914: <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>
3915: </dl>
3916: </div>
1.77 rillig 3917: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3918: most likely have a URL from where you can download the source
3919: code. Starting with this URL, creating a package involves only a
3920: few steps.</p>
1.77 rillig 3921: <div class="procedure"><ol type="1">
1.91 rillig 3922: <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 3923: <li><p>Then, choose one of the top-level directories as the
1.91 rillig 3924: category in which you want to place your package. You can also create a
3925: directory of your own (maybe called <code class="filename">local</code>). In that
3926: category directory, create another directory for your package and change
3927: into it.</p></li>
3928: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
3929: you for a URL. Enter the URL of the distribution file (in most cases a
3930: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3931: of your package are created automatically. The distribution file is
3932: extracted automatically to fill in some details in the
3933: <code class="filename">Makefile</code> that would otherwise have to be done
3934: manually.</p></li>
3935: <li>
3936: <p>Examine the extracted files to determine the dependencies of
3937: your package. Ideally, this is mentioned in some
3938: <code class="filename">README</code> file, but things may differ. For each of
3939: these dependencies, look where it exists in pkgsrc, and if there is a
3940: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3941: line to your package <code class="filename">Makefile</code> which includes that
3942: file just before the last line. If the
3943: <code class="filename">buildlink3.mk</code> file does not exist, add a
3944: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3945: version of the dependency and where it can be found in pkgsrc. This line
3946: should be placed in the third paragraph. If the dependency is only
3947: needed for building the package, but not when using it, use
3948: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3949: Your package may then look like this:</p>
1.77 rillig 3950: <pre class="programlisting">
3951: [...]
3952:
3953: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3954: DEPENDS+= screen-[0-9]*:../../misc/screen
3955: DEPENDS+= screen>=4.0:../../misc/screen
3956:
3957: [...]
3958:
3959: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3960: .include "../../devel/glib2/buildlink3.mk"
3961: .include "../../mk/bsd.pkg.mk"
3962: </pre>
3963: </li>
1.91 rillig 3964: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
3965: to be done to make your package a “<span class="quote">good</span>” one. If you don't
3966: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
3967: --explain</strong></span> or <span><strong class="command">pkglint
3968: -e</strong></span>, which outputs additional
3969: explanations.</p></li>
3970: <li><p>In many cases the package is not yet ready to build. You can
3971: 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
3972: over there, you can hopefully continue here.</p></li>
3973: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
3974: directory from the extracted files. Besides these files, a lot of cache
3975: files and other system information has been saved in the working
3976: directory, which may become wrong after you edited the
3977: <code class="filename">Makefile</code>.</p></li>
3978: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
3979: 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>
3980: <li><p>When the package builds fine, the next step is to install
3981: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
3982: everything works.</p></li>
3983: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
3984: contains a list of the files that are installed by the package, is
3985: nearly empty. Run <span><strong class="command">bmake print-PLIST
3986: >PLIST</strong></span> to generate a probably correct list. Check
3987: the file using your preferred text editor to see if the list of
3988: files looks plausible.</p></li>
3989: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
3990: <code class="filename">PLIST</code> contains garbage or not.</p></li>
3991: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
3992: has been registered in the database of installed files, but with an
3993: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
3994: and <span><strong class="command">bmake install</strong></span> again. Now the package is
3995: registered with the list of files from
3996: <code class="filename">PLIST</code>.</p></li>
3997: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
3998: package from the set of installed files.</p></li>
1.77 rillig 3999: </ol></div>
1.91 rillig 4000: <div class="sect1" lang="en">
4001: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4002: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
4003: <div class="sect2" lang="en">
4004: <div class="titlepage"><div><div><h3 class="title">
4005: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
4006: <p>Simple Perl modules are handled automatically by
4007: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
4008: </div>
4009: <div class="sect2" lang="en">
4010: <div class="titlepage"><div><div><h3 class="title">
4011: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
4012: <p>KDE applications should always include
4013: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
4014: settings that are typical of KDE packages.</p>
4015: </div>
4016: </div>
4017: <div class="sect1" lang="en">
4018: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4019: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
4020: <div class="sect2" lang="en">
4021: <div class="titlepage"><div><div><h3 class="title">
4022: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
4023: <div class="sect3" lang="en">
4024: <div class="titlepage"><div><div><h4 class="title">
4025: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
4026: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4027: that the “<span class="quote">nvu</span>” package has not yet been imported into
4028: pkgsrc. As the description says it has to do with the web, the obvious
4029: choice for the category is “<span class="quote">www</span>”.</p>
4030: <pre class="programlisting">
4031: <code class="prompt">$</code> mkdir www/nvu
4032: <code class="prompt">$</code> cd www/nvu
4033: </pre>
4034: <p>The web site says that the sources are available as a tar file, so
4035: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
4036: <pre class="programlisting">
4037: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4038: </pre>
4039: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4040: below the <code class="varname">DISTNAME</code> line, as the package name should
4041: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4042: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4043: <code class="varname">COMMENT</code> fields. Then the package
4044: <code class="filename">Makefile</code> looked like that:</p>
4045: <pre class="programlisting">
4046: # $NetBSD$
4047: #
4048:
4049: DISTNAME= nvu-1.0-sources
4050: PKGNAME= nvu-1.0
4051: CATEGORIES= www
4052: MASTER_SITES= http://cvs.nvu.com/download/
4053: EXTRACT_SUFX= .tar.bz2
4054:
4055: MAINTAINER= rillig@NetBSD.org
4056: HOMEPAGE= http://cvs.nvu.com/
4057: COMMENT= Web Authoring System
4058:
4059: # url2pkg-marker (please do not remove this line.)
4060: .include "../../mk/bsd.pkg.mk"
4061: </pre>
4062: <p>Then, I quit the editor and watched pkgsrc downloading a large
4063: source archive:</p>
4064: <pre class="programlisting">
4065: url2pkg> Running "make makesum" ...
4066: => Required installed package digest>=20010302: digest-20060826 found
4067: => Fetching nvu-1.0-sources.tar.bz2
4068: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4069: 100% |*************************************| 28992 KB 150.77 KB/s 00:00 ETA
4070: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4071: url2pkg> Running "make extract" ...
4072: => Required installed package digest>=20010302: digest-20060826 found
4073: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4074: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4075: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4076: ===> Installing dependencies for nvu-1.0
4077: ===> Overriding tools for nvu-1.0
4078: ===> Extracting for nvu-1.0
4079: url2pkg> Adjusting the Makefile.
4080:
4081: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
4082:
4083: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
4084: </pre>
4085: </div>
4086: <div class="sect3" lang="en">
4087: <div class="titlepage"><div><div><h4 class="title">
4088: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
4089: <p>Now that the package has been extracted, let's see what's inside
4090: it. The package has a <code class="filename">README.txt</code>, but that only
4091: says something about mozilla, so it's probably useless for seeing what
4092: dependencies this package has. But since there is a GNU configure script
4093: in the package, let's hope that it will complain about everything it
4094: needs.</p>
4095: <pre class="programlisting">
4096: <code class="prompt">$</code> bmake
4097: => Required installed package digest>=20010302: digest-20060826 found
4098: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4099: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4100: ===> Patching for nvu-1.0
4101: ===> Creating toolchain wrappers for nvu-1.0
4102: ===> Configuring for nvu-1.0
4103: [...]
4104: configure: error: Perl 5.004 or higher is required.
4105: [...]
4106: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4107: [...]
4108: </pre>
4109: <p>That worked quite well. So I opened the package Makefile in my
4110: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4111: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4112: package have changed now, and since a perl wrapper is automatically
4113: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4114: from scratch.</p>
4115: <pre class="programlisting">
4116: <code class="prompt">$</code> bmake clean
4117: ===> Cleaning for nvu-1.0
4118: <code class="prompt">$</code> bmake
4119: [...]
4120: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4121: GNU Make. You will not be able to build Mozilla without GNU Make.
4122: [...]
4123: </pre>
4124: <p>So I added “<span class="quote">gmake</span>” to the
4125: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4126: <pre class="programlisting">
4127: [...]
4128: checking for GTK - version >= 1.2.0... no
4129: *** Could not run GTK test program, checking why...
4130: [...]
4131: </pre>
4132: <p>Now to the other dependencies. The first question is: Where is the
4133: GTK package hidden in pkgsrc?</p>
4134: <pre class="programlisting">
4135: <code class="prompt">$</code> echo ../../*/gtk*
4136: [many packages ...]
4137: <code class="prompt">$</code> echo ../../*/gtk
4138: ../../x11/gtk
4139: <code class="prompt">$</code> echo ../../*/gtk2
4140: ../../x11/gtk2
4141: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4142: ../../x11/gtk2/buildlink3.mk
4143: </pre>
4144: <p>The first try was definitely too broad. The second one had exactly
4145: one result, which is very good. But there is one pitfall with GNOME
4146: packages. Before GNOME 2 had been released, there were already many
4147: GNOME 1 packages in pkgsrc. To be able to continue to use these
4148: packages, the GNOME 2 packages were imported as separate packages, and
4149: their names usually have a “<span class="quote">2</span>” appended. So I checked
4150: whether this was the case here, and indeed it was.</p>
4151: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4152: file, adding the dependency is very easy. I just inserted an
4153: <code class="literal">.include</code> line before the last line of the package
4154: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4155: <pre class="programlisting">
4156: [...]
4157: .include "../../x11/gtk2/buildlink3.mk"
4158: .include "../../mk/bsd.pkg.mk
4159: </pre>
4160: <p>After another <span><strong class="command">bmake clean && bmake</strong></span>, the answer
4161: was:</p>
4162: <pre class="programlisting">
4163: [...]
4164: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4165: checking for GTK - version >= 1.2.0... no
4166: *** Could not run GTK test program, checking why...
4167: *** The test program failed to compile or link. See the file config.log for the
4168: *** exact error that occured. This usually means GTK was incorrectly installed
4169: *** or that you have moved GTK since it was installed. In the latter case, you
4170: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4171: configure: error: Test for GTK failed.
4172: [...]
4173: </pre>
4174: <p>In this particular case, the assumption that “<span class="quote">every package
4175: prefers GNOME 2</span>” had been wrong. The first of the lines above
4176: told me that this package really wanted to have the GNOME 1 version of
4177: GTK. If the package had looked for GTK2, it would have looked for
4178: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
4179: So I changed the <code class="literal">x11/gtk2</code> to
4180: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4181: and tried again.</p>
4182: <pre class="programlisting">
4183: [...]
4184: 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
4185: In file included from xpidl.c:42:
4186: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4187: In file included from xpidl.c:42:
4188: xpidl.h:132: error: parse error before "IDL_ns"
4189: [...]
4190: </pre>
4191: <p>The package still does not find all of its dependencies. Now the
4192: question is: Which package provides the
4193: <code class="filename">libIDL/IDL.h</code> header file?</p>
4194: <pre class="programlisting">
4195: <code class="prompt">$</code> echo ../../*/*idl*
4196: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4197: <code class="prompt">$</code> echo ../../*/*IDL*
4198: ../../net/libIDL
4199: </pre>
4200: <p>Let's take the one from the second try. So I included the
4201: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4202: again. But the error didn't change. After digging through some of the
4203: code, I concluded that the build process of the package was broken and
4204: couldn't have ever worked, but since the Mozilla source tree is quite
4205: large, I didn't want to fix it. So I added the following to the package
4206: <code class="filename">Makefile</code> and tried again:</p>
4207: <pre class="programlisting">
4208: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4209: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
4210: </pre>
4211: <p>The latter line is needed because the package expects the library
4212: <code class="filename">libIDL.so</code>, but only
4213: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4214: wrapper to rewrite that on the fly.</p>
4215: <p>The next problem was related to a recent change of the FreeType
4216: 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>
4217: which patch files were relevant for this issue and copied them to the
4218: <code class="filename">patches</code> directory. Then I retried, fixed the
4219: patches so that they applied cleanly and retried again. This time,
4220: everything worked.</p>
4221: </div>
4222: <div class="sect3" lang="en">
4223: <div class="titlepage"><div><div><h4 class="title">
4224: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
4225: <pre class="programlisting">
4226: <code class="prompt">$</code> bmake CHECK_FILES=no install
4227: [...]
4228: <code class="prompt">$</code> bmake print-PLIST >PLIST
4229: <code class="prompt">$</code> bmake deinstall
4230: <code class="prompt">$</code> bmake install
4231: </pre>
4232: </div>
4233: </div>
4234: </div>
1.77 rillig 4235: </div>
1.75 rillig 4236: <div class="chapter" lang="en">
4237: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4238: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4239: <div class="toc">
4240: <p><b>Table of Contents</b></p>
4241: <dl>
1.90 rillig 4242: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
4243: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
4244: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
4245: <dd><dl>
1.93 ! rillig 4246: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
! 4247: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
! 4248: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
! 4249: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
! 4250: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 4251: </dl></dd>
4252: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
4253: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
4254: <dd><dl>
4255: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
4256: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
4257: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4258: </dl></dd>
1.90 rillig 4259: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
4260: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4261: </dl>
4262: </div>
1.87 wiz 4263: <p>Whenever you're preparing a package, there are a number of
4264: files involved which are described in the following
4265: sections.</p>
1.75 rillig 4266: <div class="sect1" lang="en">
4267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 ! rillig 4268: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code>
! 4269: </h2></div></div></div>
1.75 rillig 4270: <p>Building, installation and creation of a binary package are all
1.87 wiz 4271: controlled by the package's <code class="filename">Makefile</code>.
4272: The <code class="filename">Makefile</code> describes various things about
4273: a package, for example from where to get it, how to configure,
4274: build, and install it.</p>
1.76 rillig 4275: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4276: sections that describe the package.</p>
1.75 rillig 4277: <p>In the first section there are the following variables, which
1.87 wiz 4278: should appear exactly in the order given here. The order and
4279: grouping of the variables is mostly historical and has no further
4280: meaning.</p>
1.75 rillig 4281: <div class="itemizedlist"><ul type="disc">
4282: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4283: distribution file to be downloaded from the package's
4284: website.</p></li>
1.75 rillig 4285: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4286: package, as used by pkgsrc. You only need to provide it if
4287: <code class="varname">DISTNAME</code> (which is the default) is not a good
4288: name for the package in pkgsrc. Usually it is the pkgsrc
4289: directory name together with the version number. It must match the
4290: regular expression
4291: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4292: starts with a letter or digit, and contains only letters, digits,
4293: dashes, underscores, dots and plus signs.</p></li>
4294: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4295: the package file to create if the <code class="varname">PKGNAME</code>
4296: isn't unique on a SVR4 system. The default is
4297: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4298: <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 4299: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4300: does not produce an unique package name on a SVR4 system.
4301: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4302: characters.</p></li>
1.75 rillig 4303: <li>
4304: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4305: which the package fits in. You can choose any of the top-level
4306: directories of pkgsrc for it.</p>
1.75 rillig 4307: <p>Currently the following values are available for
1.87 wiz 4308: <code class="varname">CATEGORIES</code>. If more than
4309: one is used, they need to be separated by spaces:</p>
1.75 rillig 4310: <pre class="programlisting">
1.87 wiz 4311: archivers cross geography meta-pkgs security
4312: audio databases graphics misc shells
4313: benchmarks devel ham multimedia sysutils
4314: biology editors inputmethod net textproc
4315: cad emulators lang news time
4316: chat finance mail parallel wm
4317: comms fonts math pkgtools www
4318: converters games mbone print x11
4319: </pre>
1.75 rillig 4320: </li>
1.81 rillig 4321: <li><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4322: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4323: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4324: and <code class="varname">DISTFILES</code> are discussed in detail in
1.90 rillig 4325: <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 4326: </ul></div>
4327: <p>The second section contains information about separately
1.87 wiz 4328: downloaded patches, if any.
4329: </p>
1.75 rillig 4330: <div class="itemizedlist"><ul type="disc">
4331: <li><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4332: Name(s) of additional files that contain distribution patches.
4333: There is no default. pkgsrc will look for them at
4334: <code class="varname">PATCH_SITES</code>.
4335: They will automatically be uncompressed before patching if
4336: the names end with <code class="filename">.gz</code> or
4337: <code class="filename">.Z</code>.</p></li>
1.75 rillig 4338: <li><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4339: Primary location(s) for distribution patch files (see
4340: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4341: </ul></div>
4342: <p>The third section contains the following variables.
1.87 wiz 4343: </p>
1.75 rillig 4344: <div class="itemizedlist"><ul type="disc">
4345: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87 wiz 4346: of the person who feels responsible for this package, and who is
4347: most likely to look at problems or questions regarding this
4348: 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
4349: developers should contact the <code class="varname">MAINTAINER</code> before
4350: making major changes to the package. When packaging a new program,
4351: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4352: maintain the package for future updates, set it to
4353: <code class="email"><<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.75 rillig 4354: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4355: find more information about the package.</p></li>
1.75 rillig 4356: <li><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4357: description of the package (should not include the package
4358: name).</p></li>
1.75 rillig 4359: </ul></div>
4360: <p>Other variables that affect the build:
1.87 wiz 4361: </p>
1.75 rillig 4362: <div class="itemizedlist"><ul type="disc"><li>
4363: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4364: interesting distribution files of the package are found. The
4365: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4366: works for most packages.</p>
1.75 rillig 4367: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4368: (most GNU software does, for instance), but extracts itself in
4369: the current directory, you should set
4370: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4371: <p>If a package doesn't create a subdirectory with the
4372: name of <code class="varname">DISTNAME</code> but some different name,
4373: set <code class="varname">WRKSRC</code> to point to the proper name in
4374: <code class="filename">${WRKDIR}</code>, for example
4375: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4376: <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 4377: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4378: taken from the <code class="varname">WRKDIR_BASENAME</code>
4379: variable. By default, its value is
4380: <code class="filename">work</code>. If you want to use the same
4381: pkgsrc tree for building different kinds of binary packages,
4382: you can change the variable according to your needs. Two
4383: other variables handle common cases of setting
4384: <code class="varname">WRKDIR_BASENAME</code> individually. If
4385: <code class="varname">OBJHOSTNAME</code> is defined in
4386: <code class="filename">/etc/mk.conf</code>, the first component of
4387: the host's name is attached to the directory name. If
4388: <code class="varname">OBJMACHINE</code> is defined, the platform name
4389: is attached, which might look like
4390: <code class="filename">work.i386</code> or
4391: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4392: </li></ul></div>
4393: <p>Please pay attention to the following gotchas:</p>
4394: <div class="itemizedlist"><ul type="disc">
1.87 wiz 4395: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4396: installed in compressed form by the package. For packages using
4397: BSD-style makefiles which honor MANZ, there is
4398: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76 rillig 4399: <li><p>Replace <code class="filename">/usr/local</code> with
1.88 wiz 4400: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4401: below).</p></li>
1.90 rillig 4402: <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 4403: </ul></div>
4404: </div>
4405: <div class="sect1" lang="en">
4406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 ! rillig 4407: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code>
! 4408: </h2></div></div></div>
1.76 rillig 4409: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4410: digest, or checksum, of each distfile needed for the package. This
4411: ensures that the distfiles retrieved from the Internet have not been
4412: corrupted during transfer or altered by a malign force to introduce
4413: a security hole. Due to recent rumor about weaknesses of digest
4414: algorithms, all distfiles are protected using both SHA1 and RMD160
4415: message digests, as well as the file size.</p>
1.76 rillig 4416: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4417: checksums for all the patches found in the
1.90 rillig 4418: <code class="filename">patches</code> directory (see <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a>).</p>
1.76 rillig 4419: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87 wiz 4420: <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
4421: command.</p>
1.75 rillig 4422: <p>Some packages have different sets of distfiles depending on
1.91 rillig 4423: 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 4424: <code class="filename">distinfo</code> file and care should be taken when
4425: upgrading such a package to ensure distfile information is not
4426: lost.</p>
1.75 rillig 4427: </div>
4428: <div class="sect1" lang="en">
4429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4430: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.93 ! rillig 4431: <p>Many packages still don't work out-of-the box on the various
! 4432: platforms that are supported by pkgsrc. Therefore, a number of custom
! 4433: patch files are needed to make the package work. These patch files are
! 4434: found in the <code class="filename">patches/</code> directory.</p>
! 4435: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
! 4436: applied to the files in <code class="varname">WRKSRC</code> directory after
! 4437: extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
! 4438: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4439: <code class="filename">patch-ab</code>, etc.</p>
1.93 ! rillig 4440: <div class="sect2" lang="en">
! 4441: <div class="titlepage"><div><div><h3 class="title">
! 4442: <a name="components.patch.structure"></a>10.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4443: <p>The <code class="filename">patch-*</code> files should be in
1.87 wiz 4444: <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 ! rillig 4445: problems. (To force patches to apply with fuzz you can set
! 4446: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
! 4447: should contain only changed for a single file, and no file should be
! 4448: patched by more than one patch file. This helps to keep future
! 4449: modifications simple.</p>
! 4450: <p>Each patch file is structured as follows: In the first line,
! 4451: there is the RCS Id of the patch itself. The second line should be
! 4452: empty for aesthetic reasons. After that, there should be a comment for
! 4453: each change that the patch does. There are a number of standard
! 4454: cases:</p>
! 4455: <div class="itemizedlist"><ul type="disc">
! 4456: <li><p>Patches that replace the <code class="literal">==</code>
! 4457: 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
! 4458: should contain a reference to , to avoid
! 4459: redundant explanations.</p></li>
! 4460: <li><p>Patches for commonly known vulnerabilities should
! 4461: mention the vulnerability ID (CAN, CVE).</p></li>
! 4462: <li><p>Patches that change source code should mention the
! 4463: platform and other environment (for example, the compiler) that the
! 4464: patch is needed for.</p></li>
! 4465: </ul></div>
! 4466: <p>In all other cases, the patch should be commented so that any
! 4467: developer who knows the code of the application can make some use of
! 4468: the patch. Special care should be taken for the upstream developers,
! 4469: since we generally want that they accept our patches, so we have less
! 4470: work in the future.</p>
! 4471: </div>
! 4472: <div class="sect2" lang="en">
! 4473: <div class="titlepage"><div><div><h3 class="title">
! 4474: <a name="components.patches.caveats"></a>10.3.2. Creating patch files</h3></div></div></div>
! 4475: <p>One important thing to mention is to pay attention that no RCS
! 4476: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4477: later checked into the NetBSD CVS tree. Use the
1.93 ! rillig 4478: <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
! 4479: problems.</p>
1.87 wiz 4480: <p>For even more automation, we recommend using
4481: <span><strong class="command">mkpatches</strong></span> from the same package to make a
4482: whole set of patches. You just have to backup files before you
4483: edit them to <code class="filename">filename.orig</code>, e.g. with
4484: <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
4485: using <span><strong class="command">pkgvi</strong></span> again from the same package. If
4486: you upgrade a package this way, you can easily compare the new
4487: set of patches with the previously existing one with
4488: <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
4489: or update from the <code class="filename">work/.newpatches</code>
4490: directory to <code class="filename">patches/</code>.</p>
4491: <p>When you have finished a package, remember to generate
4492: the checksums for the patch files by using the <span><strong class="command">make
1.90 rillig 4493: 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 4494: <p>When adding a patch that corrects a problem in the
4495: distfile (rather than e.g. enforcing pkgsrc's view of where
4496: man pages should go), send the patch as a bug report to the
4497: maintainer. This benefits non-pkgsrc users of the package,
4498: and usually makes it possible to remove the patch in future
4499: version.</p>
1.93 ! rillig 4500: </div>
! 4501: <div class="sect2" lang="en">
! 4502: <div class="titlepage"><div><div><h3 class="title">
! 4503: <a name="components.patches.sources"></a>10.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4504: <p>If you want to share patches between multiple packages
4505: in pkgsrc, e.g. because they use the same distfiles, set
4506: <code class="varname">PATCHDIR</code> to the path where the patch files
4507: can be found, e.g.:</p>
4508: <pre class="programlisting">
4509: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 ! rillig 4510: </pre>
1.75 rillig 4511: <p>Patch files that are distributed by the author or other
1.87 wiz 4512: maintainers can be listed in
4513: <code class="varname">PATCHFILES</code>.</p>
4514: <p>If it is desired to store any patches that should not be
4515: committed into pkgsrc, they can be kept outside the pkgsrc
4516: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4517: directory tree there is expected to have the same
4518: “<span class="quote">category/package</span>” structure as pkgsrc, and
4519: patches are expected to be stored inside these dirs (also
4520: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4521: example, if you want to keep a private patch for
4522: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4523: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4524: files in the named directory are expected to be patch files,
4525: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4526: applied</em></span>.</p>
1.93 ! rillig 4527: </div>
1.85 jmmv 4528: <div class="sect2" lang="en">
4529: <div class="titlepage"><div><div><h3 class="title">
1.93 ! rillig 4530: <a name="components.patches.guidelines"></a>10.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4531: <p>When fixing a portability issue in the code do not use
4532: preprocessor magic to check for the current operating system nor
4533: platform. Doing so hurts portability to other platforms because
4534: the OS-specific details are not abstracted appropriately.</p>
4535: <p>The general rule to follow is: instead of checking for the
4536: operating system the application is being built on, check for the
4537: specific <span class="emphasis"><em>features</em></span> you need. For example,
4538: instead of assuming that kqueue is available under NetBSD and
4539: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.89 rillig 4540: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4541: yes, this generally involves patching the
4542: <span><strong class="command">configure</strong></span> script. There is absolutely nothing
4543: that prevents some OSes from adopting interfaces from other OSes
4544: (e.g. Linux implementing kqueue), something that the above checks
4545: cannot take into account.</p>
4546: <p>Of course, checking for features generally involves more
4547: work on the developer's side, but the resulting changes are
1.87 wiz 4548: cleaner and there are chances they will work on many other
1.85 jmmv 4549: platforms. Not to mention that there are higher chances of being
4550: later integrated into the mainstream sources. Remember:
4551: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4552: <p>Some typical examples:</p>
4553: <div class="table">
1.90 rillig 4554: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91 rillig 4555: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4556: <colgroup>
4557: <col>
4558: <col>
4559: <col>
4560: </colgroup>
4561: <thead><tr>
4562: <th>Where</th>
4563: <th>Incorrect</th>
4564: <th>Correct</th>
4565: </tr></thead>
4566: <tbody>
4567: <tr>
4568: <td>configure script</td>
4569: <td>
4570: <pre class="programlisting">case ${target_os} in
1.87 wiz 4571: netbsd*) have_kvm=yes ;;
4572: *) have_kvm=no ;;
4573: esac</pre>
1.85 jmmv 4574: </td>
4575: <td>
4576: <pre class="programlisting">AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)</pre>
4577: </td>
4578: </tr>
4579: <tr>
4580: <td>C source file</td>
4581: <td>
4582: <pre class="programlisting">#if defined(__NetBSD__)
1.87 wiz 4583: # include <sys/event.h>
4584: #endif</pre>
1.85 jmmv 4585: </td>
4586: <td>
4587: <pre class="programlisting">#if defined(HAVE_SYS_EVENT_H)
1.87 wiz 4588: # include <sys/event.h>
4589: #endif</pre>
1.85 jmmv 4590: </td>
4591: </tr>
4592: <tr>
4593: <td>C source file</td>
4594: <td>
4595: <pre class="programlisting">int
1.87 wiz 4596: monitor_file(...)
4597: {
4598: #if defined(__NetBSD__)
4599: int fd = kqueue();
4600: ...
4601: #else
4602: ...
4603: #endif
4604: }</pre>
1.85 jmmv 4605: </td>
4606: <td>
4607: <pre class="programlisting">int
1.87 wiz 4608: monitor_file(...)
4609: {
4610: #if defined(HAVE_KQUEUE)
4611: int fd = kqueue();
4612: ...
4613: #else
4614: ...
4615: #endif
4616: }</pre>
1.85 jmmv 4617: </td>
4618: </tr>
4619: </tbody>
1.91 rillig 4620: </table></div>
1.85 jmmv 4621: </div>
1.91 rillig 4622: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85 jmmv 4623: packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4624: 1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4625: 2</a>). It summarizes multiple details on how to make
4626: software easier to package; all the suggestions in it were
4627: collected from our experience in pkgsrc work, so they are possibly
4628: helpful when creating patches too.</p>
4629: </div>
4630: <div class="sect2" lang="en">
4631: <div class="titlepage"><div><div><h3 class="title">
1.93 ! rillig 4632: <a name="components.patches.feedback"></a>10.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4633: <p>Always, always, <span class="strong"><strong>always</strong></span>
4634: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4635: improvements you do to a package to the mainstream developers.
4636: This is the only way to get their attention on portability issues
4637: and to ensure that future versions can be built out-of-the box on
4638: NetBSD. Furthermore, any user that gets newer distfiles will get
4639: the fixes straight from the packaged code.</p>
1.93 ! rillig 4640: <p>This generally involves cleaning up the patches
! 4641: (because sometimes the patches that are
1.85 jmmv 4642: added to pkgsrc are quick hacks), filling bug reports in the
4643: appropriate trackers for the projects and working with the
4644: mainstream authors to accept your changes. It is
4645: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4646: the packages in pkgsrc are kept simple and thus further changes
4647: can be done without much hassle.</p>
4648: <p>Support the idea of free software!</p>
4649: </div>
1.75 rillig 4650: </div>
4651: <div class="sect1" lang="en">
4652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4653: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4654: <div class="variablelist"><dl>
1.76 rillig 4655: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4656: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4657: any credits where they are due. Please bear in mind that others do not
4658: share your sense of humour (or spelling idiosyncrasies), and that others
4659: will read everything that you write here.</p></dd>
1.76 rillig 4660: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4661: <dd><p>This file governs the files that are installed on your
4662: system: all the binaries, manual pages, etc. There are other
4663: directives which may be entered in this file, to control the
4664: creation and deletion of directories, and the location of
1.90 rillig 4665: inserted files. See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87 wiz 4666: information.</p></dd>
1.75 rillig 4667: </dl></div>
4668: </div>
4669: <div class="sect1" lang="en">
4670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4671: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78 rillig 4672: <div class="sect2" lang="en">
4673: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4674: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4675: <div class="variablelist"><dl>
1.76 rillig 4676: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75 rillig 4677: <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 4678: First time after package extraction and before files are
4679: moved in place, the second time after the files to install
4680: are moved in place. This can be used to do any custom
4681: procedures not possible with @exec commands in
4682: <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 4683: <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 4684: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4685: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4686: this script's responsibility to clean up any additional messy details
4687: around the package's installation, since all pkg_delete knows is how to
4688: delete the files created in the original distribution.
4689: 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>
4690: 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 4691: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4692: <dd>
4693: <p>This file is displayed after installation of the package.
1.87 wiz 4694: Useful for things like legal notices on almost-free
4695: software and hints for updating config files after
4696: installing modules for apache, PHP etc.
4697: Please note that you can modify variables in it easily by using
4698: <code class="varname">MESSAGE_SUBST</code> in the package's
4699: <code class="filename">Makefile</code>:</p>
1.75 rillig 4700: <pre class="programlisting">
1.87 wiz 4701: MESSAGE_SUBST+= SOMEVAR="somevalue"
4702: </pre>
1.75 rillig 4703: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4704: <code class="filename">MESSAGE</code>. By default, substitution is
4705: performed for <code class="varname">PKGNAME</code>,
4706: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4707: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4708: <code class="varname">X11BASE</code>,
4709: <code class="varname">PKG_SYSCONFDIR</code>,
4710: <code class="varname">ROOT_GROUP</code>, and
4711: <code class="varname">ROOT_GROUP</code>.</p>
4712: <p>You can display a different or additional files by
4713: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4714: default is <code class="filename">MESSAGE</code>, if the file
4715: exists.</p>
1.75 rillig 4716: </dd>
1.78 rillig 4717: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4718: <dd><p>FIXME: There is no documentation on the
4719: alternatives framework.</p></dd>
4720: </dl></div>
4721: </div>
4722: <div class="sect2" lang="en">
4723: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4724: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4725: <div class="variablelist"><dl>
4726: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4727: <dd><p>This file contains arbitrary things that could
4728: also go into a <code class="filename">Makefile</code>, but its purpose is
4729: to be used by more than one package. This file should only be
4730: used when the packages that will use the file are known in
4731: advance. For other purposes it is often better to write a
4732: <code class="filename">*.mk</code> file and give it a good name that
4733: describes what it does.</p></dd>
4734: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4735: <dd><p>This file contains the dependency information
1.90 rillig 4736: 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 4737: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4738: <dd><p>This file contains workarounds for compiler bugs
4739: and similar things. It is included automatically by the pkgsrc
4740: infrastructure, so you don't need an extra
4741: <code class="literal">.include</code> line for
4742: it.</p></dd>
4743: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4744: <dd><p>This file contains the code for the
1.90 rillig 4745: 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 4746: selected by the user. If a package has only one or two options,
4747: it is equally acceptable to put the code directly into the
4748: <code class="filename">Makefile</code>.</p></dd>
4749: </dl></div>
4750: </div>
4751: <div class="sect2" lang="en">
4752: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4753: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4754: <div class="variablelist"><dl>
4755: <dt><span class="term"><code class="filename">README*</code></span></dt>
4756: <dd><p>These files do not take place in the creation of
4757: a package and thus are purely informative to the package
4758: developer.</p></dd>
4759: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4760: <dd><p>This file contains things that need to be done
4761: to make the package even
4762: better.</p></dd>
1.75 rillig 4763: </dl></div>
4764: </div>
1.78 rillig 4765: </div>
1.75 rillig 4766: <div class="sect1" lang="en">
4767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 ! rillig 4768: <a name="work-dir"></a>10.6. <code class="filename">work*</code>
! 4769: </h2></div></div></div>
1.75 rillig 4770: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87 wiz 4771: unpacked into the directory denoted by
4772: <code class="varname">WRKDIR</code>. It can be removed by running
4773: <span><strong class="command">make clean</strong></span>. Besides the sources, this
4774: directory is also used to keep various timestamp files.
4775: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4776: The default is <code class="filename">${.CURDIR}/work</code>
4777: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4778: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4779: </div>
4780: <div class="sect1" lang="en">
4781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 ! rillig 4782: <a name="files-dir"></a>10.7. <code class="filename">files/*</code>
! 4783: </h2></div></div></div>
1.75 rillig 4784: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4785: to configuration or building, you could place these files here and use
4786: a <span><strong class="command">${CP}</strong></span> command in the
4787: “<span class="quote">pre-configure</span>” target to achieve
4788: this. Alternatively, you could simply diff the file against
4789: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4790: the creation of this file.</p>
4791: <p>If you want to share files in this way with other
4792: packages, set the <code class="varname">FILESDIR</code> variable to point
4793: to the other package's <code class="filename">files</code> directory,
4794: e.g.:</p>
4795: <pre class="programlisting">
4796: FILESDIR=${.CURDIR}/../xemacs/files
4797: </pre>
1.75 rillig 4798: </div>
4799: </div>
4800: <div class="chapter" lang="en">
4801: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4802: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4803: <div class="toc">
4804: <p><b>Table of Contents</b></p>
4805: <dl>
1.90 rillig 4806: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
4807: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
4808: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
4809: <dd><dl>
4810: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
4811: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
4812: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
4813: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
4814: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
1.75 rillig 4815: </dl></dd>
4816: </dl>
4817: </div>
1.76 rillig 4818: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4819: each of which forms a well-defined part of the pkgsrc system. Using
4820: 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
4821: like pkgsrc requires some discipline to keep the code correct and
4822: understandable.</p>
1.76 rillig 4823: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4824: programming are variables (which are actually macros) and shell
4825: commands. Among these shell commands may even be more complex ones
4826: 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
4827: as intended it is necessary to quote all variables correctly when they
4828: are used.</p>
4829: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4830: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4831: with them.</p>
4832: <div class="sect1" lang="en">
4833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4834: <a name="makefile.variables"></a>11.1. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4835: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4836: can be processed using the five operators ``='', ``+='', ``?='',
4837: ``:='', 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
4838: page.</p>
4839: <p>When a variable's value is parsed from a
1.76 rillig 4840: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4841: backslash character ``\'' are handled specially. If a backslash is
4842: followed by a newline, any whitespace immediately in front of the
4843: backslash, the backslash, the newline, and any whitespace
4844: immediately behind the newline are replaced with a single space. A
4845: backslash character and an immediately following hash character are
4846: replaced with a single hash character. Otherwise, the backslash is
4847: passed as is. In a variable assignment, any hash character that is
4848: not preceded by a backslash starts a comment that continues upto the
4849: end of the logical line.</p>
4850: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4851: the only way to create a variable consisting of a single backslash
4852: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4853: <p>So far for defining variables. The other thing you can do with
4854: variables is evaluating them. A variable is evaluated when it is
4855: part of the right side of the ``:='' or the ``!='' operator, or
4856: directly before executing a shell command which the variable is part
4857: 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
4858: is, variables are not evaluated until there's no other way. The
4859: ``modifiers'' mentioned in the man page also evaluate the
4860: variable.</p>
4861: <p>Some of the modifiers split the string into words and then
4862: operate on the words, others operate on the string as a whole. When
4863: a string is split into words, it is split as you would expect
4864: 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 4865: <p>No rule without exception—the <span><strong class="command">.for</strong></span>
1.75 rillig 4866: loop does not follow the shell quoting rules but splits at sequences
4867: of whitespace.</p>
4868: <p>There are several types of variables that should be handled
4869: differently. Strings and two types of lists.</p>
4870: <div class="itemizedlist"><ul type="disc">
4871: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4872: characters. Nevertheless, you should restrict yourself to only
4873: using printable characters. Examples are
4874: <code class="varname">PREFIX</code> and
4875: <code class="varname">COMMENT</code>.</p></li>
4876: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4877: are never exported to any shell command. Their elements are
4878: separated by whitespace. Therefore, the elements themselves cannot
4879: have embedded whitespace. Any other characters are allowed.
4880: Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
4881: Examples are <code class="varname">DEPENDS</code> and
4882: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4883: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4884: may be exported to a shell command. Their elements can contain any
4885: characters, including whitespace. That's why they cannot be used
4886: in <span><strong class="command">.for</strong></span> loops. Examples are
4887: <code class="varname">DISTFILES</code> and
4888: <code class="varname">MASTER_SITES</code>.</p></li>
4889: </ul></div>
4890: <div class="sect2" lang="en">
4891: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4892: <a name="makefile.variables.names"></a>11.1.1. Naming conventions</h3></div></div></div>
1.75 rillig 4893: <div class="itemizedlist"><ul type="disc">
4894: <li><p>All variable names starting with an underscore
4895: are reserved for use by the pkgsrc infrastructure. They shall
4896: not be used by package
1.76 rillig 4897: <code class="filename">Makefile</code>s.</p></li>
1.75 rillig 4898: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
4899: lowercase variable names for the iteration
4900: variables.</p></li>
4901: <li><p>All list variables should have a ``plural''
4902: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4903: <code class="varname">DISTFILES</code>.</p></li>
4904: </ul></div>
4905: </div>
4906: </div>
4907: <div class="sect1" lang="en">
4908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4909: <a name="makefile.code"></a>11.2. Code snippets</h2></div></div></div>
1.75 rillig 4910: <p>This section presents you with some code snippets you should
4911: use in your own code. If you don't find anything appropriate here,
4912: you should test your code and add it here.</p>
4913: <div class="sect2" lang="en">
4914: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4915: <a name="adding-to-list"></a>11.2.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4916: <pre class="programlisting">
4917: STRING= foo * bar `date`
4918: INT_LIST= # empty
4919: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4920: EXT_LIST= # empty
4921: ANOTHER_EXT_LIST= a=b c=d
1.1 grant 4922:
1.75 rillig 4923: INT_LIST+= ${STRING} # 1
4924: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4925: EXT_LIST+= ${STRING:Q} # 3
4926: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4927: </pre>
1.75 rillig 4928: <p>When you add a string to an external list (example 3), it
4929: must be quoted. In all other cases, you must not add a quoting
4930: level. You must not merge internal and external lists, unless you
4931: are sure that all entries are correctly interpreted in both
4932: lists.</p>
4933: </div>
4934: <div class="sect2" lang="en">
4935: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4936: <a name="converting-internal-to-external"></a>11.2.2. Converting an internal list into an external list</h3></div></div></div>
1.75 rillig 4937: <pre class="programlisting">
4938: EXT_LIST= # empty
4939: .for i in ${INT_LIST}
4940: EXT_LIST+= ${i:Q}""
4941: .endfor
1.1 grant 4942: </pre>
1.75 rillig 4943: <p>This code converts the internal list
4944: <code class="varname">INT_LIST</code> into the external list
4945: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4946: are unquoted they must be quoted here. The reason for appending
4947: <code class="varname">""</code> is explained below.</p>
4948: </div>
4949: <div class="sect2" lang="en">
4950: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4951: <a name="passing-variable-to-shell"></a>11.2.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4952: <p>Sometimes you may want to print an arbitrary string. There
4953: are many ways to get it wrong and only few that can handle every
4954: nastiness.</p>
1.75 rillig 4955: <pre class="programlisting">
4956: STRING= foo bar < > * `date` $$HOME ' "
4957: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4958:
1.75 rillig 4959: all:
4960: echo ${STRING} # 1
4961: echo "${STRING}" # 2
4962: echo "${STRING:Q}" # 3
4963: echo ${STRING:Q} # 4
4964: echo x${STRING:Q} | sed 1s,.,, # 5
1.79 rillig 4965: printf "%s\\n" ${STRING:Q}"" # 6
1.75 rillig 4966: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4967: </pre>
1.75 rillig 4968: <p>Example 1 leads to a syntax error in the shell, as the
4969: characters are just copied.</p>
4970: <p>Example 2 leads to a syntax error too, and if you leave out
4971: the last " character from <code class="varname">${STRING}</code>,
4972: <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
4973: variable would be evaluated, too.</p>
4974: <p>Example 3 outputs each space character preceded by a
4975: backslash (or not), depending on the implementation of the
4976: <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>
4977: <p>Example 4 handles correctly every string that does not start
4978: with a dash. In that case, the result depends on the
4979: 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
4980: guarantee that your input does not start with a dash, this form is
4981: appropriate.</p>
4982: <p>Example 5 handles even the case of a leading dash
4983: correctly.</p>
1.79 rillig 4984: <p>Example 6 also works with every string and is the
4985: light-weight solution, since it does not involve a pipe, which has
4986: its own problems.</p>
1.75 rillig 4987: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4988: because the quoting has already been done when adding elements to
4989: the list.</p>
4990: <p>As internal lists shall not be passed to the shell, there is
4991: no example for it.</p>
4992: </div>
4993: <div class="sect2" lang="en">
4994: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4995: <a name="quoting-guideline"></a>11.2.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4996: <p>There are many possible sources of wrongly quoted variables.
4997: This section lists some of the commonly known ones.</p>
4998: <div class="itemizedlist"><ul type="disc">
4999: <li>
5000: <p>Whenever you use the value of a list, think
5001: about what happens to leading or trailing whitespace. If the
5002: list is a well-formed shell expression, you can apply the
5003: <code class="varname">:M*</code> modifier to strip leading and trailing
5004: whitespace from each word. The <code class="varname">:M</code> operator
5005: first splits its argument according to the rules of the shell,
5006: and then creates a new list consisting of all words that match
5007: the shell glob expression <code class="varname">*</code>, that is: all.
5008: One class of situations where this is needed is when adding a
5009: variable like <code class="varname">CPPFLAGS</code> to
5010: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5011: invokes other configure scripts, it strips the leading and
5012: trailing whitespace from the variable and then passes it to the
5013: other configure scripts. But these configure scripts expect the
5014: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5015: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5016: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5017: here is how we do it:</p>
5018: <pre class="programlisting">
5019: CPPFLAGS= # empty
5020: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5021: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 5022:
1.75 rillig 5023: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 5024:
1.75 rillig 5025: all:
5026: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5027: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5028: </pre>
1.75 rillig 5029: </li>
5030: <li><p>The example above contains one bug: The
5031: <code class="varname">${PREFIX}</code> is a properly quoted shell
5032: expression, but there is the C compiler after it, which also
5033: expects a properly quoted string (this time in C syntax). The
5034: version above is therefore only correct if
5035: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5036: or double quotes. If you want to allow these, you have to add
5037: another layer of quoting to each variable that is used as a C
5038: string literal. You cannot use the <code class="varname">:Q</code>
5039: operator for it, as this operator only works for the
5040: shell.</p></li>
5041: <li>
5042: <p>Whenever a variable can be empty, the
5043: <code class="varname">:Q</code> operator can have surprising results. Here
5044: are two completely different cases which can be solved with the
5045: same trick.</p>
5046: <pre class="programlisting">
5047: EMPTY= # empty
5048: empty_test:
5049: for i in a ${EMPTY:Q} c; do \
5050: echo "$$i"; \
5051: done
1.1 grant 5052:
1.75 rillig 5053: for_test:
5054: .for i in a:\ a:\test.txt
5055: echo ${i:Q}
5056: echo "foo"
5057: .endfor
1.1 grant 5058: </pre>
1.75 rillig 5059: <p>The first example will only print two of the three lines
5060: we might have expected. This is because
5061: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5062: the shell cannot see. The workaround is to write
5063: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5064: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5065: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5066: <p>The second example will only print three lines instead of
5067: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5068: This is because the backslash of the value
5069: <code class="varname">a:\</code> is interpreted as a line-continuation by
5070: <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
5071: <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
5072: <code class="varname">${i:Q}""</code>.</p>
5073: </li>
5074: </ul></div>
5075: </div>
5076: <div class="sect2" lang="en">
5077: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5078: <a name="bsd-make-bug-workaround"></a>11.2.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5079: <p>The pkgsrc bmake program does not handle the following
5080: assignment correctly. In case <code class="varname">_othervar_</code>
5081: contains a ``-'' character, one of the closing braces is included
5082: in <code class="varname">${VAR}</code> after this code executes.</p>
5083: <pre class="programlisting">
5084: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5085: </pre>
1.75 rillig 5086: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5087: 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 5088: <code class="varname">bug1</code>.</p>
5089: </div>
5090: </div>
5091: </div>
5092: <div class="chapter" lang="en">
5093: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5094: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75 rillig 5095: <div class="toc">
5096: <p><b>Table of Contents</b></p>
5097: <dl>
1.90 rillig 5098: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
5099: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5100: <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>
5101: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
5102: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
5103: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5104: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
5105: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5106: </dl>
5107: </div>
1.87 wiz 5108: <p>The <code class="filename">PLIST</code> file contains a package's
5109: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5110: the package (relative to the <code class="filename">${PREFIX}</code>
5111: directory it's been installed in) plus some additional statements
5112: - 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.
5113: This chapter addresses some issues that need attention when
5114: dealing with the <code class="filename">PLIST</code> file (or files, see
5115: below!).</p>
1.75 rillig 5116: <div class="sect1" lang="en">
5117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5118: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87 wiz 5119: <p>Be sure to add a RCS ID line as the first thing in any
5120: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5121: <pre class="programlisting">
1.87 wiz 5122: @comment $NetBSD$
5123: </pre>
1.75 rillig 5124: </div>
5125: <div class="sect1" lang="en">
5126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5127: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75 rillig 5128: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87 wiz 5129: to output a PLIST that matches any new files since the package
1.90 rillig 5130: 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 5131: more information on this target.</p>
1.75 rillig 5132: </div>
5133: <div class="sect1" lang="en">
5134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 ! rillig 5135: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
! 5136: </h2></div></div></div>
1.87 wiz 5137: <p>If you have used any of the *-dirs packages, as explained in
1.90 rillig 5138: <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 5139: <span><strong class="command">make print-PLIST</strong></span> outputs a set of
5140: <code class="varname">@comment</code>s instead of real
5141: <code class="varname">@dirrm</code> lines. You can also do this for
5142: specific directories and files, so that the results of that
5143: command are very close to reality. This helps <span class="emphasis"><em>a
5144: lot</em></span> during the update of packages.</p>
5145: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5146: of AWK patterns and actions that are used to filter the output of
5147: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5148: scripting you like to it, but be careful with quoting.</p>
5149: <p>For example, to get all files inside the
5150: <code class="filename">libdata/foo</code> directory removed from the
5151: resulting PLIST:</p>
5152: <pre class="programlisting">
5153: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
5154: </pre>
5155: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5156: to a specific (shared) directory converted to
5157: <code class="varname">@comment</code>s:</p>
1.75 rillig 5158: <pre class="programlisting">
1.87 wiz 5159: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5160: </pre>
1.75 rillig 5161: </div>
5162: <div class="sect1" lang="en">
5163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5164: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5165: <p>A number of variables are substituted automatically in
5166: PLISTs when a package is installed on a system. This includes the
5167: following variables:</p>
1.75 rillig 5168: <div class="variablelist"><dl>
5169: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5170: <dd>
5171: <p>Some packages like emacs and perl embed information
1.87 wiz 5172: about which architecture they were built on into the
5173: pathnames where they install their files. To handle this
5174: case, PLIST will be preprocessed before actually used, and
5175: the symbol
5176: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
5177: replaced by what <span><strong class="command">uname -p</strong></span> gives. The
5178: same is done if the string
5179: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5180: PLIST somewhere - use this on packages that have GNU
5181: autoconf-created configure scripts.</p>
1.75 rillig 5182: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5183: <h3 class="title">Legacy note</h3>
5184: <p>There used to be a symbol
1.87 wiz 5185: “<span class="quote"><code class="varname">$ARCH</code></span>” that
5186: was replaced by the output of <span><strong class="command">uname
5187: -m</strong></span>, but that's no longer supported and has
5188: been removed.</p>
1.75 rillig 5189: </div>
5190: </dd>
5191: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5192: <dd>
5193: <p>Some packages want to embed the OS name and version
1.87 wiz 5194: into some paths. To do this, use these variables in the
5195: <code class="filename">PLIST</code>:
5196: </p>
1.75 rillig 5197: <div class="itemizedlist"><ul type="disc">
5198: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span><strong class="command">uname -s</strong></span></span>”</p></li>
5199: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
5200: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span><strong class="command">uname -r</strong></span></span>”</p></li>
5201: </ul></div>
5202: </dd>
5203: </dl></div>
1.87 wiz 5204: <p>For a complete list of values which are replaced by
5205: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5206: search for <code class="varname">PLIST_SUBST</code>).</p>
5207: <p>If you want to change other variables not listed above, you
5208: can add variables and their expansions to this variable in the
1.90 rillig 5209: 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 5210: <pre class="programlisting">
1.87 wiz 5211: PLIST_SUBST+= SOMEVAR="somevalue"
5212: </pre>
1.75 rillig 5213: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5214: in the <code class="filename">PLIST</code> with
5215: “<span class="quote">somevalue</span>”.</p>
1.75 rillig 5216: </div>
5217: <div class="sect1" lang="en">
5218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5219: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75 rillig 5220: <p>Man pages should be installed in compressed form if
1.87 wiz 5221: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5222: and uncompressed otherwise. To handle this in the
5223: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5224: appended/removed automatically for man pages according to
5225: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5226: or not, see above for details. This modification of the
5227: <code class="filename">PLIST</code> file is done on a copy of it, not
5228: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5229: </div>
5230: <div class="sect1" lang="en">
5231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 ! rillig 5232: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
! 5233: </h2></div></div></div>
1.76 rillig 5234: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5235: in generating the binary package, set the variable
5236: <code class="varname">PLIST_SRC</code> to the names of that file(s).
5237: 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
5238: important. The default for <code class="varname">PLIST_SRC</code> is
5239: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5240: </div>
5241: <div class="sect1" lang="en">
5242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5243: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5244: <p>Some packages decide to install a different set of files based on
1.87 wiz 5245: the operating system being used. These differences can be
5246: automatically handled by using the following files:</p>
1.75 rillig 5247: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5248: <li><p><code class="filename">PLIST.common</code></p></li>
5249: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5250: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5251: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5252: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5253: </ul></div>
5254: </div>
5255: <div class="sect1" lang="en">
5256: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5257: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5258: <p>A “<span class="quote">shared directory</span>” is a directory where
5259: multiple (and unrelated) packages install files. These
5260: directories are problematic because you have to add special tricks
5261: in the PLIST to conditionally remove them, or have some
5262: centralized package handle them.</p>
5263: <p>Within pkgsrc, you'll find both approaches. If a directory
5264: is shared by a few unrelated packages, it's often not worth to add
5265: an extra package to remove it. Therefore, one simply does:</p>
5266: <pre class="programlisting">
5267: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
5268: </pre>
5269: <p>in the PLISTs of all affected packages, instead of the
5270: regular "@dirrm" line.</p>
5271: <p>However, if the directory is shared across many packages, two
5272: different solutions are available:</p>
1.75 rillig 5273: <div class="orderedlist"><ol type="1">
1.87 wiz 5274: <li><p>If the packages have a common dependency, the directory
5275: can be removed in that. For example, see
1.91 rillig 5276: <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 5277: removes the shared directory
5278: <code class="filename">share/omf</code>.</p></li>
5279: <li><p>If the packages using the directory are not related at
5280: all (they have no common dependencies), a *-dirs package is
5281: used.</p></li>
1.75 rillig 5282: </ol></div>
1.87 wiz 5283: <p>From now on, we'll discuss the second solution. To get an
5284: idea of the *-dirs packages available, issue:</p>
1.75 rillig 5285: <pre class="programlisting">
1.87 wiz 5286: <code class="prompt">%</code> cd .../pkgsrc
5287: <code class="prompt">%</code> ls -d */*-dirs
5288: </pre>
5289: <p>Their use from other packages is very simple. The
5290: <code class="varname">USE_DIRS</code> variable takes a list of package names
5291: (without the “<span class="quote">-dirs</span>” part) together with the required
5292: version number (always pick the latest one when writing new
5293: packages).</p>
5294: <p>For example, if a package installs files under
5295: <code class="filename">share/applications</code>, it should have the
5296: following line in it:</p>
5297: <pre class="programlisting">
5298: USE_DIRS+= xdg-1.1
5299: </pre>
5300: <p>After regenerating the PLIST using <span><strong class="command">make
5301: print-PLIST</strong></span>, you should get the right (commented out)
5302: lines.</p>
5303: <p>Note that even if your package is using
5304: <code class="filename">$X11BASE</code>, it must not depend on the
5305: *-x11-dirs packages. Just specify the name without that part and
5306: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5307: care of it.</p>
1.75 rillig 5308: </div>
5309: </div>
5310: <div class="chapter" lang="en">
5311: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5312: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75 rillig 5313: <div class="toc">
5314: <p><b>Table of Contents</b></p>
5315: <dl>
1.90 rillig 5316: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
5317: <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 5318: <dd><dl>
1.90 rillig 5319: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5320: <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 5321: </dl></dd>
1.90 rillig 5322: <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 5323: <dd><dl>
1.90 rillig 5324: <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>
5325: <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 5326: </dl></dd>
5327: </dl>
5328: </div>
5329: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5330: are seen by a package's configure and build processes. This is implemented
5331: in a two step process:</p>
1.75 rillig 5332: <div class="orderedlist"><ol type="1">
5333: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5334: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5335: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5336: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5337: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5338: <code class="option">-L${LOCALBASE}/lib</code> into references to
5339: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5340: native compiler on some operating systems look like GCC, so that
5341: packages that expect GCC won't require modifications to build with
5342: those native compilers.</p></li>
1.75 rillig 5343: </ol></div>
5344: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5345: package may be built consistently despite what other software may be
5346: installed. Please note that the normal system header and library paths,
5347: e.g. <code class="filename">/usr/include</code>,
5348: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5349: designed to insulate the package build from non-system-supplied
5350: software.</p>
1.75 rillig 5351: <div class="sect1" lang="en">
5352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5353: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5354: <p>The process of converting packages to use the buildlink3
1.87 wiz 5355: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5356: The things to keep in mind are:</p>
1.75 rillig 5357: <div class="orderedlist"><ol type="1">
1.87 wiz 5358: <li><p>Ensure that the build always calls the wrapper scripts
5359: instead of the actual toolchain. Some packages are tricky,
5360: and the only way to know for sure is the check
5361: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5362: wrappers are being invoked.</p></li>
5363: <li><p>Don't override <code class="varname">PREFIX</code> from within
5364: the package Makefile, e.g. Java VMs, standalone shells,
5365: etc., because the code to symlink files into
5366: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5367: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5368: </p></li>
5369: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5370: <code class="filename">buildlink3.mk</code> files that you list in a
5371: package's Makefile are added as dependencies for that package.
5372: </p></li>
1.75 rillig 5373: </ol></div>
1.87 wiz 5374: <p>If a dependency on a particular package is required for its libraries and
5375: headers, then we replace:</p>
1.75 rillig 5376: <pre class="programlisting">
1.87 wiz 5377: DEPENDS+= foo>=1.1.0:../../category/foo
5378: </pre>
1.75 rillig 5379: <p>with</p>
5380: <pre class="programlisting">
1.87 wiz 5381: .include "../../category/foo/buildlink3.mk"
5382: </pre>
1.75 rillig 5383: <p>The buildlink3.mk files usually define the required dependencies.
5384: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5385: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5386: <pre class="programlisting">
1.87 wiz 5387: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5388: .include "../../category/foo/buildlink3.mk"
5389: </pre>
1.76 rillig 5390: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5391: files in <code class="filename">pkgsrc/mk</code>
5392: that handle special package issues:</p>
1.75 rillig 5393: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5394: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5395: the native or a pkgsrc Berkeley DB implementation based on
5396: the values of <code class="varname">BDB_ACCEPTED</code> and
5397: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5398: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5399: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5400: 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 5401: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5402: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5403: adding a dependency on Heimdal or MIT-krb5 for packages that
5404: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5405: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5406: system-provided Motif installation or adds a dependency on
1.91 rillig 5407: <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 5408: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5409: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5410: which Motif version will be used.</p></li>
1.76 rillig 5411: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5412: variables that may be used by packages that use the
5413: Open Sound System (OSS) API.</p></li>
1.76 rillig 5414: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 ! rillig 5415: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5416: the file for more information.</p></li>
1.76 rillig 5417: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5418: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5419: 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 5420: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5421: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5422: library.</p></li>
1.75 rillig 5423: </ul></div>
1.76 rillig 5424: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5425: files provide a more complete
5426: description of how to use them properly.</p>
1.75 rillig 5427: </div>
5428: <div class="sect1" lang="en">
5429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5430: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87 wiz 5431: <p>A package's <code class="filename">buildlink3.mk</code> file is
5432: included by Makefiles to indicate the need to compile and link
5433: against header files and libraries provided by the package. A
5434: <code class="filename">buildlink3.mk</code> file should always provide
5435: enough information to add the correct type of dependency
5436: relationship and include any other
5437: <code class="filename">buildlink3.mk</code> files that it needs to find
5438: headers and libraries that it needs in turn.</p>
5439: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5440: 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 5441: package is highly recommended. For most packages, the following
5442: command will generate a good starting point for
5443: <code class="filename">buildlink3.mk</code> files:</p>
5444: <pre class="screen">
5445: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5446: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5447: </pre>
1.75 rillig 5448: <div class="sect2" lang="en">
5449: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5450: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5451: <p>The following real-life example
1.87 wiz 5452: <code class="filename">buildlink3.mk</code> is taken
5453: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5454: <pre class="programlisting">
1.87 wiz 5455: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1 grant 5456:
1.87 wiz 5457: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5458: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
1.1 grant 5459:
1.87 wiz 5460: .if !empty(BUILDLINK_DEPTH:M+)
5461: BUILDLINK_DEPENDS+= tiff
5462: .endif
5463:
5464: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5465: BUILDLINK_PACKAGES+= tiff
5466:
5467: .if !empty(TIFF_BUILDLINK3_MK:M+)
5468: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5469: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5470: .endif # TIFF_BUILDLINK3_MK
5471:
5472: .include "../../devel/zlib/buildlink3.mk"
5473: .include "../../graphics/jpeg/buildlink3.mk"
5474:
5475: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5476: </pre>
5477: <p>The header and footer manipulate
5478: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5479: <code class="filename">buildlink3.mk</code> files and is used to track
5480: at what depth we are including
5481: <code class="filename">buildlink3.mk</code> files.</p>
5482: <p>The first section controls if the dependency on
5483: <em class="replaceable"><code>pkg</code></em> is added.
5484: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5485: packages for which dependencies are added by
5486: buildlink3.</p>
5487: <p>The second section advises pkgsrc that the
5488: <code class="filename">buildlink3.mk</code> file for
5489: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5490: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5491: packages for which <code class="filename">buildlink3.mk</code> files
5492: have been included. It must <span class="emphasis"><em>always</em></span> be
5493: appended to within a <code class="filename">buildlink3.mk</code>
5494: file.</p>
5495: <p>The third section is protected from multiple inclusion
5496: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5497: added. Several important variables are set in the section:</p>
5498: <div class="itemizedlist"><ul type="disc">
5499: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5500: is the actual dependency recorded in the installed
5501: package; this should always be set using
5502: <span><strong class="command">+=</strong></span> to ensure that
5503: we're appending to any pre-existing list of values. This
5504: variable should be set to the first version of the
5505: package that had an API change.
5506: </p></li>
5507: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5508: is the location of the <em class="replaceable"><code>pkg</code></em>
5509: pkgsrc directory.</p></li>
5510: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5511: (not shown above) controls whether we use
5512: <code class="varname">BUILD_DEPENDS</code> or
5513: <code class="varname">DEPENDS</code> to add the dependency on
5514: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5515: selected by setting
5516: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5517: to “<span class="quote">build</span>”. By default, the full dependency is
5518: used.</p></li>
5519: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5520: and
5521: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5522: (not shown above) are lists of subdirectories of
1.76 rillig 5523: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5524: to add to the header and library search paths. These
5525: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5526: respectively.</p></li>
5527: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5528: (not shown above) is the list of preprocessor flags to add
5529: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5530: configure and build phases. The “<span class="quote">-I</span>” option
5531: should be avoided and instead be handled using
5532: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5533: above.</p></li>
1.75 rillig 5534: </ul></div>
1.87 wiz 5535: <p>The following variables are all optionally defined within
5536: this second section (protected against multiple inclusion) and
5537: control which package files are symlinked into
5538: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5539: transformed during the symlinking:</p>
1.75 rillig 5540: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5541: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5542: (not shown above) is a shell glob pattern relative to
1.76 rillig 5543: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5544: to be symlinked into
1.76 rillig 5545: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5546: e.g. <code class="filename">include/*.h</code>.</p></li>
5547: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5548: (not shown above) is a shell pipeline that
5549: outputs to stdout a list of files relative to
5550: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5551: The resulting files are to be symlinked
5552: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5553: this takes the <code class="filename">+CONTENTS</code> of a
5554: <em class="replaceable"><code>pkg</code></em> and filters it through
5555: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5556: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5557: (not shown above) is a filter command that filters
1.76 rillig 5558: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5559: relative to
1.76 rillig 5560: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5561: on stdout. By default for overwrite packages,
5562: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5563: outputs the contents of the <code class="filename">include</code>
5564: and <code class="filename">lib</code> directories in the package
5565: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5566: it outputs any libtool archives in
1.87 wiz 5567: <code class="filename">lib</code> directories.</p></li>
5568: <li><p><code class="varname">BUILDLINK_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5569: (not shown above) is a list of sed arguments used to
5570: transform the name of the source filename into a
5571: destination filename, e.g. <span><strong class="command">-e
1.87 wiz 5572: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5573: </ul></div>
1.87 wiz 5574: <p>The last section includes any
5575: <code class="filename">buildlink3.mk</code> needed for
5576: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5577: Including these <code class="filename">buildlink3.mk</code> files
5578: means that the headers and libraries for these
5579: dependencies are also symlinked into
5580: <code class="filename">${BUILDLINK_DIR}</code>
5581: whenever the <em class="replaceable"><code>pkg</code></em>
5582: <code class="filename">buildlink3.mk</code>
5583: file is included.</p>
1.75 rillig 5584: </div>
5585: <div class="sect2" lang="en">
5586: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5587: <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 5588: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5589: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5590: after a package update is when the API or interface to the
1.87 wiz 5591: header files change.</p>
5592: <p>In this case,
5593: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5594: should be adjusted to require at least the new package
5595: version. In some cases, the packages that depend on this new
5596: version may need their <code class="varname">PKGREVISION</code>s
5597: increased and, if they have <code class="filename">buildlink3.mk</code>
5598: files, their
5599: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5600: adjusted, too. This is needed so pkgsrc will require the
5601: correct package dependency and not settle for an older one
5602: when building the source.</p>
5603: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5604: should be increased when the binary interface or sonames
5605: (major number of the library version) of any installed
5606: shared libraries change. This is needed so that binary
5607: packages made using it will require the correct package
5608: dependency and not settle for an older one which will not
1.87 wiz 5609: contain the necessary shared libraries.</p>
1.90 rillig 5610: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, “Handling dependencies”</a> for
1.75 rillig 5611: more information about dependencies on other packages,
5612: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5613: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5614: <p>Please take careful consideration before adjusting
5615: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5616: or
5617: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5618: as we don't want to cause unneeded package deletions and
5619: rebuilds. In many cases, new versions of packages work just
5620: fine with older dependencies.</p>
5621: <p>Also it is not needed to set
1.75 rillig 5622: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5623: when it is identical to
1.87 wiz 5624: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5625: </div>
5626: </div>
5627: <div class="sect1" lang="en">
5628: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5629: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5630: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5631: coincide with headers and libraries present in the base system.
1.76 rillig 5632: Aside from a <code class="filename">buildlink3.mk</code> file, these
5633: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5634: file that includes the necessary checks to decide whether using
5635: the built-in software or the pkgsrc software is
1.87 wiz 5636: appropriate.</p>
5637: <p>The only requirements of a builtin.mk file for
5638: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5639: <div class="orderedlist"><ol type="1">
1.87 wiz 5640: <li><p>It should set
5641: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5642: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5643: after it is included.</p></li>
5644: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5645: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5646: which is already set before the
5647: <code class="filename">builtin.mk</code> file is included.</p></li>
5648: <li><p>It should be written to allow multiple inclusion. This
5649: is <span class="emphasis"><em>very</em></span> important and takes careful
5650: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5651: </ol></div>
5652: <div class="sect2" lang="en">
5653: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5654: <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 5655: <p>The following is the recommended template for builtin.mk
1.87 wiz 5656: files:</p>
1.75 rillig 5657: <pre class="programlisting">
1.87 wiz 5658: .if !defined(IS_BUILTIN.foo)
5659: #
5660: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5661: # genuinely exists in the system or not.
5662: #
5663: IS_BUILTIN.foo?= no
5664:
5665: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5666: # version can be determined.
5667: #
5668: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5669: BUILTIN_PKG.foo?= foo-1.0
5670: . endif
5671: .endif # IS_BUILTIN.foo
5672:
5673: .if !defined(USE_BUILTIN.foo)
5674: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5675: . if defined(BUILTIN_PKG.foo)
5676: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5677: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5678: USE_BUILTIN.foo!= \
5679: if ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}; then \
5680: ${ECHO} "yes"; \
5681: else \
5682: ${ECHO} "no"; \
5683: fi
5684: . endif
5685: . endfor
5686: . endif
5687: .endif # USE_BUILTIN.foo
5688:
5689: CHECK_BUILTIN.foo?= no
5690: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5691: #
5692: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5693: # "yes" or "no".
5694: #
5695: .endif # CHECK_BUILTIN.foo
5696: </pre>
5697: <p>The first section sets
5698: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5699: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5700: in the base system. This should not be a base system software
5701: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5702: it should only be “<span class="quote">yes</span>” if the actual package is
5703: included as part of the base system. This variable is only
5704: used internally within the <code class="filename">builtin.mk</code>
5705: file.</p>
5706: <p>The second section sets
5707: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5708: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5709: system if it exists (if
5710: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5711: is “<span class="quote">yes</span>”). This variable is only used internally
5712: within the <code class="filename">builtin.mk</code> file.</p>
5713: <p>The third section sets
5714: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5715: and is <span class="emphasis"><em>required</em></span> in all
5716: <code class="filename">builtin.mk</code> files. The code in this
5717: section must make the determination whether the built-in
5718: software is adequate to satisfy the dependencies listed in
5719: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5720: This is typically done by comparing
5721: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5722: against each of the dependencies in
5723: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5724: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5725: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5726: end of the <code class="filename">builtin.mk</code> file. Note that
5727: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5728: may be “<span class="quote">yes</span>” even if
5729: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5730: is “<span class="quote">no</span>” because we may make the determination
5731: that the built-in version of the software is similar enough to
5732: be used as a replacement.</p>
5733: <p>The last section is guarded by
5734: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5735: and includes code that uses the value of
5736: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5737: set in the previous section. This typically includes, e.g.,
5738: adding additional dependency restrictions and listing additional
5739: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5740: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5741: </div>
5742: <div class="sect2" lang="en">
5743: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5744: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5745: <p>When building packages, it's possible to choose whether to set
5746: a global preference for using either the built-in (native)
5747: version or the pkgsrc version of software to satisfy a
5748: dependency. This is controlled by setting
5749: <code class="varname">PREFER_PKGSRC</code> and
5750: <code class="varname">PREFER_NATIVE</code>. These variables take values
5751: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5752: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5753: use the pkgsrc versions of software, while
5754: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5755: built-in versions. Preferences are determined by the most
5756: specific instance of the package in either
5757: <code class="varname">PREFER_PKGSRC</code> or
5758: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5759: in neither or in both variables, then
5760: <code class="varname">PREFER_PKGSRC</code> has precedence over
5761: <code class="varname">PREFER_NATIVE</code>. For example, to require
5762: using pkgsrc versions of software for all but the most basic
5763: bits on a NetBSD system, you can set:</p>
5764: <pre class="programlisting">
5765: PREFER_PKGSRC= yes
5766: PREFER_NATIVE= getopt skey tcp_wrappers
5767: </pre>
5768: <p>A package <span class="emphasis"><em>must</em></span> have a
5769: <code class="filename">builtin.mk</code>
5770: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5771: otherwise it is simply ignored in that list.</p>
1.75 rillig 5772: </div>
5773: </div>
5774: </div>
5775: <div class="chapter" lang="en">
5776: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5777: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75 rillig 5778: <div class="toc">
5779: <p><b>Table of Contents</b></p>
5780: <dl>
1.90 rillig 5781: <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 5782: <dd><dl>
1.90 rillig 5783: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
5784: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75 rillig 5785: </dl></dd>
1.90 rillig 5786: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75 rillig 5787: <dd><dl>
1.90 rillig 5788: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5789: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
5790: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
5791: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
5792: </dl></dd>
5793: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
5794: <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>
5795: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
5796: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
5797: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
5798: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
5799: <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 5800: </dl>
5801: </div>
5802: <p>This chapter describes the framework known as
5803: <code class="literal">pkginstall</code>, whose key features are:</p>
5804: <div class="itemizedlist"><ul type="disc">
5805: <li><p>Generic installation and manipulation of directories and files
5806: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5807: <li><p>Automatic handling of configuration files during installation,
5808: provided that packages are correctly designed.</p></li>
5809: <li><p>Generation and installation of system startup scripts.</p></li>
5810: <li><p>Registration of system users and groups.</p></li>
5811: <li><p>Registration of system shells.</p></li>
5812: <li><p>Automatic updating of fonts databases.</p></li>
5813: </ul></div>
5814: <p>The following sections inspect each of the above points in detail.</p>
5815: <p>You may be thinking that many of the things described here could be
5816: easily done with simple code in the package's post-installation target
5817: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5818: as the code in them is only executed when building from source. Machines
5819: using binary packages could not benefit from it at all (as the code itself
5820: could be unavailable). Therefore, the only way to achieve any of the items
5821: described above is by means of the installation scripts, which are
5822: automatically generated by pkginstall.</p>
5823: <div class="sect1" lang="en">
5824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5825: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5826: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5827: of files and directories that belong to a package. The names used in it
1.76 rillig 5828: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5829: which means that it cannot register files outside this directory (absolute
5830: path names are not allowed). Despite this restriction, some packages need
5831: to install files outside this location; e.g., under
1.76 rillig 5832: <code class="filename">${VARBASE}</code> or
1.87 wiz 5833: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5834: is to create such files during installation time by using
5835: installation scripts.</p>
5836: <p>The generic installation scripts are shell scripts that can
5837: contain arbitrary code. The list of scripts to execute is taken from
5838: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5839: <code class="filename">INSTALL</code>. A similar variable exists for package
5840: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5841: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5842: commands, so they have the potential to create and manage files
5843: anywhere in the file system.</p>
5844: <p>Using these general installation files is not recommended, but
5845: may be needed in some special cases. One reason for avoiding them is
5846: that the user has to trust the packager that there is no unwanted or
5847: simply erroneous code included in the installation script. Also,
5848: previously there were many similar scripts for the same functionality,
5849: and fixing a common error involved finding and changing all of
5850: them.</p>
5851: <p>The pkginstall framework offers another, standardized way. It
5852: provides generic scripts to abstract the manipulation of such files
5853: and directories based on variables set in the package's
5854: <code class="filename">Makefile</code>. The rest of this section describes
5855: these variables.</p>
1.75 rillig 5856: <div class="sect2" lang="en">
5857: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5858: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5859: <p>The following variables can be set to request the creation of
5860: directories anywhere in the file system:</p>
5861: <div class="itemizedlist"><ul type="disc">
5862: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5863: contain a list of directories that should be created and should attempt
5864: to be destroyed by the installation scripts. The difference between
5865: the two is that the latter prompts the administrator to remove any
5866: directories that may be left after deinstallation (because they were
5867: not empty), while the former does not.</p></li>
5868: <li>
5869: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5870: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5871: which directories should be created and should attempt to be destroyed
5872: by the installation scripts. Each tuple holds the following values,
5873: separated by spaces: the directory name, its owner, its group and its
5874: numerical mode. For example:</p>
5875: <pre class="programlisting">
5876: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5877: </pre>
1.75 rillig 5878: <p>The difference between the two is exactly the same as their
5879: non-<code class="varname">PERMS</code> counterparts.</p>
5880: </li>
5881: </ul></div>
5882: </div>
5883: <div class="sect2" lang="en">
5884: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5885: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5886: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5887: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5888: To overcome this problem, the only solution is to extract the file in the
5889: known place (i.e., inside the installation prefix) and copy it to the
5890: appropriate location during installation (done by the installation scripts
5891: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5892: file</em></span> in the following paragraphs, which describe the variables
5893: that can be used to automatically and consistently handle files outside the
5894: installation prefix:</p>
5895: <div class="itemizedlist"><ul type="disc">
5896: <li>
5897: <p><code class="varname">CONF_FILES</code> and
5898: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5899: During installation time, the master file is copied to the target one
5900: if and only if the latter does not exist. Upon deinstallation, the
5901: target file is removed provided that it was not modified by the
5902: installation.</p>
5903: <p>The difference between the two is that the latter prompts the
5904: administrator to remove any files that may be left after
5905: deinstallation (because they were not empty), while the former does
5906: not.</p>
5907: </li>
5908: <li>
5909: <p><code class="varname">CONF_FILES_PERMS</code> and
5910: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5911: files as well as their target locations. For each of them, it also
5912: specifies their owner, their group and their numeric permissions, in
5913: this order. For example:</p>
5914: <pre class="programlisting">
5915: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5916: </pre>
1.75 rillig 5917: <p>The difference between the two is exactly the same as their
5918: non-<code class="varname">PERMS</code> counterparts.</p>
5919: </li>
5920: </ul></div>
5921: </div>
5922: </div>
5923: <div class="sect1" lang="en">
5924: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5925: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75 rillig 5926: <p>Configuration files are special in the sense that they are installed
5927: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5928: need special treatment during installation (most of which is automated by
5929: pkginstall). The main concept you must bear in mind is that files marked
5930: as configuration files are automatically copied to the right place (somewhere
5931: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5932: and only if</em></span> they didn't exist before. Similarly, they will not
5933: be removed if they have local modifications. This ensures that
5934: administrators never lose any custom changes they may have made.</p>
5935: <div class="sect2" lang="en">
5936: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5937: <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 5938: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5939: specifies where configuration files shall be installed. Its contents are
5940: set based upon the following variables:</p>
5941: <div class="itemizedlist"><ul type="disc">
5942: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5943: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5944: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5945: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5946: Packages must not use it directly.</p></li>
5947: <li>
5948: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5949: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5950: for the package being built shall be installed. The definition of this
5951: variable only makes sense in the package's
1.76 rillig 5952: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5953: <p>As an example, consider the Apache package,
1.91 rillig 5954: <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 5955: configuration files under the
1.76 rillig 5956: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5957: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5958: Makefile.</p>
5959: </li>
5960: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5961: variable that holds this package's configuration directory (if
5962: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5963: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5964: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5965: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5966: directory where the configuration files for the package identified by
5967: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5968: </ul></div>
5969: <p>Based on the above variables, pkginstall determines the value of
5970: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5971: variable that can be used within a package to refer to its configuration
5972: directory. The algorithm used to set its value is basically the
5973: following:</p>
5974: <div class="orderedlist"><ol type="1">
5975: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
5976: its value is used.</p></li>
5977: <li><p>If the previous variable is not defined but
5978: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5979: <code class="filename">Makefile</code>, the resulting value is
5980: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 5981: <li><p>Otherwise, it is set to
1.76 rillig 5982: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5983: </ol></div>
1.76 rillig 5984: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90 rillig 5985: 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 5986: </div>
5987: <div class="sect2" lang="en">
5988: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5989: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5990: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5991: known place, you need to teach each package where it shall install its
5992: files. In some cases you will have to patch the package Makefiles to
5993: achieve it. If you are lucky, though, it may be as easy as passing an
5994: extra flag to the configuration script; this is the case of GNU Autoconf-
5995: generated files:</p>
5996: <pre class="programlisting">
5997: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5998: </pre>
1.75 rillig 5999: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6000: for</em></span> its configuration files, not where they will be originally
6001: installed (although the difference is never explicit,
6002: unfortunately).</p>
6003: </div>
6004: <div class="sect2" lang="en">
6005: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6006: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6007: <p>As said before, pkginstall automatically handles configuration files.
6008: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6009: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6010: directly</strong></span>. Bad news is that many software installation scripts
6011: will, out of the box, mess with the contents of that directory. So what is
6012: the correct procedure to fix this issue?</p>
6013: <p>You must teach the package (usually by manually patching it) to
6014: install any configuration files under the examples hierarchy,
1.76 rillig 6015: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6016: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6017: has the original copies available.</p>
6018: <p>Once the required configuration files are in place (i.e., under the
6019: examples hierarchy), the pkginstall framework can use them as master copies
6020: during the package installation to update what is in
1.76 rillig 6021: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6022: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90 rillig 6023: 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 6024: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6025: <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 6026: <pre class="programlisting">
6027: EGDIR= ${PREFIX}/share/doc/mutt/samples
6028: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6029: </pre>
1.75 rillig 6030: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6031: package and has no meaning outside it.</p>
6032: </div>
6033: <div class="sect2" lang="en">
6034: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6035: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6036: <p>The automatic copying of config files can be toggled by setting the
6037: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6038: installation.</p>
6039: </div>
6040: </div>
6041: <div class="sect1" lang="en">
6042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6043: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75 rillig 6044: <p>System startup scripts are special files because they must be
6045: installed in a place known by the underlying OS, usually outside the
1.90 rillig 6046: 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 6047: can be used. However, pkginstall provides a special mechanism to handle
6048: these files.</p>
6049: <p>In order to provide system startup scripts, the package has
6050: to:</p>
6051: <div class="orderedlist"><ol type="1">
1.76 rillig 6052: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6053: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6054: <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 6055: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6056: <li>
6057: <p>Tell pkginstall to handle it, appending the name of the script,
6058: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6059: Continuing the previous example:</p>
6060: <pre class="programlisting">
6061: RCD_SCRIPTS+= cupsd
1.1 grant 6062: </pre>
1.75 rillig 6063: </li>
6064: </ol></div>
6065: <p>Once this is done, pkginstall will do the following steps for each
6066: script in an automated fashion:</p>
6067: <div class="orderedlist"><ol type="1">
6068: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6069: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6070: variable.</p></li>
6071: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6072: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6073: that this master file must be explicitly registered in the
1.76 rillig 6074: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6075: <li><p>Add code to the installation scripts to copy the startup script
6076: from the examples hierarchy into the system-wide startup scripts
6077: directory.</p></li>
6078: </ol></div>
6079: <div class="sect2" lang="en">
6080: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6081: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6082: <p>The automatic copying of config files can be toggled by setting the
6083: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6084: installation. Note that the scripts will be always copied inside the
1.76 rillig 6085: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6086: matter what the value of this variable is.</p>
6087: </div>
6088: </div>
6089: <div class="sect1" lang="en">
6090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6091: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75 rillig 6092: <p>If a package needs to create special users and/or groups during
6093: installation, it can do so by using the pkginstall framework.</p>
6094: <p>Users can be created by adding entries to the
6095: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6096: syntax:</p>
6097: <pre class="programlisting">
6098: user:group
1.1 grant 6099: </pre>
1.87 wiz 6100: <p>Further specification of user details may be done by setting
6101: per-user variables.
6102: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6103: numeric UID for the user.
6104: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6105: user's description or comment.
6106: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6107: user's home directory, and defaults to
6108: <code class="filename">/nonexistent</code> if not specified.
6109: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
6110: user's shell, and defaults to <code class="filename">/sbinno/login</code> if
6111: not specified.</p>
1.75 rillig 6112: <p>Similarly, groups can be created by adding entries to the
6113: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6114: <pre class="programlisting">
6115: group
1.1 grant 6116: </pre>
1.93 ! rillig 6117: <p>The numeric GID of the group may be set by defining
1.75 rillig 6118: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6119: <p>If a package needs to create the users and groups at an earlier
6120: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6121: either <code class="literal">configure</code> or <code class="literal">build</code> to
6122: indicate the phase before which the users and groups are created. In
6123: this case, the numeric UIDs and GIDs of the created users and groups
6124: are automatically hardcoded into the final installation scripts.</p>
6125: </div>
6126: <div class="sect1" lang="en">
6127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6128: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75 rillig 6129: <p>Packages that install system shells should register them in the shell
1.76 rillig 6130: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6131: administrator. This must be done from the installation scripts to keep
6132: binary packages working on any system. pkginstall provides an easy way to
6133: accomplish this task.</p>
6134: <p>When a package provides a shell interpreter, it has to set the
6135: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6136: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6137: 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 6138: <pre class="programlisting">
6139: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6140: </pre>
1.75 rillig 6141: <div class="sect2" lang="en">
6142: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6143: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6144: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6145: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6146: environment variable to <code class="literal">NO</code>.</p>
6147: </div>
6148: </div>
6149: <div class="sect1" lang="en">
6150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6151: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75 rillig 6152: <p>Packages that install X11 fonts should update the database files
6153: that index the fonts within each fonts directory. This can easily be
6154: accomplished within the pkginstall framework.</p>
6155: <p>When a package installs X11 fonts, it must list the directories in
6156: which fonts are installed in the
6157: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6158: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6159: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6160: installation scripts to run the appropriate commands to update the fonts
6161: database files within each of those directories. For convenience, if the
6162: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6163: 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 6164: <pre class="programlisting">
6165: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6166: </pre>
1.75 rillig 6167: <div class="sect2" lang="en">
6168: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6169: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6170: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6171: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6172: environment variable to <code class="literal">NO</code>.</p>
6173: </div>
6174: </div>
6175: </div>
6176: <div class="chapter" lang="en">
6177: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6178: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75 rillig 6179: <div class="toc">
6180: <p><b>Table of Contents</b></p>
6181: <dl>
1.90 rillig 6182: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
6183: <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>
6184: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75 rillig 6185: </dl>
6186: </div>
6187: <p>Many packages have the ability to be built to support different
1.76 rillig 6188: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6189: in pkgsrc that provides generic handling of those options that
6190: determine different ways in which the packages can be built. It's
6191: possible for the user to specify exactly which sets of options will be
6192: built into a package or to allow a set of global default options
6193: apply.</p>
6194: <div class="sect1" lang="en">
6195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6196: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75 rillig 6197: <p>Global default options are listed in
6198: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6199: that should be built into every package if that option is supported.
1.76 rillig 6200: This variable should be set in <code class="filename">/etc/mk.conf</code>.</p>
1.75 rillig 6201: </div>
6202: <div class="sect1" lang="en">
6203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 ! rillig 6204: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code>
! 6205: </h2></div></div></div>
1.75 rillig 6206: <p>The following example shows how
1.76 rillig 6207: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6208: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6209: <code class="filename">Makefile</code>, or in a file,
6210: e.g. <code class="filename">options.mk</code>, that is included by the
6211: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6212: <pre class="programlisting">
6213: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6214: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6215: PKG_OPTIONS_OPTIONAL_GROUPS= database
6216: PKG_OPTIONS_GROUP.database= mysql pgsql
6217: PKG_SUGGESTED_OPTIONS= wibble-foo
6218: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6219: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
1.1 grant 6220:
1.75 rillig 6221: .include "../../mk/bsd.prefs.mk"
1.69 rillig 6222:
1.75 rillig 6223: # this package was previously named wibble2
6224: .if defined(PKG_OPTIONS.wibble2)
6225: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6226: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
1.78 rillig 6227: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
1.75 rillig 6228: .endif
1.69 rillig 6229:
1.75 rillig 6230: .include "../../mk/bsd.options.mk"
1.69 rillig 6231:
1.75 rillig 6232: # Package-specific option-handling
1.69 rillig 6233:
1.75 rillig 6234: ###
6235: ### FOO support
6236: ###
6237: .if !empty(PKG_OPTIONS:Mwibble-foo)
6238: CONFIGURE_ARGS+= --enable-foo
6239: .endif
1.69 rillig 6240:
1.75 rillig 6241: ###
6242: ### LDAP support
6243: ###
6244: .if !empty(PKG_OPTIONS:Mldap)
1.77 rillig 6245: . include "../../databases/openldap-client/buildlink3.mk"
6246: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
1.75 rillig 6247: .endif
1.69 rillig 6248:
1.75 rillig 6249: ###
6250: ### database support
6251: ###
6252: .if !empty(PKG_OPTIONS:Mmysql)
6253: . include "../../mk/mysql.buildlink3.mk"
6254: .endif
6255: .if !empty(PKG_OPTIONS:Mpgsql)
6256: . include "../../mk/pgsql.buildlink3.mk"
6257: .endif
6258: </pre>
6259: <p>The first section contains the information about which build
6260: options are supported by the package, and any default options settings
6261: if needed.</p>
6262: <div class="orderedlist"><ol type="1">
6263: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6264: <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
6265: options. It should be set to
1.78 rillig 6266: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6267: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6268: at the point where the options are processed.</p></li>
1.75 rillig 6269: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6270: build options supported by the package.</p></li>
6271: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6272: list of names of groups of mutually exclusive options. The options in
6273: each group are listed in
6274: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6275: The most specific setting of any option from the group takes
6276: precedence over all other options in the group. Options from the
6277: groups will be automatically added to
6278: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6279: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6280: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6281: packages will fail if no option from the group is
6282: selected.</p></li>
6283: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6284: of names of sets of options. At least one option from each set must
6285: be selected. The options in each set are listed in
6286: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6287: Options from the sets will be automatically added to
6288: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6289: fail if no option from the set is selected.</p></li>
6290: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6291: build options which are enabled by default.</p></li>
6292: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6293: of
6294: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.76 rillig 6295: pairs that map legacy <code class="filename">/etc/mk.conf</code> variables to
1.75 rillig 6296: their option counterparts. Pairs should be added with
6297: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6298: warning will be issued if the user uses a legacy
6299: variable.</p></li>
6300: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6301: of
6302: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6303: pairs that map options that have been renamed to their new
6304: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6305: the listing of global legacy options. A warning will be issued if
6306: the user uses a legacy option.</p></li>
6307: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6308: options implied by deprecated variables used. This can be used for
6309: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6310: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6311: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6312: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6313: a list of warnings about deprecated variables or options used, and
6314: what to use instead.</p></li>
6315: </ol></div>
6316: <p>A package should never modify
6317: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6318: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6319: To suggest a default set of options, use
6320: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6321: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6322: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6323: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6324: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6325: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6326: happen with platform-specific options if none of them is supported on
6327: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6328: empty list and the package is otherwise treated as not using the
6329: options framework.</p>
1.76 rillig 6330: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6331: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6332: build options, properly filtered to remove unsupported and duplicate
6333: options.</p>
6334: <p>The remaining sections contain the logic that is specific to
6335: each option. The correct way to check for an option is to check
6336: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6337: <pre class="programlisting">
6338: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6339: </pre>
6340: </div>
6341: <div class="sect1" lang="en">
6342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6343: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75 rillig 6344: <p>Options that enable similar features in different packages (like
6345: optional support for a library) should use a common name in all
6346: packages that support it (like the name of the library). If another
6347: package already has an option with the same meaning, use the same
6348: name.</p>
6349: <p>Options that enable features specific to one package, where it's
6350: unlikely that another (unrelated) package has the same (or a similar)
6351: optional feature, should use a name prefixed with
6352: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6353: <p>If a group of related packages share an optional feature
6354: specific to that group, prefix it with the name of the
6355: “<span class="quote">main</span>” package
6356: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6357: <p>For new options, add a line to
1.76 rillig 6358: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6359: fields, separated by tab. The first field is the option name, the
6360: second its description. The description should be a whole sentence
6361: (starting with an uppercase letter and ending with a period) that
6362: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6363: support.</span>” The file is sorted by option names.</p>
6364: </div>
6365: </div>
6366: <div class="chapter" lang="en">
6367: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6368: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75 rillig 6369: <div class="toc">
6370: <p><b>Table of Contents</b></p>
6371: <dl>
1.90 rillig 6372: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
6373: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
6374: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
6375: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
6376: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6377: <dd><dl>
6378: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
6379: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
6380: </dl></dd>
6381: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6382: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6383: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6384: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6385: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6386: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6387: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6388: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6389: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6390: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6391: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
6392: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75 rillig 6393: </dl>
6394: </div>
6395: <div class="sect1" lang="en">
6396: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6397: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75 rillig 6398: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6399: built. Building a package is separated into different
6400: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6401: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6402: described in the following sections. Each phase is splitted into
6403: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6404: containing phase, prefixed by one of <code class="varname">pre-</code>,
6405: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6406: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6407: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.75 rillig 6408: <p>The basic steps for building a program are always the same. First
1.87 wiz 6409: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6410: the local system and then extracted. After any pkgsrc-specific patches
6411: to compile properly are applied, the software can be configured, then
6412: built (usually by compiling), and finally the generated binaries, etc.
6413: can be put into place on the system.</p>
1.75 rillig 6414: </div>
6415: <div class="sect1" lang="en">
6416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6417: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75 rillig 6418: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6419: the next section, here's a brief discussion on where programs are
6420: installed, and which variables influence this.</p>
1.75 rillig 6421: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6422: where all files of the final program shall be installed. It is
6423: usually set to <code class="varname">LOCALBASE</code>
6424: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6425: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6426: <code class="varname">PREFIX</code> needs to be put
6427: into the various places in the program's source where paths to
1.90 rillig 6428: 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 6429: <p>When choosing which of these variables to use,
1.87 wiz 6430: follow the following rules:</p>
1.75 rillig 6431: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6432: <li><p><code class="varname">PREFIX</code> always points to the location
6433: where the current pkg will be installed. When referring to a
6434: pkg's own installation path, use
6435: “<span class="quote">${PREFIX}</span>”.</p></li>
6436: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6437: are installed. If you need to construct a -I or -L argument
6438: to the compiler to find includes and libraries installed by
6439: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6440: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6441: installed all packages in <code class="filename">/usr/local</code>. As
6442: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6443: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6444: <li><p><code class="varname">X11BASE</code> is where the actual X11
6445: distribution (from xsrc, etc.) is installed. When looking for
6446: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6447: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6448: <li>
6449: <p>X11-based packages are special in that they may be
6450: installed in either <code class="varname">X11BASE</code> or
6451: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6452: <p>Usually, X11 packages should be installed under
1.88 wiz 6453: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6454: will need to include
6455: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6456: request the presence of X11 and to get the right compilation
6457: flags.</p>
1.75 rillig 6458: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6459: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6460: files. These packages are special and they must be placed under
6461: <code class="varname">X11BASE</code>. To accomplish this, set either
6462: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6463: your package.</p>
1.75 rillig 6464: <p>Some notes: If you need
1.87 wiz 6465: to find includes or libraries installed by a pkg that has
6466: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6467: its pkg <code class="filename">Makefile</code>, you need to look in
6468: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6469: <code class="filename">${LOCALBASE}</code>. To force installation of
6470: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6471: <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 6472: is enabled by default.</p>
1.75 rillig 6473: </li>
1.88 wiz 6474: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6475: the installed location of an X11
6476: package. <code class="varname">X11PREFIX</code> will be set to
6477: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6478: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6479: installed.</p></li>
6480: <li>
6481: <p>If xpkgwedge is installed, it is possible to have some
6482: packages installed in <code class="varname">X11BASE</code> and some in
6483: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6484: installed package, the <code class="varname">EVAL_PREFIX</code>
6485: definition can be used. It takes pairs in the format
6486: “<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>
6487: variable <code class="varname">DIRNAME</code> will be set to the prefix
6488: of the installed package <package>, or
6489: “<span class="quote">${X11PREFIX}</span>” if the package is not
6490: installed.</p>
1.75 rillig 6491: <p>This is best illustrated by example.</p>
6492: <p>The following lines are taken from
1.87 wiz 6493: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6494: <pre class="programlisting">
1.87 wiz 6495: EVAL_PREFIX+= GTKDIR=gtk+
6496: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6497: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6498: CONFIGURE_ARGS+= --enable-multibyte
6499: </pre>
1.88 wiz 6500: <p>Specific defaults can be defined for the packages
6501: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6502: definition of the form:</p>
1.75 rillig 6503: <pre class="programlisting">
1.87 wiz 6504: GTKDIR_DEFAULT= ${LOCALBASE}
6505: </pre>
1.75 rillig 6506: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6507: to the first definition in
6508: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6509: </li>
1.76 rillig 6510: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87 wiz 6511: 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
6512: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6513: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6514: </ul></div>
6515: </div>
6516: <div class="sect1" lang="en">
6517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6518: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75 rillig 6519: <p>When building a package, a number of directories is used to store
1.87 wiz 6520: source files, temporary files, pkgsrc-internal files, and so on. These
6521: directories are explained here.</p>
1.75 rillig 6522: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6523: are two common base directories for these relative directories:
6524: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6525: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6526: inside the package itself.</p>
1.75 rillig 6527: <div class="variablelist"><dl>
6528: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6529: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6530: root directory. Generally, you don't need
6531: it.</p></dd>
1.75 rillig 6532: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6533: <dd><p>This is a pathname relative to
1.87 wiz 6534: <code class="varname">PKGSRCDIR</code> that points to the current
6535: package.</p></dd>
1.75 rillig 6536: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6537: <dd><p>This is an absolute pathname pointing to the directory
1.93 ! rillig 6538: where all work takes place. The distfiles are extracted to this
1.87 wiz 6539: directory. It also contains temporary directories and log files used by
6540: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6541: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6542: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6543: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6544: where the distfiles are extracted. It is usually a direct subdirectory
6545: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6546: that isn't hidden. This variable may be changed by a package
6547: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6548: </dl></div>
6549: </div>
6550: <div class="sect1" lang="en">
6551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6552: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75 rillig 6553: <p>You can run a particular phase by typing <span><strong class="command">make
1.87 wiz 6554: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6555: phase. This will automatically run all phases that are required for this
6556: phase. The default phase is <code class="varname">build</code>, that is, when you
6557: run <span><strong class="command">make</strong></span> without parameters in a package directory,
6558: the package will be built, but not installed.</p>
1.75 rillig 6559: </div>
6560: <div class="sect1" lang="en">
6561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6562: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6563: <p>The first step in building a package is to fetch the
1.88 wiz 6564: distribution files (distfiles) from the sites that are providing
6565: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6566: phase.</p>
1.81 rillig 6567: <div class="sect2" lang="en">
6568: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6569: <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 6570: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6571: defines all URLs from where the distfile, whose name is
6572: derived from the <code class="varname">DISTNAME</code> variable, is
6573: fetched. The more complicated cases are described
6574: below.</p>
6575: <p>The variable <code class="varname">DISTFILES</code> specifies
6576: the list of distfiles that have to be fetched. Its value
6577: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6578: so that most packages don't need to define it at all.
6579: <code class="varname">EXTRACT_SUFX</code> is
6580: <code class="literal">.tar.gz</code> by default, but can be changed
6581: freely. Note that if your package requires additional
6582: distfiles to the default one, you cannot just append the
6583: additional filenames using the <code class="literal">+=</code>
6584: operator, but you have write for example:</p>
1.81 rillig 6585: <pre class="programlisting">
1.88 wiz 6586: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6587: </pre>
6588: <p>Each distfile is fetched from a list of sites, usually
6589: <code class="varname">MASTER_SITES</code>. If the package has multiple
6590: <code class="varname">DISTFILES</code> or multiple
6591: <code class="varname">PATCHFILES</code> from different sites, you can
6592: set
6593: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6594: to the list of URLs where the file
6595: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6596: (including the suffix) can be found.</p>
6597: <pre class="programlisting">
6598: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6599: DISTFILES+= foo-file.tar.gz
6600: SITES.foo-file.tar.gz= \
6601: http://www.somewhere.com/somehow/ \
6602: http://www.somewhereelse.com/mirror/somehow/
6603: </pre>
1.81 rillig 6604: <p>When actually fetching the distfiles, each item from
1.88 wiz 6605: <code class="varname">MASTER_SITES</code> or
6606: <code class="varname">SITES.*</code> gets the name of each distfile
6607: appended to it, without an intermediate slash. Therefore,
6608: all site values have to end with a slash or other separator
6609: character. This allows for example to set
6610: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6611: that gets the name of the distfile as a parameter. In this
6612: case, the definition would look like:</p>
1.81 rillig 6613: <pre class="programlisting">
1.88 wiz 6614: MASTER_SITES= http://www.example.com/download.cgi?file=
6615: </pre>
1.81 rillig 6616: <p>There are some predefined values for
1.88 wiz 6617: <code class="varname">MASTER_SITES</code>, which can be used in
6618: packages. The names of the variables should speak for
6619: themselves.</p>
6620: <pre class="programlisting">
6621: ${MASTER_SITE_APACHE}
6622: ${MASTER_SITE_BACKUP}
6623: ${MASTER_SITE_CYGWIN}
6624: ${MASTER_SITE_DEBIAN}
6625: ${MASTER_SITE_FREEBSD}
6626: ${MASTER_SITE_FREEBSD_LOCAL}
1.93 ! rillig 6627: ${MASTER_SITE_GENTOO}
1.88 wiz 6628: ${MASTER_SITE_GNOME}
6629: ${MASTER_SITE_GNU}
6630: ${MASTER_SITE_GNUSTEP}
6631: ${MASTER_SITE_IFARCHIVE}
6632: ${MASTER_SITE_KDE}
6633: ${MASTER_SITE_MOZILLA}
6634: ${MASTER_SITE_MYSQL}
6635: ${MASTER_SITE_OPENOFFICE}
6636: ${MASTER_SITE_PERL_CPAN}
6637: ${MASTER_SITE_PGSQL}
6638: ${MASTER_SITE_R_CRAN}
6639: ${MASTER_SITE_SOURCEFORGE}
6640: ${MASTER_SITE_SOURCEFORGE_JP}
6641: ${MASTER_SITE_SUNSITE}
6642: ${MASTER_SITE_SUSE}
6643: ${MASTER_SITE_TEX_CTAN}
6644: ${MASTER_SITE_XCONTRIB}
6645: ${MASTER_SITE_XEMACS}
6646: </pre>
6647: <p>Some explanations for the less self-explaining ones:
6648: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.93 ! rillig 6649: 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
! 6650: 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 6651: <p>If you choose one of these predefined sites, you may
6652: want to specify a subdirectory of that site. Since these
6653: macros may expand to more than one actual site, you
6654: <span class="emphasis"><em>must</em></span> use the following construct to
6655: specify a subdirectory:</p>
1.81 rillig 6656: <pre class="programlisting">
1.88 wiz 6657: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6658: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6659: </pre>
1.81 rillig 6660: <p>Note the trailing slash after the subdirectory
1.88 wiz 6661: name.</p>
1.81 rillig 6662: </div>
6663: <div class="sect2" lang="en">
6664: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6665: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6666: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6667: all the distfiles exist in a local directory
1.93 ! rillig 6668: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6669: user). If the files do not exist, they are fetched using
6670: commands of the form</p>
1.75 rillig 6671: <pre class="programlisting">
1.88 wiz 6672: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6673: </pre>
6674: <p>where <code class="literal">${site}</code> varies through
6675: several possibilities in turn: first,
6676: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6677: sites specified in either <code class="varname">SITES.file</code> if
6678: defined, else <code class="varname">MASTER_SITES</code> or
6679: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6680: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6681: all except the first and the last can be optionally sorted
6682: by the user, via setting either
6683: <code class="varname">MASTER_SORT_RANDOM</code>, and
6684: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6685: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.81 rillig 6686: </div>
1.75 rillig 6687: </div>
6688: <div class="sect1" lang="en">
6689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6690: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6691: <p>After the distfile(s) are fetched, their checksum is
6692: generated and compared with the checksums stored in the
6693: distinfo file. If the checksums don't match, the build is
6694: aborted. This is to ensure the same distfile is used for
6695: building, and that the distfile wasn't changed, e.g. by some
6696: malign force, deliberately changed distfiles on the master
6697: distribution site or network lossage.</p>
1.75 rillig 6698: </div>
6699: <div class="sect1" lang="en">
6700: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6701: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6702: <p>When the distfiles are present on the local system, they
1.88 wiz 6703: need to be extracted, as they usually come in the form of some
6704: compressed archive format.</p>
1.75 rillig 6705: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6706: extracted. If you only need some of them, you can set the
6707: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6708: files.</p>
6709: <p>Extracting the files is usually done by a little
1.93 ! rillig 6710: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6711: already knows how to extract various archive formats, so most
6712: likely you will not need to change anything here. But if you
6713: need, the following variables may help you:</p>
1.75 rillig 6714: <div class="variablelist"><dl>
6715: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6716: <dd><p>Use these variables to override the default
1.88 wiz 6717: options for an extract command, which are defined in
1.93 ! rillig 6718: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6719: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6720: <dd><p>This variable can be set to
1.93 ! rillig 6721: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
! 6722: default value), <code class="literal">pax</code>, or an
1.88 wiz 6723: absolute pathname pointing to the command with which tar
6724: archives should be
6725: extracted.</p></dd>
1.75 rillig 6726: </dl></div>
1.88 wiz 6727: <p>If the <code class="filename">extract</code> program doesn't
6728: serve your needs, you can also override the
6729: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6730: command used for extracting the files. This command is
6731: executed in the <code class="filename">${WRKSRC}</code>
6732: directory. During execution of this command, the shell
6733: variable <code class="varname">extract_file</code> holds the absolute
6734: pathname of the file that is going to be extracted.</p>
1.75 rillig 6735: <p>And if that still does not suffice, you can override the
1.88 wiz 6736: <code class="varname">do-extract</code> target in the package
6737: Makefile.</p>
1.75 rillig 6738: </div>
6739: <div class="sect1" lang="en">
6740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6741: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6742: <p>After extraction, all the patches named by the
1.88 wiz 6743: <code class="varname">PATCHFILES</code>, those present in the patches
6744: subdirectory of the package as well as in
6745: $LOCALPATCHES/$PKGPATH (e.g.
6746: <code class="filename">/usr/local/patches/graphics/png</code>) are
6747: applied. Patchfiles ending in <code class="filename">.Z</code> or
6748: <code class="filename">.gz</code> are uncompressed before they are
6749: applied, files ending in <code class="filename">.orig</code> or
6750: <code class="filename">.rej</code> are ignored. Any special options to
6751: <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 6752: <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 6753: <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
6754: it fail if the patches apply with some lines of fuzz. Please
6755: fix (regen) the patches so that they apply cleanly. The
6756: rationale behind this is that patches that don't apply cleanly
6757: may end up being applied in the wrong place, and cause severe
6758: harm there.</p>
1.75 rillig 6759: </div>
6760: <div class="sect1" lang="en">
6761: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6762: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6763: <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 6764: </p>
1.75 rillig 6765: </div>
6766: <div class="sect1" lang="en">
6767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6768: <a name="build.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6769: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6770: linkers. The following variables can be used to tweak the
6771: wrappers.</p>
1.75 rillig 6772: <div class="variablelist"><dl>
6773: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6774: <dd><p>The command used to print progress
1.88 wiz 6775: messages. Does nothing by default. Set to
6776: <code class="literal">${ECHO}</code> to see the progress
6777: messages.</p></dd>
1.75 rillig 6778: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6779: <dd><p>This variable can be set to
1.88 wiz 6780: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6781: depending on whether you want additional information in the
6782: wrapper log file.</p></dd>
1.75 rillig 6783: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6784: <dd><p>This variable can be set to
1.88 wiz 6785: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6786: on whether the wrapper should use its cache, which will
6787: improve the speed. The default value is
6788: <code class="literal">yes</code>, but is forced to
6789: <code class="literal">no</code> if the platform does not support
6790: it.</p></dd>
1.75 rillig 6791: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6792: <dd><p>A list of reordering commands. A reordering
6793: command has the form
6794: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6795: It ensures that that
6796: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6797: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6798: </p></dd>
1.75 rillig 6799: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6800: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6801: investigate further]</p></dd>
1.75 rillig 6802: </dl></div>
6803: </div>
6804: <div class="sect1" lang="en">
6805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6806: <a name="build.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6807: <p>Most pieces of software need information on the header
6808: files, system calls, and library routines which are available
6809: on the platform they run on. The process of determining this
6810: information is known as configuration, and is usually
6811: automated. In most cases, a script is supplied with the
6812: distfiles, and its invocation results in generation of header
6813: files, Makefiles, etc.</p>
6814: <p>If the package contains a configure script, this can be
6815: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6816: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6817: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6818: “<span class="quote">yes</span>” instead. What happens in the
6819: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6820: <pre class="programlisting">
6821: .for d in ${CONFIGURE_DIRS}
6822: cd ${WRKSRC} && cd ${d} && env ${CONFIGURE_ENV} \
6823: ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6824: .endfor
6825: </pre>
6826: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6827: “<span class="quote">.</span>”) is a list of pathnames relative to
6828: <code class="varname">WRKSRC</code>. In each of these directories, the
6829: configure script is run with the environment
6830: <code class="varname">CONFIGURE_ENV</code> and arguments
6831: <code class="varname">CONFIGURE_ARGS</code>. The variables
6832: <code class="varname">CONFIGURE_ENV</code>,
6833: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6834: “<span class="quote">./configure</span>”) and
6835: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6836: package.</p>
6837: <p>If the program uses an <code class="filename">Imakefile</code>
6838: for configuration, the appropriate steps can be invoked by
6839: setting <code class="varname">USE_IMAKE</code> to
6840: “<span class="quote">yes</span>”. (If you only want the package installed in
6841: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6842: <code class="varname">USE_X11BASE</code> instead.)</p>
1.75 rillig 6843: </div>
6844: <div class="sect1" lang="en">
6845: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6846: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6847: <p>For building a package, a rough equivalent of the
6848: following code is executed.</p>
1.75 rillig 6849: <pre class="programlisting">
1.88 wiz 6850: .for d in ${BUILD_DIRS}
6851: cd ${WRKSRC} && cd ${d} && env ${MAKE_ENV} \
6852: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6853: -f ${MAKE_FILE} ${BUILD_TARGET}
6854: .endfor
6855: </pre>
6856: <p><code class="varname">BUILD_DIRS</code> (default:
6857: “<span class="quote">.</span>”) is a list of pathnames relative to
6858: <code class="varname">WRKSRC</code>. In each of these directories,
6859: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6860: <code class="varname">MAKE_ENV</code> and arguments
6861: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6862: <code class="varname">MAKE_ENV</code>,
6863: <code class="varname">BUILD_MAKE_FLAGS</code>,
6864: <code class="varname">MAKE_FILE</code> and
6865: <code class="varname">BUILD_TARGET</code> may all be changed by the
6866: package.</p>
1.75 rillig 6867: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6868: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6869: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6870: default value of <code class="varname">MAKE_FILE</code> is
6871: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6872: defaults to “<span class="quote">all</span>”.</p>
1.75 rillig 6873: </div>
6874: <div class="sect1" lang="en">
6875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6876: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6877: <p>[TODO]</p>
6878: </div>
6879: <div class="sect1" lang="en">
6880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6881: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6882: <p>Once the build stage has completed, the final step is to
1.88 wiz 6883: install the software in public directories, so users can
6884: access the programs and files.</p>
1.75 rillig 6885: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6886: equivalent of the following code is executed. Additionally,
6887: before and after this code, much magic is performed to do
6888: consistency checks, registering the package, and so on.</p>
6889: <pre class="programlisting">
6890: .for d in ${INSTALL_DIRS}
6891: cd ${WRKSRC} && cd ${d} && env ${MAKE_ENV} \
6892: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6893: -f ${MAKE_FILE} ${BUILD_TARGET}
6894: .endfor
6895: </pre>
1.75 rillig 6896: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6897: <span class="emphasis"><em>build</em></span> phase.
6898: <code class="varname">INSTALL_DIRS</code> defaults to
6899: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
6900: is “<span class="quote">install</span>” by default, plus
6901: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
6902: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6903: defined.</p>
1.75 rillig 6904: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6905: variables are useful. They are all variations of the
6906: <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
6907: permissions preset. <code class="varname">INSTALL</code> is the plain
6908: install command. The specialized variants, together with their
6909: intended use, are:</p>
1.75 rillig 6910: <div class="variablelist"><dl>
6911: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6912: <dd><p>directories that contain
6913: binaries</p></dd>
1.75 rillig 6914: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6915: <dd><p>directories that contain
6916: scripts</p></dd>
1.75 rillig 6917: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6918: <dd><p>directories that contain shared and static
6919: libraries</p></dd>
1.75 rillig 6920: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6921: <dd><p>directories that contain data
6922: files</p></dd>
1.75 rillig 6923: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6924: <dd><p>directories that contain man
6925: pages</p></dd>
1.75 rillig 6926: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6927: <dd><p>binaries that can be stripped from debugging
6928: symbols</p></dd>
1.75 rillig 6929: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6930: <dd><p>binaries that cannot be
6931: stripped</p></dd>
1.75 rillig 6932: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6933: <dd><p>game
6934: binaries</p></dd>
1.75 rillig 6935: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6936: <dd><p>shared and static
6937: libraries</p></dd>
1.75 rillig 6938: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6939: <dd><p>data files</p></dd>
6940: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6941: <dd><p>data files for
6942: games</p></dd>
1.75 rillig 6943: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6944: <dd><p>man pages</p></dd>
6945: </dl></div>
6946: <p>Some other variables are:</p>
6947: <div class="variablelist"><dl>
6948: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6949: <dd><p>A list of directories relative to
1.88 wiz 6950: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6951: beginning of the <span class="emphasis"><em>install</em></span> phase. If
6952: this variable is set,
6953: <code class="varname">NO_MTREE</code>=“<span class="quote">yes</span>” is assumed,
6954: which means that the package claims to create all needed
6955: directories itself before installing files to it. Therefore
6956: this variable should only be set in
6957: <code class="filename">Makefile</code>s that are under control of the
6958: package's author. The directories are created with the
6959: correct ownership, depending on their
6960: name.</p></dd>
1.75 rillig 6961: </dl></div>
6962: </div>
6963: <div class="sect1" lang="en">
6964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6965: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6966: <p>Once the install stage has completed, a binary package of
6967: the installed files can be built. These binary packages can be
6968: used for quick installation without previous compilation, e.g. by
6969: the <span><strong class="command">make bin-install</strong></span> or by using
6970: <span><strong class="command">pkg_add</strong></span>.</p>
6971: <p>By default, the binary packages are created in
6972: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6973: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6974: one for each category in the <code class="varname">CATEGORIES</code>
6975: variable. <code class="varname">PACKAGES</code> defaults to
6976: <code class="filename">pkgsrc/packages</code>.</p>
6977: </div>
6978: <div class="sect1" lang="en">
6979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6980: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88 wiz 6981: <p>Once you're finished with a package, you can clean the work
6982: directory by running <span><strong class="command">make clean</strong></span>. If you want
6983: to clean the work directories of all dependencies too, use
6984: <span><strong class="command">make clean-depends</strong></span>.</p>
1.75 rillig 6985: </div>
6986: <div class="sect1" lang="en">
6987: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6988: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75 rillig 6989: <div class="variablelist"><dl>
6990: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6991: <dd><p>For any of the main targets described in the
6992: previous section, two auxiliary targets exist with
1.87 wiz 6993: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
6994: prefix for the main target's name. These targets are
1.88 wiz 6995: invoked before and after the main target is called,
6996: allowing extra configuration or installation steps be
6997: performed from a package's Makefile, for example, which
6998: a program's configure script or install target
6999: omitted.</p></dd>
1.75 rillig 7000: <dt><span class="term">do-*</span></dt>
1.88 wiz 7001: <dd><p>Should one of the main targets do the wrong thing,
7002: and should there be no variable to fix this, you can
7003: redefine it with the do-* target. (Note that redefining
7004: the target itself instead of the do-* target is a bad
7005: idea, as the pre-* and post-* targets won't be called
7006: anymore, etc.) You will not usually need to do
7007: this.</p></dd>
1.75 rillig 7008: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7009: <dd>
7010: <p>If you did a <span><strong class="command">make install</strong></span> and
7011: you noticed some file was not installed properly, you
7012: can repeat the installation with this target, which will
7013: ignore the “<span class="quote">already installed</span>” flag.</p>
7014: <p>This is the default value of
7015: <code class="varname">DEPENDS_TARGET</code> except in the case of
7016: <span><strong class="command">make update</strong></span> and <span><strong class="command">make
7017: package</strong></span>, where the defaults are
7018: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7019: respectively.</p>
7020: </dd>
1.75 rillig 7021: <dt><span class="term">deinstall</span></dt>
7022: <dd>
1.88 wiz 7023: <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
7024: current directory, effectively de-installing the
7025: package. The following variables can be used to tune the
7026: behaviour:</p>
1.75 rillig 7027: <div class="variablelist"><dl>
7028: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7029: <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>
7030: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7031: <dd><p>Remove all packages that require (depend on)
7032: the given package. This can be used to remove any
7033: packages that may have been pulled in by a given
7034: package, e.g. if <span><strong class="command">make deinstall
1.87 wiz 7035: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7036: <code class="filename">pkgsrc/x11/kde</code>, this is
7037: likely to remove whole KDE. Works by adding
7038: “<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>
7039: command line.</p></dd>
1.75 rillig 7040: </dl></div>
7041: </dd>
1.88 wiz 7042: <dt><span class="term">bin-install</span></dt>
7043: <dd><p>Install a binary package from local disk and via FTP
7044: from a list of sites (see the
7045: <code class="varname">BINPKG_SITES</code> variable), and do a
7046: <span><strong class="command">make package</strong></span> if no binary package is
7047: available anywhere. The arguments given to
7048: <span><strong class="command">pkg_add</strong></span> can be set via
7049: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7050: operation, etc.</p></dd>
1.75 rillig 7051: <dt><span class="term">update</span></dt>
7052: <dd>
1.88 wiz 7053: <p>This target causes the current package to be
7054: updated to the latest version. The package and all
7055: depending packages first get de-installed, then current
7056: versions of the corresponding packages get compiled and
7057: installed. This is similar to manually noting which
7058: packages are currently installed, then performing a
7059: series of <span><strong class="command">make deinstall</strong></span> and
7060: <span><strong class="command">make install</strong></span> (or whatever
7061: <code class="varname">UPDATE_TARGET</code> is set to) for these
7062: packages.</p>
7063: <p>You can use the “<span class="quote">update</span>” target to
7064: resume package updating in case a previous <span><strong class="command">make
7065: update</strong></span> was interrupted for some reason.
7066: However, in this case, make sure you don't call
7067: <span><strong class="command">make clean</strong></span> or otherwise remove the
7068: list of dependent packages in <code class="varname">WRKDIR</code>.
7069: Otherwise, you lose the ability to automatically update
7070: the current package along with the dependent packages
7071: you have installed.</p>
7072: <p>Resuming an interrupted <span><strong class="command">make
7073: update</strong></span> will only work as long as the package
7074: tree remains unchanged. If the source code for one of
7075: the packages to be updated has been changed, resuming
7076: <span><strong class="command">make update</strong></span> will most certainly
7077: fail!</p>
7078: <p>The following variables can be used either on the
7079: command line or in <code class="filename">/etc/mk.conf</code> to
7080: alter the behaviour of <span><strong class="command">make
7081: update</strong></span>:</p>
1.75 rillig 7082: <div class="variablelist"><dl>
7083: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7084: <dd><p>Install target to recursively use for the
7085: updated package and the dependent packages.
7086: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7087: set, “<span class="quote">install</span>” otherwise for
7088: <span><strong class="command">make update</strong></span>. Other good
7089: targets are “<span class="quote">package</span>” or
7090: “<span class="quote">bin-install</span>”. Do not set this to
7091: “<span class="quote">update</span>” or you will get stuck in an
7092: endless loop!</p></dd>
1.75 rillig 7093: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7094: <dd><p>Don't clean up after updating. Useful if
7095: you want to leave the work sources of the updated
7096: packages around for inspection or other purposes.
7097: Be sure you eventually clean up the source tree
7098: (see the “<span class="quote">clean-update</span>” target below)
7099: or you may run into troubles with old source code
7100: still lying around on your next
7101: <span><strong class="command">make</strong></span> or <span><strong class="command">make
7102: update</strong></span>.</p></dd>
1.75 rillig 7103: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7104: <dd><p>Deinstall each package before installing
7105: (making <code class="varname">DEPENDS_TARGET</code>). This
7106: may be necessary if the
7107: “<span class="quote">clean-update</span>” target (see below) was
7108: called after interrupting a running <span><strong class="command">make
7109: update</strong></span>.</p></dd>
1.75 rillig 7110: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7111: <dd><p>Allows you to disable recursion and hardcode
7112: the target for packages. The default is
7113: “<span class="quote">update</span>” for the update target,
7114: facilitating a recursive update of prerequisite
7115: packages. Only set
7116: <code class="varname">DEPENDS_TARGET</code> if you want to
7117: disable recursive updates. Use
7118: <code class="varname">UPDATE_TARGET</code> instead to just
7119: set a specific target for each package to be
7120: installed during <span><strong class="command">make update</strong></span>
7121: (see above).</p></dd>
1.75 rillig 7122: </dl></div>
7123: </dd>
7124: <dt><span class="term">clean-update</span></dt>
7125: <dd>
1.88 wiz 7126: <p>Clean the source tree for all packages that would
7127: get updated if <span><strong class="command">make update</strong></span> was called
7128: from the current directory. This target should not be
7129: used if the current package (or any of its depending
7130: packages) have already been de-installed (e.g., after
7131: calling <span><strong class="command">make update</strong></span>) or you may lose
7132: some packages you intended to update. As a rule of
7133: thumb: only use this target <span class="emphasis"><em>before</em></span>
7134: the first time you run <span><strong class="command">make update</strong></span>
7135: and only if you have a dirty package tree (e.g., if you
7136: used <code class="varname">NOCLEAN</code>).</p>
7137: <p>If you are unsure about whether your tree is
7138: clean, you can either perform a <span><strong class="command">make
7139: clean</strong></span> at the top of the tree, or use the
7140: following sequence of commands from the directory of the
7141: package you want to update (<span class="emphasis"><em>before</em></span>
7142: running <span><strong class="command">make update</strong></span> for the first
7143: time, otherwise you lose all the packages you wanted to
7144: update!):</p>
1.87 wiz 7145: <pre class="screen">
7146: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7147: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7148: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7149: </pre>
1.88 wiz 7150: <p>The following variables can be used either on the
7151: command line or in <code class="filename">/etc/mk.conf</code> to
7152: alter the behaviour of <span><strong class="command">make
7153: clean-update</strong></span>:</p>
1.75 rillig 7154: <div class="variablelist"><dl>
7155: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.88 wiz 7156: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
7157: reconstruct the list of directories to update for
7158: this package. Only use this if <span><strong class="command">make
7159: update</strong></span> successfully installed all
7160: packages you wanted to update. Normally, this is
7161: done automatically on <span><strong class="command">make
7162: update</strong></span>, but may have been suppressed by
7163: the <code class="varname">NOCLEAN</code> variable (see
7164: above).</p></dd>
1.75 rillig 7165: </dl></div>
7166: </dd>
1.88 wiz 7167: <dt><span class="term">replace</span></dt>
7168: <dd>
7169: <p>Update the installation of the current package. This
7170: differs from update in that it does not replace dependent
1.93 ! rillig 7171: 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 7172: target to work.</p>
7173: <p><span class="emphasis"><em>Be careful when using this
7174: target!</em></span> There are no guarantees that dependent
7175: packages will still work, in particular they will most
7176: certainly break if you <span><strong class="command">make replace</strong></span> a
7177: library package whose shared library major version changed
7178: between your installed version and the new one. For this
7179: reason, this target is not officially supported and only
7180: recommended for advanced users.</p>
7181: </dd>
1.75 rillig 7182: <dt><span class="term">info</span></dt>
7183: <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 7184: package. You can use this to check which version of a
7185: package is installed.</p></dd>
7186: <dt><span class="term">index</span></dt>
7187: <dd>
7188: <p>This is a top-level command, i.e. it should be used in
7189: the <code class="filename">pkgsrc</code> directory. It creates a
7190: database of all packages in the local pkgsrc tree, including
7191: dependencies, comment, maintainer, and some other useful
7192: information. Individual entries are created by running
7193: <span><strong class="command">make describe</strong></span> in the packages'
7194: directories. This index file is saved as
7195: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
7196: verbose format by running <span><strong class="command">make
7197: print-index</strong></span>. You can search in it with
7198: <span><strong class="command">make search
7199: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7200: extract a list of all packages that depend on a particular
7201: one by running <span><strong class="command">make show-deps
7202: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7203: <p>Running this command takes a very long time, some
7204: hours even on fast machines!</p>
7205: </dd>
1.75 rillig 7206: <dt><span class="term">readme</span></dt>
1.88 wiz 7207: <dd>
7208: <p>This target generates a
7209: <code class="filename">README.html</code> file, which can be
1.91 rillig 7210: 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 7211: contain references to any packages which are in the
7212: <code class="varname">PACKAGES</code> directory on the local
7213: host. The generated files can be made to refer to URLs
7214: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7215: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7216: wanted to generate <code class="filename">README.html</code>
7217: files which pointed to binary packages on the local
7218: machine, in the directory
7219: <code class="filename">/usr/packages</code>, set
7220: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7221: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7222: <code class="varname">${PACKAGES}</code> directory and its
7223: subdirectories will be searched for all the binary
7224: packages.</p>
7225: <p>The target can be run at the toplevel or in category
7226: directories, in which case it descends recursively.</p>
7227: </dd>
1.75 rillig 7228: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7229: <dd><p>This is a top-level command, run it in
7230: <code class="filename">pkgsrc</code>. Use this target to create a
7231: file <code class="filename">README-all.html</code> which contains a
7232: list of all packages currently available in the NetBSD
7233: Packages Collection, together with the category they belong
7234: to and a short description. This file is compiled from the
7235: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7236: to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
7237: readme</strong></span>.</p></dd>
1.75 rillig 7238: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7239: <dd><p>This is very much the same as the
7240: “<span class="quote">readme</span>” target (see above), but is to be
7241: used when generating a pkgsrc tree to be written to a
7242: CD-ROM. This target also produces
7243: <code class="filename">README.html</code> files, and can be made
7244: to refer to URLs based on
7245: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7246: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7247: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7248: <dd><p>This target shows which distfiles and patchfiles
7249: are needed to build the package
7250: (<code class="varname">ALLFILES</code>, which contains all
7251: <code class="varname">DISTFILES</code> and
1.87 wiz 7252: <code class="varname">PATCHFILES</code>, but not
7253: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7254: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7255: <dd><p>This target shows nothing if the package is not
7256: installed. If a version of this package is installed,
7257: but is not the version provided in this version of
7258: pkgsrc, then a warning message is displayed. This target
7259: can be used to show which of your installed packages are
7260: downlevel, and so the old versions can be deleted, and
7261: the current ones added.</p></dd>
1.75 rillig 7262: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7263: <dd><p>This target shows the directory in the pkgsrc
7264: hierarchy from which the package can be built and
7265: installed. This may not be the same directory as the one
7266: from which the package was installed. This target is
7267: intended to be used by people who may wish to upgrade
7268: many packages on a single host, and can be invoked from
7269: the top-level pkgsrc Makefile by using the
1.87 wiz 7270: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
1.75 rillig 7271: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7272: <dd><p>This target shows which installed packages match
7273: the current package's <code class="varname">DEPENDS</code>. Useful
7274: if out of date dependencies are causing build
7275: problems.</p></dd>
1.75 rillig 7276: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7277: <dd><p>After a package is installed, check all its
7278: binaries and (on ELF platforms) shared libraries to see
7279: if they find the shared libs they need. Run by default
7280: if <code class="varname">PKG_DEVELOPER</code> is set in
1.87 wiz 7281: <code class="filename">/etc/mk.conf</code>.</p></dd>
1.75 rillig 7282: <dt><span class="term">print-PLIST</span></dt>
7283: <dd>
7284: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7285: upgraded pkg, this prints out an attempt to generate a
7286: new <code class="filename">PLIST</code> from a <span><strong class="command">find
7287: -newer work/.extract_done</strong></span>. An attempt is made
7288: to care for shared libs etc., but it is
1.87 wiz 7289: <span class="emphasis"><em>strongly</em></span> recommended to review the
7290: result before putting it into
7291: <code class="filename">PLIST</code>. On upgrades, it's useful to
7292: diff the output of this command against an already
7293: existing <code class="filename">PLIST</code> file.</p>
1.88 wiz 7294: <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
7295: other methods that don't update file access times, be
7296: sure to add these files manually to your
1.87 wiz 7297: <code class="filename">PLIST</code>, as the “<span class="quote">find
7298: -newer</span>” command used by this target won't catch
7299: them!</p>
1.90 rillig 7300: <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 7301: information on this target.</p>
1.75 rillig 7302: </dd>
7303: <dt><span class="term">bulk-package</span></dt>
7304: <dd>
1.88 wiz 7305: <p>Used to do bulk builds. If an appropriate binary
7306: package already exists, no action is taken. If not, this
7307: target will compile, install and package it (and its
7308: depends, if <code class="varname">PKG_DEPENDS</code> is set
7309: properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, “Configuration”</a>).
7310: After creating the binary package, the sources, the
7311: just-installed package and its required packages are
7312: removed, preserving free disk space.</p>
7313: <p><span class="emphasis"><em>Beware that this target may deinstall
7314: all packages installed on a system!</em></span></p>
1.75 rillig 7315: </dd>
7316: <dt><span class="term">bulk-install</span></dt>
7317: <dd>
1.88 wiz 7318: <p>Used during bulk-installs to install required
7319: packages. If an up-to-date binary package is available,
7320: 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,
7321: <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87 wiz 7322: but the installed binary won't be removed.</p>
1.88 wiz 7323: <p>A binary package is considered
7324: “<span class="quote">up-to-date</span>” to be installed via
7325: <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>
7326: <div class="itemizedlist"><ul type="disc">
7327: <li><p>None of the package's files
7328: (<code class="filename">Makefile</code>, ...) were modified
7329: since it was built.</p></li>
7330: <li><p>None of the package's required (binary)
7331: packages were modified since it was built.</p></li>
1.75 rillig 7332: </ul></div>
1.88 wiz 7333: <p><span class="emphasis"><em>Beware that this target may deinstall
7334: all packages installed on a system!</em></span></p>
1.75 rillig 7335: </dd>
7336: </dl></div>
7337: </div>
7338: </div>
7339: <div class="chapter" lang="en">
7340: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7341: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7342: <div class="toc">
7343: <p><b>Table of Contents</b></p>
7344: <dl>
1.90 rillig 7345: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
7346: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
7347: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75 rillig 7348: </dl>
7349: </div>
1.87 wiz 7350: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7351: by pkgsrc and also for individual packages to define what commands
7352: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7353: or for later run-time of an installed packaged (such as
7354: <code class="varname">DEPENDS</code>).
7355: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7356: package will not be used.</p>
7357: <p>When building a package, the replacement tools are
1.75 rillig 7358: made available in a directory (as symlinks or wrapper scripts)
7359: that is early in the executable search path. Just like the buildlink
1.87 wiz 7360: system, this helps with consistent builds.</p>
7361: <p>A tool may be needed to help build a specific package. For example,
7362: perl, GNU make (gmake) or yacc may be needed.</p>
7363: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7364: tool may be inefficient for building a package with pkgsrc.
7365: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7366: yacc) or a better sed.</p>
7367: <p>The tools used by a package can be listed by running
7368: <span><strong class="command">make show-tools</strong></span>.</p>
1.75 rillig 7369: <div class="sect1" lang="en">
7370: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7371: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7372: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7373: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75 rillig 7374: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
7375: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
7376: These can be seen by running:
1.87 wiz 7377: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7378: <p>If a package needs a specific program to build
1.75 rillig 7379: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7380: to define the tools needed.</p>
1.75 rillig 7381: </div>
7382: <div class="sect1" lang="en">
7383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7384: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7385: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7386: and not the native version for a build dependency.
7387: And the :run means that it is used for a
7388: run-time dependencies also (and becomes a DEPENDS).
7389: The default is a build dependency which can be set with
7390: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7391: and pkg-config:build.)</p>
1.75 rillig 7392: <pre class="programlisting">
7393: USE_TOOLS+= mktemp:pkgsrc
7394: USE_TOOLS+= gmake perl:run pkg-config
7395: </pre>
1.87 wiz 7396: <p>When using the tools framework, a
1.75 rillig 7397: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7398: which contains the full path to the appropriate tool. For example,
7399: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7400: on Linux systems.</p>
7401: <p>If you always need a pkgsrc version of the
1.75 rillig 7402: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7403: </p>
7404: </div>
7405: <div class="sect1" lang="en">
7406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7407: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7408: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7409: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7410: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7411: the name of the common tools. For example:</p>
7412: <pre class="programlisting">
7413: .if exists(/usr/bin/bzcat)
7414: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7415: .elif exists(/usr/bin/bzip2)
7416: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7417: .endif
1.69 rillig 7418:
1.75 rillig 7419: TOOLS_PLATFORM.true?= true # shell builtin
7420: </pre>
7421: </div>
7422: </div>
7423: <div class="chapter" lang="en">
7424: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7425: <a name="fixes"></a>Chapter 18. Making your package work</h2></div></div></div>
1.75 rillig 7426: <div class="toc">
7427: <p><b>Table of Contents</b></p>
7428: <dl>
1.90 rillig 7429: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75 rillig 7430: <dd><dl>
1.90 rillig 7431: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
7432: <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>
7433: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
7434: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
7435: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
7436: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
7437: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
7438: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
7439: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
7440: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
7441: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7442: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7443: </dl></dd>
7444: <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>
7445: <dd><dl>
7446: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7447: <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>
7448: </dl></dd>
7449: <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>
7450: <dd><dl>
7451: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
7452: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7453: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
7454: </dl></dd>
7455: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
7456: <dd><dl>
7457: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
7458: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
7459: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
7460: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
7461: </dl></dd>
7462: <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>
7463: <dd><dl>
7464: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
7465: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
7466: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7467: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
7468: </dl></dd>
7469: <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>
7470: <dd><dl>
7471: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
7472: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
7473: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
7474: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
7475: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
7476: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
7477: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
7478: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
7479: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
7480: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
7481: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
7482: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
7483: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
7484: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
7485: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
7486: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
7487: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 7488: emulation</a></span></dt>
1.90 rillig 7489: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
7490: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.75 rillig 7491: </dl></dd>
1.90 rillig 7492: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7493: </dl>
7494: </div>
7495: <div class="sect1" lang="en">
7496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7497: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75 rillig 7498: <div class="sect2" lang="en">
7499: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7500: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7501: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7502: different platforms. As a result, it is important to ensure,
7503: where possible, that packages in pkgsrc are portable. This
7504: chapter mentions some particular details you should pay
7505: attention to while working on pkgsrc.</p>
1.78 rillig 7506: </div>
7507: <div class="sect2" lang="en">
7508: <div class="titlepage"><div><div><h3 class="title">
1.93 ! rillig 7509: <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>
! 7510: </h3></div></div></div>
1.78 rillig 7511: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7512: variables in the file pointed to by <code class="varname">MAKECONF</code>,
7513: which is <code class="filename">/etc/mk.conf</code> by default. When you
7514: want to use those variables in the preprocessor directives of
7515: <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
7516: <code class="literal">.for</code>), you need to include the file
7517: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7518: loads the user preferences.</p>
1.78 rillig 7519: <p>But note that some variables may not be completely defined
1.87 wiz 7520: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7521: included, as they may contain references to variables that are
7522: not yet defined. In shell commands this is no problem, since
7523: variables are actually macros, which are only expanded when they
7524: are used. But in the preprocessor directives mentioned above and
7525: in dependency lines (of the form <code class="literal">target:
7526: dependencies</code>) the variables are expanded at load
7527: time.</p>
1.78 rillig 7528: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7529: <h3 class="title">Note</h3>
7530: <p>Currently there is no exhaustive list of all
1.87 wiz 7531: variables that tells you whether they can be used at load time
7532: or only at run time, but it is in preparation.</p>
1.78 rillig 7533: </div>
7534: </div>
7535: <div class="sect2" lang="en">
7536: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7537: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88 wiz 7538: <p>Occasionally, packages require interaction from the user,
7539: and this can be in a number of ways:</p>
1.78 rillig 7540: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7541: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7542: interaction such as entering username/password or accepting a
7543: license on a web page.</p></li>
1.88 wiz 7544: <li><p>When extracting the distfiles, some packages may ask for
7545: passwords.</p></li>
1.78 rillig 7546: <li><p>help to configure the package before it is built</p></li>
7547: <li><p>help during the build process</p></li>
7548: <li><p>help during the installation of a package</p></li>
7549: </ul></div>
1.88 wiz 7550: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7551: provided to notify the pkgsrc mechanism of an interactive stage
7552: which will be needed, and this should be set in the package's
7553: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7554: <pre class="programlisting">
1.87 wiz 7555: INTERACTIVE_STAGE= build
7556: </pre>
1.78 rillig 7557: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7558: <pre class="programlisting">
1.87 wiz 7559: INTERACTIVE_STAGE= configure install
7560: </pre>
1.88 wiz 7561: <p>The user can then decide to skip this package by setting the
7562: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7563: </div>
7564: <div class="sect2" lang="en">
7565: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7566: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.78 rillig 7567: <p>A package may be covered by a license which the user has
1.87 wiz 7568: or has not agreed to accept. For these cases, pkgsrc contains
7569: a mechanism to note that a package is covered by a particular
7570: license, and the package cannot be built unless the user has
7571: accepted the license. (Installation of binary packages are
7572: not currently subject to this mechanism.) Packages with
7573: licenses that are either Open Source according to the Open
7574: Source Initiative or Free according to the Free Software
7575: Foundation will not be marked with a license tag. Packages
7576: with licenses that have not been determined to meet either
7577: definition will be marked with a license tag referring to the
7578: license. This will prevent building unless pkgsrc is informed
7579: that the license is acceptable, and enables displaying the
7580: license.</p>
1.78 rillig 7581: <p>The license tag mechanism is intended to address
1.87 wiz 7582: copyright-related issues surrounding building, installing and
7583: using a package, and not to address redistribution issues (see
7584: <code class="varname">RESTRICTED</code> and
7585: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7586: definition of licenses for which tags are not needed implies
7587: that packages with redistribution restrictions should have
7588: tags.</p>
7589: <p>Denoting that a package is covered by a particular license
7590: is done by placing the license in
7591: <code class="filename">pkgsrc/licenses</code> and setting the
7592: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7593: 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 7594: <pre class="programlisting">
7595: LICENSE= xv-license
7596: </pre>
7597: <p>When trying to build, the user will get a notice that the
7598: package is covered by a license which has not been
7599: accepted:</p>
7600: <pre class="programlisting">
7601: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7602: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7603: ===> To view the license, enter "/usr/bin/make show-license".
7604: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7605: ===> ACCEPTABLE_LICENSES+=xv-license
7606: *** Error code 1
7607: </pre>
1.78 rillig 7608: <p>The license can be viewed with <span><strong class="command">make
1.87 wiz 7609: show-license</strong></span>, and if it is considered appropriate,
7610: the line printed above can be added to
7611: <code class="filename">/etc/mk.conf</code> to indicate acceptance of
7612: the particular license:</p>
1.78 rillig 7613: <pre class="programlisting">
1.87 wiz 7614: ACCEPTABLE_LICENSES+=xv-license
7615: </pre>
1.78 rillig 7616: <p>When adding a package with a new license, the license
1.87 wiz 7617: text should be added to <code class="filename">pkgsrc/licenses</code>
7618: for displaying. A list of known licenses can be seen in this
1.91 rillig 7619: directory.</p>
1.78 rillig 7620: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.87 wiz 7621: <code class="varname">LICENSE=no-commercial-use</code>, and similar
7622: language is deprecated because it does not crisply refer to
7623: a particular license text. Another problem with such usage
7624: is that it does not enable a user to denote acceptance of
7625: the license for a single package without accepting the same
7626: license text for another package. In particular, this can
7627: be inappropriate when e.g. one accepts a particular license to
7628: indicate to pkgsrc that a fee has been paid.</p>
1.75 rillig 7629: </div>
7630: <div class="sect2" lang="en">
7631: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7632: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7633: <p>Some licenses restrict how software may be re-distributed.
1.87 wiz 7634: In order to satisfy these restrictions, the package system
7635: defines five make variables that can be set to note these
7636: restrictions:</p>
1.75 rillig 7637: <div class="itemizedlist"><ul type="disc">
7638: <li>
7639: <p><code class="varname">RESTRICTED</code></p>
7640: <p>This variable should be set whenever a restriction
1.87 wiz 7641: exists (regardless of its kind). Set this variable to a
7642: string containing the reason for the restriction.</p>
1.75 rillig 7643: </li>
7644: <li>
7645: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7646: <p>Binaries may not be placed on CD-ROM. Set this
1.87 wiz 7647: variable to <code class="varname">${RESTRICTED}</code> whenever a
7648: binary package may not be included on a CD-ROM.</p>
1.75 rillig 7649: </li>
7650: <li>
7651: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7652: <p>Binaries may not be placed on an FTP server. Set
1.87 wiz 7653: this variable to <code class="varname">${RESTRICTED}</code>
1.93 ! rillig 7654: whenever a binary package may not be made available
1.87 wiz 7655: on the Internet.</p>
1.75 rillig 7656: </li>
7657: <li>
7658: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7659: <p>Distfiles may not be placed on CD-ROM. Set this
1.87 wiz 7660: variable to <code class="varname">${RESTRICTED}</code> if
7661: re-distribution of the source code or other distfile(s) is
7662: not allowed on CD-ROMs.</p>
1.75 rillig 7663: </li>
7664: <li>
7665: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7666: <p>Distfiles may not be placed on FTP. Set this variable
1.87 wiz 7667: to <code class="varname">${RESTRICTED}</code> if re-distribution of
7668: the source code or other distfile(s) via the Internet is not
7669: allowed. If this variable is not set, the distfile(s) will
7670: be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7671: </li>
7672: </ul></div>
7673: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87 wiz 7674: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7675: generic make variables to denote restrictions is deprecated,
7676: because they unconditionally prevent users from generating
7677: binary packages!</p>
1.75 rillig 7678: </div>
7679: <div class="sect2" lang="en">
7680: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7681: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7682: <p>Your package may depend on some other package being present
1.88 wiz 7683: - and there are various ways of expressing this dependency.
7684: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7685: <code class="varname">DEPENDS</code> definitions, the
7686: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7687: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7688: to handle dependencies, and which uses the variables named above.
1.90 rillig 7689: See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7690: <p>The basic difference between the two variables is as
1.87 wiz 7691: follows: The <code class="varname">DEPENDS</code> definition registers
7692: that pre-requisite in the binary package so it will be pulled in
7693: when the binary package is later installed, whilst the
7694: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7695: dependency that is only needed for building the package.</p>
1.75 rillig 7696: <p>This means that if you only need a package present whilst
1.87 wiz 7697: you are building, it should be noted as a
7698: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7699: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7700: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7701: <pre class="programlisting">
1.87 wiz 7702: <pre-req-package-name>:../../<category>/<pre-req-package>
7703: </pre>
1.75 rillig 7704: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7705: may include any of the wildcard version numbers recognized by
7706: <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 7707: <div class="orderedlist"><ol type="1">
7708: <li>
7709: <p>If your package needs another package's binaries or
1.87 wiz 7710: libraries to build or run, and if that package has a
7711: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7712: <pre class="programlisting">
1.87 wiz 7713: .include "../../graphics/jpeg/buildlink3.mk"
7714: </pre>
1.75 rillig 7715: </li>
7716: <li>
7717: <p>If your package needs to use another package to build
1.87 wiz 7718: itself and there is no <code class="filename">buildlink3.mk</code>
7719: file available, use the <code class="varname">BUILD_DEPENDS</code>
7720: definition:</p>
1.75 rillig 7721: <pre class="programlisting">
1.87 wiz 7722: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
7723: </pre>
1.75 rillig 7724: </li>
7725: <li>
7726: <p>If your package needs a library with which to link and
1.76 rillig 7727: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7728: available, this is specified using the
7729: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7730: <pre class="programlisting">
1.87 wiz 7731: DEPENDS+= xpm-3.4j:../../graphics/xpm
7732: </pre>
1.75 rillig 7733: <p>You can also use wildcards in package dependences:</p>
7734: <pre class="programlisting">
1.87 wiz 7735: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
7736: </pre>
1.75 rillig 7737: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7738: creating binary packages. The dependency is checked when
7739: installing the binary package and any package which matches
7740: the pattern will be used. Wildcard dependencies should be
7741: used with care.</p>
1.75 rillig 7742: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7743: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7744: such as “<span class="quote">tk-postgresql</span>” matching a
7745: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7746: <p>Wildcards can also be used to specify that a package
1.87 wiz 7747: will only build against a certain minimum version of a
7748: pre-requisite:</p>
1.75 rillig 7749: <pre class="programlisting">
1.87 wiz 7750: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
7751: </pre>
1.75 rillig 7752: <p>This means that the package will build against version
1.87 wiz 7753: 3.5.4 of the tiff library or newer. Such a dependency may
7754: be warranted if, for example, the API of the library has
7755: changed with version 3.5.4 and a package would not compile
7756: against an earlier version of tiff.</p>
1.75 rillig 7757: <p>Please note that such dependencies should only be
1.87 wiz 7758: updated if a package requires a newer pre-requisite, but
1.93 ! rillig 7759: not to denote recommendations such as
1.87 wiz 7760: ABI changes that do not prevent a package from building
7761: correctly. Such recommendations can be expressed using
7762: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7763: <pre class="programlisting">
1.87 wiz 7764: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
7765: </pre>
1.75 rillig 7766: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7767: line, this denotes that while a package will build against
7768: tiff>=3.5.4, at least version 3.6.1 is recommended.
7769: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7770: dependencies unless explicitly ignored (in which case a
7771: warning will be printed).</p>
1.75 rillig 7772: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7773: use the required <code class="varname">DEPENDS</code>, set
7774: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7775: it easier and faster to update packages built using pkgsrc,
7776: since older compatible dependencies can continue to be
7777: used. This is useful for people who watch their rebuilds
7778: very carefully; it is not very good as a general-purpose
7779: hammer. If you use it, you need to be mindful of possible
7780: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7781: <p>Packages that are built with recommendations ignored
1.87 wiz 7782: may not be uploaded to ftp.NetBSD.org by developers and
7783: should not be used across different systems that may have
7784: different versions of binary packages installed.</p>
1.75 rillig 7785: <p>For security fixes, please update the package
1.90 rillig 7786: 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 7787: information.</p>
1.75 rillig 7788: </li>
7789: <li>
7790: <p>If your package needs some executable to be able to run
1.87 wiz 7791: correctly and if there's no
7792: <code class="filename">buildlink3.mk</code> file, this is specified
7793: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 7794: <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 7795: be able to execute the latex binary from the teTeX package
7796: when it runs, and that is specified:</p>
1.75 rillig 7797: <pre class="programlisting">
1.87 wiz 7798: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
7799: </pre>
1.75 rillig 7800: <p>The comment about wildcard dependencies from previous
1.87 wiz 7801: paragraph applies here, too.</p>
1.75 rillig 7802: </li>
7803: </ol></div>
7804: <p>If your package needs files from another package to build,
1.87 wiz 7805: add the relevant distribution files to
7806: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 7807: 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 7808: (It relies on the jpeg sources being present in source form
7809: during the build.)</p>
1.88 wiz 7810: <p>Please also note the
7811: <code class="varname">BUILD_USES_GETTEXT_M4</code> definition, which is
7812: provided as convenience definition. It adds a build dependency on
7813: either an installed version of an older gettext package, or if it
1.91 rillig 7814: isn't, installs the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gettext-m4/README.html" target="_top"><code class="filename">devel/gettext-m4</code></a> package.</p>
1.75 rillig 7815: </div>
7816: <div class="sect2" lang="en">
7817: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7818: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7819: <p>Your package may conflict with other packages a user might
1.87 wiz 7820: already have installed on his system, e.g. if your package
1.88 wiz 7821: installs the same set of files as another package in the pkgsrc
7822: tree.</p>
1.75 rillig 7823: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7824: space-separated list of packages (including version string) your
7825: package conflicts with.</p>
1.91 rillig 7826: <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>
7827: 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 7828: install the same shared library, thus you set in
7829: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7830: <pre class="programlisting">
7831: CONFLICTS= Xaw-Xpm-[0-9]*
7832: </pre>
7833: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 7834: <pre class="programlisting">
1.87 wiz 7835: CONFLICTS= Xaw3d-[0-9]*
7836: </pre>
1.75 rillig 7837: <p>Packages will automatically conflict with other packages
1.87 wiz 7838: with the name prefix and a different version
7839: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
7840: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 7841: </div>
7842: <div class="sect2" lang="en">
7843: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7844: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7845: <p>There are several reasons why a package might be
1.88 wiz 7846: instructed to not build under certain circumstances. If the
1.87 wiz 7847: package builds and runs on most platforms, the exceptions
7848: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7849: the package builds and runs on a small handful of platforms,
7850: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
7851: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7852: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7853: (OS-version-platform) that can use glob-style
7854: wildcards.</p>
1.88 wiz 7855: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 7856: 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 7857: backwards compatible with other versions of the OS, and should be
7858: uploaded to a version specific directory on the FTP server. Mark
7859: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
7860: “<span class="quote">yes</span>”. This variable is not currently used by any of
7861: the package system internals, but may be used in the
7862: future.</p>
1.75 rillig 7863: <p>If the package should be skipped (for example, because it
1.87 wiz 7864: provides functionality already provided by the system), set
1.88 wiz 7865: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7866: the package should fail because some preconditions are not met,
7867: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7868: message.</p>
1.75 rillig 7869: </div>
7870: <div class="sect2" lang="en">
7871: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7872: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7873: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7874: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7875: be set in the package Makefile. This will be carried into any
7876: binary package that is made from this pkgsrc entry. A
7877: “<span class="quote">preserved</span>” package will
7878: 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
7879: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 7880: </div>
7881: <div class="sect2" lang="en">
7882: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7883: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7884: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7885: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
7886: and after committing that file, use <span><strong class="command">make upload</strong></span>
7887: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 7888: <p>After fixing the vulnerability by a patch, its
1.87 wiz 7889: <code class="varname">PKGREVISION</code> should be increased (this
7890: is of course not necessary if the problem is fixed by using
7891: a newer release of the software).</p>
1.75 rillig 7892: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7893: branch, be sure to submit a pullup request!</p>
1.75 rillig 7894: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7895: semi-automatically by a weekly cron job.</p>
1.75 rillig 7896: </div>
7897: <div class="sect2" lang="en">
7898: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7899: <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 7900: <p>When making fixes to an existing package it can be useful
1.87 wiz 7901: to change the version number in <code class="varname">PKGNAME</code>. To
7902: avoid conflicting with future versions by the original author, a
7903: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
7904: on package versions by setting <code class="varname">PKGREVISION=1</code>
7905: (2, ...). The “<span class="quote">nb</span>” is treated like a
7906: “<span class="quote">.</span>” by the package tools. e.g.</p>
7907: <pre class="programlisting">
7908: DISTNAME= foo-17.42
7909: PKGREVISION= 9
7910: </pre>
1.75 rillig 7911: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 7912: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
7913: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
7914: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7915: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7916: <p>When a new release of the package is released, the
1.87 wiz 7917: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7918: minor release of the above package, things should be like:</p>
1.75 rillig 7919: <pre class="programlisting">
1.87 wiz 7920: DISTNAME= foo-17.43
7921: </pre>
7922: <p><code class="varname">PKGREVISION</code> should be incremented for any
7923: non-trivial change in the resulting binary package. Without a
7924: <code class="varname">PKGREVISION</code> bump, someone with the previous
7925: version installed has no way of knowing that their package is out
7926: of date. Thus, changes without increasing
7927: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7928: trivial that no reasonable person would want to upgrade", and this
7929: is the rough test for when increasing
7930: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7931: changes that do not merit increasing
7932: <code class="varname">PKGREVISION</code> are:</p>
7933: <pre class="programlisting">
7934: Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
7935: or comments in Makefile.
7936: Changing build variables if the resulting binary package is the same.
7937: Changing <code class="filename">DESCR</code>.
7938: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.
7939: </pre>
7940: <p>Examples of changes that do merit an increase to
7941: <code class="varname">PKGREVISION</code> include:</p>
7942: <pre class="programlisting">
7943: Security fixes
7944: Changes or additions to a patch file
7945: Changes to the <code class="filename">PLIST</code>
7946: </pre>
1.78 rillig 7947: <p>PKGREVISION must also be incremented when dependencies have ABI
7948: changes.</p>
1.75 rillig 7949: </div>
1.79 rillig 7950: <div class="sect2" lang="en">
7951: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7952: <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 7953: <p>When you want to replace the same text in multiple files
1.87 wiz 7954: or when the replacement text varies, patches alone cannot help.
7955: This is where the SUBST framework comes in. It provides an
7956: easy-to-use interface for replacing text in files.
7957: Example:</p>
7958: <pre class="programlisting">
7959: SUBST_CLASSES+= fix-paths
7960: SUBST_STAGE.fix-paths= pre-configure
7961: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7962: SUBST_FILES.fix-paths= src/*.c
7963: SUBST_FILES.fix-paths+= scripts/*.sh
7964: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7965: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7966: </pre>
1.79 rillig 7967: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 7968: that are used to identify the different SUBST blocks that are
7969: defined. The SUBST framework is heavily used by pkgsrc, so it is
7970: important to always use the <code class="literal">+=</code> operator with
7971: this variable. Otherwise some substitutions may be
7972: skipped.</p>
1.79 rillig 7973: <p>The remaining variables of each SUBST block are
1.87 wiz 7974: parameterized with the identifier from the first line
7975: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7976: parameters to a function call.</p>
1.79 rillig 7977: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 7978: which the replacement will take place. All combinations of
7979: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7980: <code class="literal">post-</code> together with a phase name are
7981: possible, though only few are actually used. Most commonly used
7982: are <code class="literal">post-patch</code> and
7983: <code class="literal">pre-configure</code>. Of these two,
7984: <code class="literal">pre-configure</code> should be preferred because
7985: then it is possible to run <span><strong class="command">bmake patch</strong></span> and
7986: have the state after applying the patches but before making any
7987: other changes. This is especially useful when you are debugging
7988: a package in order to create new patches for it. Similarly,
7989: <code class="literal">post-build</code> is preferred over
7990: <code class="literal">pre-install</code>, because the install phase should
7991: generally be kept as simple as possible. When you use
7992: <code class="literal">post-build</code>, you have the same files in the
7993: working directory that will be installed later, so you can check
7994: if the substitution has succeeded.</p>
1.79 rillig 7995: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 7996: that is printed just before the substitution is done.</p>
1.79 rillig 7997: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 7998: globbing patterns that specifies the files in which the
7999: substitution will take place. The patterns are interpreted
8000: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8001: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87 wiz 8002: <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
8003: command should be prefixed with <code class="literal">-e</code>, so that
8004: all SUBST blocks look uniform.</p>
1.79 rillig 8005: <p>There are some more variables, but they are so seldomly
1.87 wiz 8006: used that they are only documented in the
8007: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8008: </div>
1.75 rillig 8009: </div>
8010: <div class="sect1" lang="en">
8011: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8012: <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 8013: <div class="sect2" lang="en">
8014: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8015: <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 8016: <p>If you need to download from a dynamic URL you can set
1.87 wiz 8017: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
8018: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8019: with the name of each file to download as an argument, expecting
8020: it to output the URL of the directory from which to download
1.91 rillig 8021: 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 8022: example of this usage.</p>
1.75 rillig 8023: <p>If the download can't be automated, because the user must
1.87 wiz 8024: submit personal information to apply for a password, or must pay
8025: for the source, or whatever, you can set
8026: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8027: displayed to the user before aborting the build. Example:</p>
8028: <pre class="programlisting">
8029: FETCH_MESSAGE= "Please download the files"
8030: FETCH_MESSAGE+= " "${DISTFILES:Q}
8031: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8032: </pre>
1.75 rillig 8033: </div>
8034: <div class="sect2" lang="en">
8035: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8036: <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 8037: <p>Sometimes authors of a software package make some
1.87 wiz 8038: modifications after the software was released, and they put up a
8039: new distfile without changing the package's version number. If a
8040: package is already in pkgsrc at that time, the checksum will
8041: no longer match. The contents of the new distfile should be
8042: compared against the old one before changing anything, to make
8043: sure the distfile was really updated on purpose, and that
8044: no trojan horse or so crept in.
8045: Then, the correct way to work around this is to
8046: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8047: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8048: <code class="varname">DISTFILES</code> and
1.93 ! rillig 8049: <code class="varname">PATCHFILES</code> for this package will be put in that
1.87 wiz 8050: subdirectory of the local distfiles directory. In case this
8051: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8052: including the <code class="filename">nbX</code> suffix) or a date stamp
8053: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8054: Do not forget regenerating the <code class="filename">distinfo</code> file
8055: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8056: path in the filenames.
8057: Furthermore, a mail to the package's authors seems appropriate
8058: telling them that changing distfiles after releases without
8059: changing the file names is not good practice.</p>
1.75 rillig 8060: </div>
8061: </div>
8062: <div class="sect1" lang="en">
8063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8064: <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 8065: <div class="sect2" lang="en">
8066: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8067: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8068: <p>pkgsrc supports many different machines, with different
1.87 wiz 8069: object formats like a.out and ELF, and varying abilities to do
8070: shared library and dynamic loading at all. To accompany this,
8071: varying commands and options have to be passed to the
8072: compiler, linker, etc. to get the Right Thing, which can be
8073: pretty annoying especially if you don't have all the machines
8074: at your hand to test things. The
1.91 rillig 8075: <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 8076: can help here, as it just “<span class="quote">knows</span>” how to build
8077: both static and dynamic libraries from a set of source files,
8078: thus being platform-independent.</p>
8079: <p>Here's how to use libtool in a package in seven simple
8080: steps:</p>
1.75 rillig 8081: <div class="orderedlist"><ol type="1">
8082: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8083: Makefile.</p></li>
1.75 rillig 8084: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8085: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8086: add it to the definition of <code class="varname">CC</code>, if only
8087: libraries are being built in a given Makefile. This one command
8088: will build both PIC and non-PIC library objects, so you need not
8089: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8090: <li>
8091: <p>For the linking of the library, remove any
1.87 wiz 8092: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8093: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8094: <pre class="programlisting">
1.87 wiz 8095: ${LIBTOOL} --mode=link ${CC} -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} \
8096: -rpath ${PREFIX}/lib -version-info major:minor
8097: </pre>
1.75 rillig 8098: <p>Note that the library is changed to have a
1.87 wiz 8099: <code class="filename">.la</code> extension, and the objects are
8100: changed to have a <code class="filename">.lo</code>
8101: extension. Change <code class="varname">OBJS</code> as
8102: necessary. This automatically creates all of the
8103: <code class="filename">.a</code>,
8104: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8105: necessary) in the build directory. Be sure to include
8106: “<span class="quote">-version-info</span>”, especially when major and
8107: minor are zero, as libtool will otherwise strip off the
8108: shared library version.</p>
1.75 rillig 8109: <p>From the libtool manual:</p>
8110: <pre class="programlisting">
1.87 wiz 8111: So, libtool library versions are described by three integers:
1.69 rillig 8112:
1.87 wiz 8113: CURRENT
8114: The most recent interface number that this library implements.
1.69 rillig 8115:
1.87 wiz 8116: REVISION
8117: The implementation number of the CURRENT interface.
1.69 rillig 8118:
1.87 wiz 8119: AGE
8120: The difference between the newest and oldest interfaces that
8121: this library implements. In other words, the library implements
8122: all the interface numbers in the range from number `CURRENT -
8123: AGE' to `CURRENT'.
1.1 grant 8124:
1.87 wiz 8125: If two libraries have identical CURRENT and AGE numbers, then the
8126: dynamic linker chooses the library with the greater REVISION number.
8127: </pre>
1.75 rillig 8128: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8129: different results for a.out and ELF (excluding symlinks)
8130: in only one case. An ELF library of the form
8131: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8132: will have a symlink of
8133: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8134: on an a.out platform. This is handled
8135: automatically.</p>
1.75 rillig 8136: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8137: directory of the library being built.</p>
1.76 rillig 8138: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8139: <code class="filename">.la</code> file, the other files will be
8140: added automatically.</p>
1.75 rillig 8141: </li>
8142: <li>
1.76 rillig 8143: <p>When linking shared object (<code class="filename">.so</code>)
1.87 wiz 8144: 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
8145: shared libraries, use “<span class="quote">-module
8146: -avoid-version</span>” to prevent them getting version
8147: tacked on.</p>
1.76 rillig 8148: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8149: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8150: </li>
8151: <li>
8152: <p>When linking programs that depend on these libraries
1.87 wiz 8153: <span class="emphasis"><em>before</em></span> they are installed, preface
8154: 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}
8155: --mode=link</span>”, and it will find the correct
8156: libraries (static or shared), but please be aware that
8157: libtool will not allow you to specify a relative path in
8158: -L (such as “<span class="quote">-L../somelib</span>”), because it
8159: expects you to change that argument to be the
8160: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8161: <pre class="programlisting">
1.87 wiz 8162: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8163: </pre>
1.75 rillig 8164: <p>should be changed to:</p>
8165: <pre class="programlisting">
1.87 wiz 8166: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8167: </pre>
1.75 rillig 8168: <p>and it will do the right thing with the libraries.</p>
8169: </li>
8170: <li>
8171: <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 8172: 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}
8173: --mode=install</span>”, and change the library name to
8174: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8175: <pre class="programlisting">
1.87 wiz 8176: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
8177: </pre>
1.76 rillig 8178: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8179: shared library, any needed symlinks, and run
8180: <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 8181: </li>
1.76 rillig 8182: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8183: the <code class="filename">.la</code>
8184: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8185: </ol></div>
8186: </div>
8187: <div class="sect2" lang="en">
8188: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8189: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8190: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8191: package Makefile. This will override the package's own libtool
8192: in most cases. For older libtool using packages, libtool is
8193: made by ltconfig script during the do-configure step; you can
8194: check the libtool script location by doing <span><strong class="command">make
8195: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8196: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8197: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8198: default, it is set to “<span class="quote">libtool */libtool
8199: */*/libtool</span>”. If this does not match the location of the
8200: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8201: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8202: libraries built and installed, then use
8203: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8204: <p>If your package makes use of the platform-independent library
1.87 wiz 8205: for loading dynamic shared objects, that comes with libtool
8206: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8207: <p>Some packages use libtool incorrectly so that the package
8208: may not work or build in some circumstances. Some of the more
8209: common errors are:</p>
1.75 rillig 8210: <div class="itemizedlist"><ul type="disc">
8211: <li>
8212: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8213: executable or library. This in itself isn't a problem if one of two things
8214: has been done:</p>
1.75 rillig 8215: <div class="orderedlist"><ol type="1">
8216: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8217: <code class="filename">libfoo.la</code>, not
8218: <code class="filename">foo.la</code></p></li>
1.75 rillig 8219: <li><p>The -dlopen option is used when linking an executable.</p></li>
8220: </ol></div>
8221: </li>
8222: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8223: The function lt_dlinit() should be called and the macro
8224: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8225: executables.</p></li>
1.75 rillig 8226: </ul></div>
8227: </div>
8228: <div class="sect2" lang="en">
8229: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8230: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8231: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8232: to regenerate the configure script and Makefile.in makefile
8233: templates, then they should be executed in a pre-configure
8234: target.</p>
1.75 rillig 8235: <p>For packages that need only autoconf:</p>
8236: <pre class="programlisting">
1.87 wiz 8237: AUTOCONF_REQD= 2.50 # if default version is not good enough
8238: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8239: ...
1.1 grant 8240:
1.87 wiz 8241: pre-configure:
8242: cd ${WRKSRC}; autoconf
1.1 grant 8243:
1.87 wiz 8244: ...
8245: </pre>
1.75 rillig 8246: <p>and for packages that need automake and autoconf:</p>
8247: <pre class="programlisting">
1.87 wiz 8248: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8249: USE_TOOLS+= automake # use "automake14" for automake-1.4
8250: ...
8251:
8252: pre-configure:
8253: cd ${WRKSRC}; \
8254: aclocal; autoheader; \
8255: automake -a --foreign -i; autoconf
1.1 grant 8256:
1.87 wiz 8257: ...
8258: </pre>
1.75 rillig 8259: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8260: require GNU Make.</p>
1.75 rillig 8261: <p>There are times when the configure process makes
1.87 wiz 8262: additional changes to the generated files, which then causes
8263: the build process to try to re-execute the automake sequence.
8264: This is prevented by touching various files in the configure
8265: stage. If this causes problems with your package you can set
8266: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8267: Makefile.</p>
1.75 rillig 8268: </div>
8269: </div>
8270: <div class="sect1" lang="en">
8271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8272: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87 wiz 8273: <div class="sect2" lang="en">
8274: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8275: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8276: <p>Compilers for the C, C++, and Fortran languages comes with
8277: the NetBSD base system. By default, pkgsrc assumes that a package
8278: is written in C and will hide all other compilers (via the wrapper
1.90 rillig 8279: framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8280: <p>To declare which language's compiler a package needs, set
8281: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8282: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8283: “<span class="quote">fortran</span>” (and any combination). The default is
8284: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8285: written in C++, usually need a C compiler for the configure
8286: phase.</p>
8287: </div>
8288: <div class="sect2" lang="en">
8289: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8290: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87 wiz 8291: <p>If a program is written in Java, use the Java framework in
8292: pkgsrc. The package must include
8293: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8294: provides the following variables:</p>
8295: <div class="itemizedlist"><ul type="disc">
8296: <li><p><code class="varname">USE_JAVA</code> defines if a build
8297: dependency on the JDK is added. If
8298: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8299: there is only a runtime dependency on the JDK. The default is
8300: “<span class="quote">yes</span>”, which also adds a build dependency on the
8301: JDK.</p></li>
8302: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8303: a package needs a Java2 implementation. The supported values
8304: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8305: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8306: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8307: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8308: above. This variable is not set by default.</p></li>
8309: </ul></div>
8310: </div>
8311: <div class="sect2" lang="en">
8312: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8313: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8314: <p>If your package contains interpreted perl scripts, add
8315: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8316: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8317: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8318: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8319: that you want adjusted. Every occurrence of
8320: <code class="filename">*/bin/perl</code> will be replaced with the full
8321: path to the perl executable.</p>
8322: <p>If a particular version of perl is needed, set the
8323: <code class="varname">PERL5_REQD</code> variable to the version number. The
8324: default is “<span class="quote">5.0</span>”.</p>
1.90 rillig 8325: <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 8326: about handling perl modules.</p>
8327: </div>
8328: <div class="sect2" lang="en">
8329: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8330: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8331: <p>Currently, there is no special handling for other languages
8332: in pkgsrc. If a compiler package provides a
8333: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8334: just add a (build) dependency on the appropriate compiler
8335: package.</p>
8336: </div>
8337: </div>
8338: <div class="sect1" lang="en">
8339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8340: <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 8341: <p>The most common failures when building a package are that
8342: some platforms do not provide certain header files, functions or
8343: libraries, or they provide the functions in a library that the
8344: original package author didn't know. To work around this, you
8345: can rewrite the source code in most cases so that it does not
8346: use the missing functions or provides a replacement function.</p>
8347: <div class="sect2" lang="en">
8348: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8349: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8350: <p>If a package already comes with a GNU configure script, the
8351: preferred way to fix the build failure is to change the
8352: configure script, not the code. In the other cases, you can
8353: utilize the C preprocessor, which defines certain macros
8354: depending on the operating system and hardware architecture it
8355: compiles for. These macros can be queried using for example
8356: <code class="varname">#if defined(__i386)</code>. Almost every operating
8357: system, hardware architecture and compiler has its own macro.
8358: For example, if the macros <code class="varname">__GNUC__</code>,
8359: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8360: are all defined, you know that you are using NetBSD on an i386
8361: compatible CPU, and your compiler is GCC.</p>
8362: <p>The list of the following macros for hardware and
8363: operating system depends on the compiler that is used. For
8364: example, if you want to conditionally compile code on Solaris,
8365: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8366: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8367: <div class="sect3" lang="en">
8368: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8369: <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 8370: <p>To distinguish between 4.4 BSD-derived systems and the
8371: rest of the world, you should use the following code.</p>
8372: <pre class="programlisting">
8373: #include <sys/param.h>
8374: #if (defined(BSD) && BSD >= 199306)
8375: /* BSD-specific code goes here */
8376: #else
8377: /* non-BSD-specific code goes here */
8378: #endif
8379: </pre>
1.77 rillig 8380: <p>If this distinction is not fine enough, you can also test
8381: for the following macros.</p>
1.75 rillig 8382: <pre class="programlisting">
8383: FreeBSD __FreeBSD__
8384: DragonFly __DragonFly__
8385: Interix __INTERIX
8386: Linux linux, __linux, __linux__
8387: NetBSD __NetBSD__
8388: OpenBSD __OpenBSD__
8389: Solaris sun, __sun
8390: </pre>
8391: </div>
8392: <div class="sect3" lang="en">
8393: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8394: <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 8395: <pre class="programlisting">
8396: i386 i386, __i386, __i386__
8397: MIPS __mips
8398: SPARC sparc, __sparc
8399: </pre>
8400: </div>
8401: <div class="sect3" lang="en">
8402: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8403: <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 8404: <pre class="programlisting">
8405: GCC __GNUC__ (major version), __GNUC_MINOR__
8406: SunPro __SUNPRO_C (0x570 for version 5.7)
1.81 rillig 8407: SunPro C++ __SUNPRO_CC (0x580 for version 5.8)
1.75 rillig 8408: </pre>
8409: </div>
8410: </div>
1.78 rillig 8411: <div class="sect2" lang="en">
8412: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8413: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8414: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8415: combinations of compiler version and architecture and almost
8416: always relation to optimisation being enabled. Common symptoms
8417: are gcc internal errors or never finishing compiling a
1.78 rillig 8418: file.</p>
8419: <p>Typically, a workaround involves testing the
8420: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8421: optimisation for that combination of file,
8422: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8423: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8424: number of examples.</p>
8425: </div>
8426: <div class="sect2" lang="en">
8427: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8428: <a name="undefined-reference"></a>18.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.92 rillig 8429: <p>This error message often means that a package did not
1.78 rillig 8430: link to a shared library it needs. The following functions are
8431: known to cause this error message over and over.</p>
8432: <div class="informaltable">
8433: <a name="undefined-reference-functions"></a><table border="1">
8434: <colgroup>
8435: <col>
8436: <col>
8437: <col>
8438: </colgroup>
8439: <thead><tr>
8440: <th>Function</th>
8441: <th>Library</th>
8442: <th>Affected platforms</th>
8443: </tr></thead>
8444: <tbody>
8445: <tr>
8446: <td>accept, bind, connect</td>
8447: <td>-lsocket</td>
8448: <td>Solaris</td>
8449: </tr>
8450: <tr>
8451: <td>crypt</td>
8452: <td>-lcrypt</td>
8453: <td>DragonFly, NetBSD</td>
8454: </tr>
8455: <tr>
8456: <td>dlopen, dlsym</td>
8457: <td>-ldl</td>
8458: <td>Linux</td>
8459: </tr>
8460: <tr>
8461: <td>gethost*</td>
8462: <td>-lnsl</td>
8463: <td>Solaris</td>
8464: </tr>
8465: <tr>
8466: <td>inet_aton</td>
8467: <td>-lresolv</td>
8468: <td>Solaris</td>
8469: </tr>
8470: <tr>
8471: <td>nanosleep, sem_*, timer_*</td>
8472: <td>-lrt</td>
8473: <td>Solaris</td>
8474: </tr>
8475: <tr>
8476: <td>openpty</td>
8477: <td>-lutil</td>
8478: <td>Linux</td>
8479: </tr>
8480: </tbody>
8481: </table>
8482: </div>
8483: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8484: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8485: -l<em class="replaceable"><code>foo</code></em></code> to the package
8486: <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
8487: bmake</strong></span>.</p>
1.92 rillig 8488: <div class="sect3" lang="en">
8489: <div class="titlepage"><div><div><h4 class="title">
8490: <a name="undefined-reference-sunpro"></a>18.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
8491: <p>When you are using the SunPro compiler, there is another
8492: possibility. That compiler cannot handle the following code:</p>
8493: <pre class="programlisting">
8494: extern int extern_func(int);
1.93 ! rillig 8495:
1.92 rillig 8496: static inline int
8497: inline_func(int x)
8498: {
8499: return extern_func(x);
8500: }
1.93 ! rillig 8501:
1.92 rillig 8502: int main(void)
8503: {
8504: return 0;
8505: }
8506: </pre>
8507: <p>It generates the code for <code class="function">inline_func</code> even if
8508: that function is never used. This code then refers to
8509: <code class="function">extern_func</code>, which can usually not be resolved. To
8510: solve this problem you can try to tell the package to disable inlining
8511: of functions.</p>
8512: </div>
1.87 wiz 8513: </div>
8514: <div class="sect2" lang="en">
8515: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8516: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8517: <p>Sometimes packages fail to build because the compiler runs
8518: into an operating system specific soft limit. With the
8519: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8520: to unlimit the resources. Currently, the allowed values are
8521: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8522: Setting this variable is similar to running the shell builtin
8523: <span><strong class="command">ulimit</strong></span> command to raise the maximum data
8524: segment size or maximum stack size of a process, respectively, to
8525: their hard limits.</p>
1.78 rillig 8526: </div>
1.75 rillig 8527: </div>
8528: <div class="sect1" lang="en">
8529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8530: <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 8531: <div class="sect2" lang="en">
8532: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8533: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78 rillig 8534: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87 wiz 8535: with some operating systems cannot create more than one
8536: directory at a time. As such, you should call
8537: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8538: <pre class="programlisting">
8539: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8540: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8541: </pre>
1.78 rillig 8542: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8543: dir2</code></span>” to the
8544: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8545: automatically do the right thing.</p>
1.75 rillig 8546: </div>
8547: <div class="sect2" lang="en">
8548: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8549: <a name="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8550: <p>In general, documentation should be installed into
1.87 wiz 8551: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8552: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8553: includes the version number of the package).</p>
1.84 wiz 8554: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8555: directory where HTML documentation is installed with the
8556: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8557: is needed because otherwise the documentation ends up in
8558: <code class="filename">${PREFIX}/share/doc/html</code> or other
8559: places.</p>
8560: <p>An exception to the above is that library API documentation
1.91 rillig 8561: 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 8562: browsers (devhelp) should be left at their default location, which
8563: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8564: documentation can be recognized from files ending in
8565: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8566: (It is also acceptable to install such files in
8567: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8568: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8569: <code class="filename">.devhelp*</code> file must be directly in that
8570: directory then, no additional subdirectory level is allowed in
8571: this case. This is usually achieved by using
8572: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8573: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8574: though.)</p>
1.75 rillig 8575: </div>
8576: <div class="sect2" lang="en">
8577: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8578: <a name="installing-score-files"></a>18.6.3. Installing score files</h3></div></div></div>
1.75 rillig 8579: <p>Certain packages, most of them in the games category, install
1.87 wiz 8580: a score file that allows all users on the system to record their
8581: highscores. In order for this to work, the binaries need to be
8582: installed setgid and the score files owned by the appropriate
8583: group and/or owner (traditionally the "games" user/group). The
8584: following variables, documented in more detail in
8585: <code class="filename">mk/defaults/mk.conf</code>, control this
8586: behaviour: <code class="varname">SETGIDGAME</code>,
8587: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8588: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8589: <p>Note that per default, setgid installation of games is
1.87 wiz 8590: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8591: the other variables accordingly.</p>
1.75 rillig 8592: <p>A package should therefor never hard code file ownership or
1.87 wiz 8593: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8594: <code class="varname">INSTALL_GAME_DATA</code> to set these
8595: correctly.</p>
1.75 rillig 8596: </div>
8597: <div class="sect2" lang="en">
8598: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8599: <a name="hardcoded-paths"></a>18.6.4. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8600: <p>Your package may also contain scripts with hardcoded paths to
8601: other interpreters besides (or as well as) perl. To correct the
8602: full pathname to the script interpreter, you need to set the
8603: following definitions in your <code class="filename">Makefile</code> (we
8604: shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
8605: <pre class="programlisting">
8606: REPLACE_INTERPRETER+= tcl
8607: REPLACE.tcl.old= .*/bin/tclsh
8608: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8609: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8610: # relative to ${WRKSRC}, just as in REPLACE_PERL
8611: </pre>
1.75 rillig 8612: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8613: <h3 class="title">Note</h3>
8614: <p>Before March 2006, these variables were called
1.87 wiz 8615: <code class="varname">_REPLACE.*</code> and
8616: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8617: </div>
8618: </div>
8619: <div class="sect2" lang="en">
8620: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8621: <a name="perl-modules"></a>18.6.5. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8622: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8623: the Makefile fragment
8624: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
8625: <span><strong class="command">do-configure</strong></span> target for the standard perl
8626: configuration for such modules as well as various hooks to tune
8627: this configuration. See comments in this file for
8628: details.</p>
1.75 rillig 8629: <p>Perl5 modules will install into different places depending
1.87 wiz 8630: on the version of perl used during the build process. To
8631: address this, pkgsrc will append lines to the
8632: <code class="filename">PLIST</code> corresponding to the files listed in
8633: the installed <code class="filename">.packlist</code> file generated by
8634: most perl5 modules. This is invoked by defining
8635: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8636: paths to packlist files, e.g.:</p>
1.75 rillig 8637: <pre class="programlisting">
1.87 wiz 8638: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8639: </pre>
1.75 rillig 8640: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8641: <code class="varname">PERL5_SITEARCH</code>, and
8642: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8643: in which perl5 modules may be installed, and may be used by
8644: perl5 packages that don't have a packlist. These three
8645: variables are also substituted for in the
8646: <code class="filename">PLIST</code>.</p>
1.75 rillig 8647: </div>
8648: <div class="sect2" lang="en">
8649: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8650: <a name="faq.info-files"></a>18.6.6. Packages installing info files</h3></div></div></div>
1.75 rillig 8651: <p>Some packages install info files or use the
1.87 wiz 8652: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8653: commands. <code class="varname">INFO_FILES</code> should be defined in
8654: the package Makefile so that <code class="filename">INSTALL</code> and
8655: <code class="filename">DEINSTALL</code> scripts will be generated to
8656: handle registration of the info files in the Info directory
8657: file. The “<span class="quote">install-info</span>” command used for the info
8658: files registration is either provided by the system, or by a
8659: special purpose package automatically added as dependency if
8660: needed.</p>
1.75 rillig 8661: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8662: <code class="filename">${PREFIX}</code> where info files are primarily
8663: located. <code class="varname">PKGINFODIR</code> defaults to
8664: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8665: <p>The info files for the package should be listed in the
1.87 wiz 8666: package <code class="filename">PLIST</code>; however any split info files
8667: need not be listed.</p>
1.75 rillig 8668: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8669: at build time must add “<span class="quote">makeinfo</span>” to
8670: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8671: version of the “<span class="quote">makeinfo</span>” command is needed it
8672: should be noted with the <code class="varname">TEXINFO_REQD</code>
8673: variable in the package <code class="filename">Makefile</code>. By
8674: default, a minimum version of 3.12 is required. If the system
8675: does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
8676: does not match the required minimum, a build dependency on the
1.91 rillig 8677: <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 8678: be added automatically.</p>
1.75 rillig 8679: <p>The build and installation process of the software provided
1.87 wiz 8680: by the package should not use the
8681: <span><strong class="command">install-info</strong></span> command as the registration of
8682: info files is the task of the package
8683: <code class="filename">INSTALL</code> script, and it must use the
8684: appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75 rillig 8685: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87 wiz 8686: overriding scripts for the <span><strong class="command">install-info</strong></span> and
8687: <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
8688: in <code class="varname">PATH</code>.</p>
1.75 rillig 8689: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87 wiz 8690: no effect except the logging of a message. The script overriding
8691: <span><strong class="command">makeinfo</strong></span> logs a message and according to the
8692: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
8693: <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8694: </div>
8695: <div class="sect2" lang="en">
8696: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8697: <a name="manpages"></a>18.6.7. Packages installing man pages</h3></div></div></div>
1.81 rillig 8698: <p>All packages that install manual pages should install them
1.87 wiz 8699: into the same directory, so that there is one common place to look
8700: for them. In pkgsrc, this place is
8701: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8702: should be used in packages. The default for
8703: <code class="varname">PKGMANDIR</code> is
8704: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8705: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8706: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8707: <h3 class="title">Note</h3>
1.87 wiz 8708: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8709: is far from complete.</p>
1.75 rillig 8710: </div>
1.81 rillig 8711: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8712: <code class="filename">man/</code> as the top level directory for the man
8713: page file entries, and the pkgsrc framework will convert as
8714: needed. In all other places, the correct
8715: <code class="varname">PKGMANDIR</code> must be used.</p>
8716: <p>Packages that are
8717: configured with <code class="varname">GNU_CONFIGURE</code> set as
8718: “<span class="quote">yes</span>”, by default will use the
8719: <code class="filename">./configure</code>
8720: --mandir switch to set where the man pages should be installed.
8721: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8722: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8723: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8724: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8725: to “<span class="quote">no</span>”.
8726: Or if the <code class="filename">./configure</code> script uses
8727: a non-standard use of --mandir, you can set
8728: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90 rillig 8729: <p>See <a href="#manpage-compression" title="12.5. Man page compression">Section 12.5, “Man page compression”</a> for
1.87 wiz 8730: information on installation of compressed manual pages.</p>
1.75 rillig 8731: </div>
8732: <div class="sect2" lang="en">
8733: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8734: <a name="gconf2-data-files"></a>18.6.8. Packages installing GConf2 data files</h3></div></div></div>
1.87 wiz 8735: <p>If a package installs <code class="filename">.schemas</code> or
8736: <code class="filename">.entries</code> files, used by GConf2,
8737: you need to take some extra steps to make sure they get registered
8738: in the database:</p>
1.75 rillig 8739: <div class="orderedlist"><ol type="1">
1.76 rillig 8740: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87 wiz 8741: instead of its <code class="filename">buildlink3.mk</code> file. This
8742: takes care of rebuilding the GConf2 database at installation and
8743: deinstallation time, and tells the package where to install
8744: GConf2 data files using some standard configure arguments. It
8745: also disallows any access to the database directly from the
8746: package.</p></li>
1.75 rillig 8747: <li><p>Ensure that the package installs its
1.87 wiz 8748: <code class="filename">.schemas</code> files under
8749: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8750: installed under <code class="filename">${PREFIX}/etc</code>, you will
8751: need to manually patch the package.</p></li>
1.75 rillig 8752: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8753: directory, as they will be handled automatically. See
1.90 rillig 8754: <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 8755: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87 wiz 8756: your <code class="filename">Makefile</code> with a list of all
8757: <code class="filename">.schemas</code> files installed by the package, if
8758: any. Names must not contain any directories in them.</p></li>
1.75 rillig 8759: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87 wiz 8760: your <code class="filename">Makefile</code> with a
8761: list of all <code class="filename">.entries</code> files installed by the
8762: package, if any. Names must not contain any directories in
8763: them.</p></li>
1.75 rillig 8764: </ol></div>
8765: </div>
8766: <div class="sect2" lang="en">
8767: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8768: <a name="scrollkeeper-data-files"></a>18.6.9. Packages installing scrollkeeper data files</h3></div></div></div>
1.87 wiz 8769: <p>If a package installs <code class="filename">.omf</code> files, used by
8770: scrollkeeper, you need to take some extra steps to make sure they
8771: get registered in the database:</p>
1.75 rillig 8772: <div class="orderedlist"><ol type="1">
8773: <li><p>Include
1.87 wiz 8774: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
8775: instead of its <code class="filename">buildlink3.mk</code> file. This
8776: takes care of rebuilding the scrollkeeper database at
8777: installation and deinstallation time, and disallows any access
8778: to it directly from the package.</p></li>
1.75 rillig 8779: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 8780: <code class="filename">libdata/scrollkeeper</code> directory, as they
8781: will be handled automatically.</p></li>
1.76 rillig 8782: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87 wiz 8783: the PLIST. It will be handled by scrollkeeper.</p></li>
1.75 rillig 8784: </ol></div>
8785: </div>
8786: <div class="sect2" lang="en">
8787: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8788: <a name="x11-fonts"></a>18.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8789: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8790: the fonts database in the directory where they get installed at
8791: installation and deinstallation time. This can be automatically
8792: done by using the pkginstall framework.</p>
1.75 rillig 8793: <p>You can list the directories where fonts are installed in the
1.87 wiz 8794: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8795: variables, where <em class="replaceable"><code>type</code></em> can be one of
8796: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
8797: Also make sure that the database file
8798: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8799: <p>Note that you should not create new directories for fonts;
1.87 wiz 8800: instead use the standard ones to avoid that the user needs to
8801: manually configure his X server to find them.</p>
1.75 rillig 8802: </div>
8803: <div class="sect2" lang="en">
8804: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8805: <a name="gtk2-modules"></a>18.6.11. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8806: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8807: take some extra steps to get them registered in the GTK2 database
8808: properly:</p>
1.75 rillig 8809: <div class="orderedlist"><ol type="1">
8810: <li><p>Include
1.87 wiz 8811: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8812: <code class="filename">buildlink3.mk</code> file. This takes care of
8813: rebuilding the database at installation and deinstallation time.</p></li>
8814: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
8815: your package installs GTK2 immodules.</p></li>
8816: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
8817: GTK2 loaders.</p></li>
1.75 rillig 8818: <li>
1.87 wiz 8819: <p>Patch the package to not touch any of the GTK2
8820: databases directly. These are:</p>
1.75 rillig 8821: <div class="itemizedlist"><ul type="disc">
1.76 rillig 8822: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8823: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8824: </ul></div>
8825: </li>
1.87 wiz 8826: <li><p>Check the <code class="filename">PLIST</code> and remove
8827: any entries under the <code class="filename">libdata/gtk-2.0</code>
8828: directory, as they will be handled automatically.</p></li>
1.75 rillig 8829: </ol></div>
8830: </div>
8831: <div class="sect2" lang="en">
8832: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8833: <a name="sgml-xml-data"></a>18.6.12. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8834: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8835: registered in system-wide catalogs (like DTDs, sub-catalogs,
8836: etc.), you need to take some extra steps:</p>
1.75 rillig 8837: <div class="orderedlist"><ol type="1">
8838: <li><p>Include
1.87 wiz 8839: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8840: your <code class="filename">Makefile</code>, which takes care of
8841: registering those files in system-wide catalogs at
8842: installation and deinstallation time.</p></li>
1.75 rillig 8843: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 8844: any SGML catalogs installed by the package.</p></li>
1.75 rillig 8845: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 8846: any XML catalogs installed by the package.</p></li>
1.75 rillig 8847: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 8848: to be added to the SGML catalog. These come in groups of
8849: three strings; see xmlcatmgr(1) for more information
8850: (specifically, arguments recognized by the 'add' action).
8851: Note that you will normally not use this variable.</p></li>
1.75 rillig 8852: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 8853: to be added to the XML catalog. These come in groups of three
8854: strings; see xmlcatmgr(1) for more information (specifically,
8855: arguments recognized by the 'add' action). Note that you will
8856: normally not use this variable.</p></li>
1.75 rillig 8857: </ol></div>
8858: </div>
8859: <div class="sect2" lang="en">
8860: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8861: <a name="mime-database"></a>18.6.13. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 8862: <p>If a package provides extensions to the MIME database by
1.87 wiz 8863: installing <code class="filename">.xml</code> files inside
8864: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8865: need to take some extra steps to ensure that the database is kept
8866: consistent with respect to these new files:</p>
1.75 rillig 8867: <div class="orderedlist"><ol type="1">
8868: <li><p>Include
1.87 wiz 8869: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8870: (avoid using the <code class="filename">buildlink3.mk</code> file from
8871: this same directory, which is reserved for inclusion from
8872: other <code class="filename">buildlink3.mk</code> files). It takes
8873: care of rebuilding the MIME database at installation and
8874: deinstallation time, and disallows any access to it directly
8875: from the package.</p></li>
1.75 rillig 8876: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 8877: <code class="filename">share/mime</code> directory,
8878: <span class="emphasis"><em>except</em></span> for files saved under
8879: <code class="filename">share/mime/packages</code>. The former are
8880: handled automatically by
8881: the update-mime-database program, but the latter are
8882: package-dependent and must be removed by the package that
8883: installed them in the first place.</p></li>
1.76 rillig 8884: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 8885: from the PLIST. They will be handled by the shared-mime-info
8886: package.</p></li>
1.75 rillig 8887: </ol></div>
8888: </div>
8889: <div class="sect2" lang="en">
8890: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8891: <a name="intltool"></a>18.6.14. Packages using intltool</h3></div></div></div>
1.93 ! rillig 8892: <p>If a package uses intltool during its build, add
! 8893: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 8894: which forces it to use the intltool package provided by pkgsrc,
8895: instead of the one bundled with the distribution file.</p>
1.75 rillig 8896: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 8897: latest available version; this way, the package benefits of any
8898: bug fixes that may have appeared since it was released.</p>
1.75 rillig 8899: </div>
8900: <div class="sect2" lang="en">
8901: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8902: <a name="startup-scripts"></a>18.6.15. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 8903: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 8904: the startup directory by default, but you can enable it, by adding
8905: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
8906: <code class="filename">/etc/mk.conf</code>. This option will copy the scripts
8907: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8908: it will automatically remove the scripts when the package is
8909: deinstalled.</p>
1.75 rillig 8910: </div>
8911: <div class="sect2" lang="en">
8912: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8913: <a name="tex-packages"></a>18.6.16. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 8914: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 8915: the <code class="filename">ls-R</code> database of the tree needs to be
8916: updated.</p>
1.75 rillig 8917: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8918: <h3 class="title">Note</h3>
8919: <p>Except the main TeX packages such as teTeX-texmf,
1.87 wiz 8920: packages should install files
8921: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
8922: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75 rillig 8923: </div>
8924: <div class="orderedlist"><ol type="1">
8925: <li><p>Include
1.87 wiz 8926: <code class="filename">../../print/teTeX/module.mk</code> instead
8927: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
8928: takes care of rebuilding the <code class="filename">ls-R</code>
8929: database at installation and deinstallation time.</p></li>
1.75 rillig 8930: <li>
8931: <p>If your package installs files into a texmf
1.87 wiz 8932: tree other than the one
8933: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
8934: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
8935: trees that need database update.</p>
1.75 rillig 8936: <p>If your package also installs font map files that need
1.87 wiz 8937: to be registered using <span><strong class="command">updmap</strong></span>,
8938: set <code class="varname">TEX_FONTMAPS</code> to the list of all
8939: such font map files. Then <span><strong class="command">updmap</strong></span> will
8940: be run automatically at installation/deinstallation to
8941: enable/disable font map files for TeX output
8942: drivers.</p>
1.75 rillig 8943: </li>
1.76 rillig 8944: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 8945: databases are included in <code class="filename">PLIST</code>, as
8946: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 8947: </ol></div>
8948: </div>
1.85 jmmv 8949: <div class="sect2" lang="en">
8950: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8951: <a name="emulation-packages"></a>18.6.17. Packages supporting running binaries in
1.87 wiz 8952: emulation</h3></div></div></div>
8953: <p>There are some packages that provide libraries and
8954: executables for running binaries from a one operating system
8955: on a different one (if the latter supports it). One example
8956: is running Linux binaries on NetBSD.</p>
1.91 rillig 8957: <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 8958: helps in extracting and packaging Linux rpm packages.</p>
8959: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
8960: avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
8961: if all libraries for each installed executable can be found by
8962: the dynamic linker. Since the standard dynamic linker is run,
8963: this fails for emulation packages, because the libraries used
8964: by the emulation are not in the standard directories.</p>
8965: </div>
8966: <div class="sect2" lang="en">
8967: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8968: <a name="hicolor-theme"></a>18.6.18. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 8969: <p>If a package installs images under the
1.87 wiz 8970: <code class="filename">share/icons/hicolor</code> and/or updates the
8971: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8972: database, you need to take some extra steps to make sure that the
8973: shared theme directory is handled appropriately and that the cache
8974: database is rebuilt:</p>
1.85 jmmv 8975: <div class="orderedlist"><ol type="1">
8976: <li><p>Include
1.87 wiz 8977: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
8978: <li><p>Check the <code class="filename">PLIST</code> and remove the
8979: entry that refers to the theme cache.</p></li>
1.85 jmmv 8980: <li><p>Ensure that the PLIST does not remove the shared icon
8981: directories from the <code class="filename">share/icons/hicolor</code>
8982: hierarchy because they will be handled automatically.</p></li>
8983: </ol></div>
8984: <p>The best way to verify that the PLIST is correct with
8985: respect to the last two points is to regenerate it using
8986: <span><strong class="command">make print-PLIST</strong></span>.</p>
8987: </div>
8988: <div class="sect2" lang="en">
8989: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8990: <a name="desktop-files"></a>18.6.19. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 8991: <p>If a package installs <code class="filename">.desktop</code> files
8992: under <code class="filename">share/applications</code> and these include
8993: MIME information, you need to take extra steps to ensure that they
8994: are registered into the MIME database:</p>
8995: <div class="orderedlist"><ol type="1">
8996: <li><p>Include
8997: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
8998: <li><p>Check the PLIST and remove the entry that refers to the
8999: <code class="filename">share/applications/mimeinfo.cache</code> file.
9000: It will be handled automatically.</p></li>
9001: </ol></div>
9002: <p>The best way to verify that the PLIST is correct with
9003: respect to the last point is to regenerate it using <span><strong class="command">make
9004: print-PLIST</strong></span>.</p>
1.75 rillig 9005: </div>
9006: </div>
1.87 wiz 9007: <div class="sect1" lang="en">
9008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9009: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9010: <p>In some cases one does not have the time to solve a problem
9011: immediately. There are currently two ways to declare that one knows
9012: that a package has problems.</p>
9013: <div class="itemizedlist"><ul type="disc">
9014: <li><p>The first way is to plainly mark it as broken. For
9015: this, one just sets the variable <code class="varname">BROKEN</code> to the
9016: reason why the package is broken (similar to the
9017: <code class="varname">RESTRICTED</code> variable). A user trying to build
9018: the package will immediately be shown this message, and the build
9019: will not be even tried.</p></li>
9020: <li><p>After each pkgsrc freeze period (a time when the
9021: tree is stabilized and a new pkgsrc branch is cut), the packages
9022: that were not building in the official branch build on the latest
9023: NetBSD release will be marked as broken on that branch. This is
9024: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9025: branch name (or appending the branch name to it). If a user tries
9026: to build such a package and the build fails, the user gets a
9027: message that says that the package was broken on the respective
9028: branch(es).</p></li>
9029: </ul></div>
9030: <p>Both types of packages are removed from pkgsrc in irregular
9031: intervals.</p>
9032: </div>
1.75 rillig 9033: </div>
9034: <div class="chapter" lang="en">
9035: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9036: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88 wiz 9037: <p>To check out all the gotchas when building a package, here are
9038: the steps that I do in order to get a package working. Please note
9039: this is basically the same as what was explained in the previous
9040: sections, only with some debugging aids.</p>
1.75 rillig 9041: <div class="itemizedlist"><ul type="disc">
1.88 wiz 9042: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=1</code> in
9043: <code class="filename">/etc/mk.conf</code></p></li>
1.75 rillig 9044: <li>
1.91 rillig 9045: <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 9046: create a directory for a new package, change into it, then run
9047: <span><strong class="command">url2pkg</strong></span>:</p>
1.75 rillig 9048: <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>
9049: <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>
9050: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9051: </li>
1.76 rillig 9052: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9053: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87 wiz 9054: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75 rillig 9055: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9056: configure step to the package's
9057: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 9058: <li>
9059: <p>Make the package compile, doing multiple rounds of</p>
9060: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9061: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9062: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9063: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9064: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9065: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9066: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9067: <p>Doing this step as non-root user will ensure that no files
9068: are modified that shouldn't be, especially during the build
9069: phase. <span><strong class="command">mkpatches</strong></span>,
9070: <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91 rillig 9071: 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 9072: package.</p>
1.75 rillig 9073: </li>
1.88 wiz 9074: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90 rillig 9075: necessary; see <a href="#components.Makefile" title="10.1. Makefile">Section 10.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.75 rillig 9076: <li>
1.76 rillig 9077: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9078: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9079: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9080: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9081: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9082: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9083: <p>You usually need to be <code class="username">root</code> to do
9084: this. Look if there are any files left:</p>
1.75 rillig 9085: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9086: <p>If this reveals any files that are missing in
1.88 wiz 9087: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9088: </li>
9089: <li>
1.88 wiz 9090: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9091: package again and make a binary package:</p>
1.75 rillig 9092: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9093: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9094: </li>
9095: <li>
9096: <p>Delete the installed package:</p>
1.88 wiz 9097: <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 9098: </li>
9099: <li>
1.88 wiz 9100: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
9101: command, which shouldn't find anything now:</p>
1.75 rillig 9102: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9103: </li>
9104: <li>
9105: <p>Reinstall the binary package:</p>
1.93 ! rillig 9106: <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 9107: </li>
1.88 wiz 9108: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9109: <li>
1.91 rillig 9110: <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 9111: reports:</p>
1.75 rillig 9112: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9113: </li>
1.90 rillig 9114: <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 9115: </ul></div>
9116: </div>
9117: <div class="chapter" lang="en">
9118: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9119: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75 rillig 9120: <div class="toc">
9121: <p><b>Table of Contents</b></p>
9122: <dl>
1.90 rillig 9123: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
9124: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9125: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
9126: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
9127: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
9128: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9129: </dl>
9130: </div>
9131: <div class="sect1" lang="en">
9132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9133: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9134: <p>Our policy is that we accept binaries only from pkgsrc
9135: developers to guarantee that the packages don't contain any
9136: trojan horses etc. This is not to annoy anyone but rather to
9137: protect our users! You're still free to put up your home-made
9138: binary packages and tell the world where to get them. NetBSD
9139: developers doing bulk builds and wanting to upload them please
9140: 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>
9141: </div>
9142: <div class="sect1" lang="en">
9143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9144: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9145: <p>First, check that your package is complete, compiles and
1.90 rillig 9146: runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75 rillig 9147: 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 9148: archive that contains all files that make up the package.
1.87 wiz 9149: Finally, send this package to the pkgsrc bug tracking system,
9150: 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
9151: that, go to the web page
9152: <a href="http://www.NetBSD.org/Misc/send-pr.html" target="_top">http://www.NetBSD.org/Misc/send-pr.html</a>,
9153: which contains some instructions and a link to a form, where you
9154: can submit packages.</p>
9155: <p>In the form of the problem report, the category should be
9156: “<span class="quote">pkg</span>”, the synopsis should include the package name
9157: and version number, and the description field should contain a
9158: short description of your package (contents of the COMMENT
9159: variable or DESCR file are OK). The uuencoded package data should
9160: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9161: <p>If you want to submit several packages, please send a
9162: separate PR for each one, it's easier for us to track things
9163: that way.</p>
9164: <p>Alternatively, you can also import new packages into
9165: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
9166: homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9167: for details.</p>
9168: </div>
9169: <div class="sect1" lang="en">
9170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9171: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9172: <p>Please note all package additions, updates, moves, and
1.93 ! rillig 9173: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9174: important to keep this file up to date and conforming to the
9175: existing format, because it will be used by scripts to
9176: automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9177: sites. Additionally, check the
1.76 rillig 9178: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9179: for the package you updated or removed, in case it was mentioned
9180: there.</p>
9181: <p>When the <code class="varname">PKGREVISION</code> of a package is
9182: bumped, the change should appear in
1.93 ! rillig 9183: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9184: related or otherwise relevant. Mass bumps that result from a
9185: dependency being updated should not be mentioned. In all other
9186: cases it's the developer's decision.</p>
9187: <p>There is a make target that helps in creating proper
1.93 ! rillig 9188: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span><strong class="command">make
1.75 rillig 9189: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9190: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 ! rillig 9191: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9192: file is up-to-date (to avoid having to resolve conflicts later-on)
9193: and then to <span><strong class="command">cd</strong></span> to the package directory. For
9194: package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
9195: For new packages, or package moves or removals, set the
9196: <code class="varname">CTYPE</code> variable on the command line to "Added",
9197: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.76 rillig 9198: in <code class="filename">/etc/mk.conf</code> if your local login name is
1.75 rillig 9199: not the same as your NetBSD login name. Don't forget to commit
1.93 ! rillig 9200: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75 rillig 9201: </div>
9202: <div class="sect1" lang="en">
9203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9204: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9205: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9206: access to the pkgsrc repository. Please remember that cvs
9207: imports files relative to the current working directory, and that
9208: the pathname that you
9209: give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
9210: to place the files in the repository. Newly created packages should be
9211: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9212: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9213: <pre class="programlisting">
9214: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9215: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
9216: </pre>
1.87 wiz 9217: <p>Remember to move the directory from which you imported out of
1.75 rillig 9218: the way, or cvs will complain the next time you “<span class="quote">cvs
9219: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9220: package to the category's <code class="filename">Makefile</code>.</p>
9221: <p>The commit message of the initial import should include part of the
1.76 rillig 9222: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9223: what the package is/does.</p>
9224: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9225: add</span>” because the former gets everything with a single command,
1.87 wiz 9226: and provides a consistent tag.</p>
1.75 rillig 9227: </div>
9228: <div class="sect1" lang="en">
9229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9230: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9231: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9232: changes between old and new versions into the commit log when updating
1.87 wiz 9233: a package. There are various reasons for this:</p>
1.75 rillig 9234: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9235: <li><p>A URL is volatile, and can change over time. It may go away completely
9236: or its information may be overwritten by newer information.</p></li>
9237: <li><p>Having the change information between old and new versions in our CVS
9238: repository is very useful for people who use either cvs or anoncvs.</p></li>
9239: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9240: repository is very useful for people who read the pkgsrc-changes mailing
9241: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9242: the package.</p></li>
1.75 rillig 9243: </ul></div>
1.87 wiz 9244: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9245: has been released, it should not automatically be upgraded in the CVS
9246: repository. We prefer to be conservative in the packages that are
9247: included in pkgsrc - development or beta packages are not really the
9248: best thing for most places in which pkgsrc is used. Please use your
9249: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9250: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9251: </div>
9252: <div class="sect1" lang="en">
9253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9254: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75 rillig 9255: <div class="orderedlist"><ol type="1">
9256: <li><p>Make a copy of the directory somewhere else.</p></li>
9257: <li>
9258: <p>Remove all CVS dirs.</p>
1.87 wiz 9259: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9260: <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 9261: <p>and use that for further work.</p>
1.75 rillig 9262: </li>
9263: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9264: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9265: instead of “<span class="quote">../../category/package</span>”.</p></li>
9266: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
9267: place.</p></li>
9268: <li>
9269: <p>Check if any package depends on it:
9270: </p>
9271: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9272: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9273: </li>
9274: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
9275: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9276: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9277: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9278: <li>
9279: <p>Commit the changed and removed files:</p>
9280: <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 9281: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9282: </li>
9283: </ol></div>
9284: </div>
9285: </div>
9286: <div class="chapter" lang="en">
9287: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9288: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9289: <p>This section contains the answers to questions that may
9290: arise when you are writing a package. If you don't find your
9291: question answered here, first have a look in the other chapters,
9292: and if you still don't have the answer, ask on the
9293: <code class="literal">pkgsrc-users</code> mailing list.</p>
9294: <div class="qandaset">
9295: <dl>
1.93 ! rillig 9296: <dt>21.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9297: MAKEFLAGS, .MAKEFLAGS and
9298: MAKE_FLAGS?</a>
9299: </dt>
1.93 ! rillig 9300: <dt>21.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9301: MAKE, GMAKE and
9302: MAKE_PROGRAM?</a>
9303: </dt>
1.93 ! rillig 9304: <dt>21.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9305: CC, PKG_CC and
9306: PKGSRC_COMPILER?</a>
9307: </dt>
1.93 ! rillig 9308: <dt>21.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9309: BUILDLINK_LDFLAGS,
9310: BUILDLINK_LDADD and
9311: BUILDLINK_LIBS?</a>
9312: </dt>
1.93 ! rillig 9313: <dt>21.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9314: VARNAME=BUILDLINK_PREFIX.foo
9315: say it's empty?</a>
9316: </dt>
1.93 ! rillig 9317: <dt>21.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9318: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9319: don't understand the := inside
9320: it.</a>
9321: </dt>
1.93 ! rillig 9322: <dt>21.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9323: developers?</a>
9324: </dt>
1.93 ! rillig 9325: <dt>21.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9326: documentation?</a>
9327: </dt>
1.92 rillig 9328: <dt>21.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
9329: do?</a>
9330: </dt>
1.75 rillig 9331: </dl>
9332: <table border="0" summary="Q and A Set">
9333: <col align="left" width="1%">
9334: <tbody>
9335: <tr class="question">
9336: <td align="left" valign="top">
1.93 ! rillig 9337: <a name="devfaq.makeflags"></a><a name="id2686068"></a><b>21.1.</b>
1.75 rillig 9338: </td>
9339: <td align="left" valign="top"><p>What is the difference between
9340: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9341: <code class="varname">MAKE_FLAGS</code>?</p></td>
9342: </tr>
9343: <tr class="answer">
1.91 rillig 9344: <td align="left" valign="top"></td>
1.75 rillig 9345: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9346: 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
9347: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9348: the <code class="varname">MAKE_PROGRAM</code> when building the
9349: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9350: </tr>
9351: <tr class="question">
9352: <td align="left" valign="top">
1.93 ! rillig 9353: <a name="devfaq.make"></a><a name="id2686106"></a><b>21.2.</b>
1.75 rillig 9354: </td>
9355: <td align="left" valign="top"><p>What is the difference between
9356: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9357: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9358: </tr>
9359: <tr class="answer">
1.91 rillig 9360: <td align="left" valign="top"></td>
1.75 rillig 9361: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9362: <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
9363: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9364: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9365: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9366: Make program that is used for building the
9367: package.</p></td>
9368: </tr>
9369: <tr class="question">
9370: <td align="left" valign="top">
1.93 ! rillig 9371: <a name="devfaq.cc"></a><a name="id2686147"></a><b>21.3.</b>
1.75 rillig 9372: </td>
9373: <td align="left" valign="top"><p>What is the difference between
9374: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9375: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9376: </tr>
9377: <tr class="answer">
1.91 rillig 9378: <td align="left" valign="top"></td>
1.75 rillig 9379: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9380: compiler, which can be configured by the pkgsrc user.
9381: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9382: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9383: path to a compiler, but the type of compiler that should be
1.76 rillig 9384: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9385: information about the latter variable.</p></td>
9386: </tr>
9387: <tr class="question">
9388: <td align="left" valign="top">
1.93 ! rillig 9389: <a name="devfaq.bl3flags"></a><a name="id2686186"></a><b>21.4.</b>
1.75 rillig 9390: </td>
9391: <td align="left" valign="top"><p>What is the difference between
9392: <code class="varname">BUILDLINK_LDFLAGS</code>,
9393: <code class="varname">BUILDLINK_LDADD</code> and
9394: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9395: </tr>
9396: <tr class="answer">
1.91 rillig 9397: <td align="left" valign="top"></td>
1.75 rillig 9398: <td align="left" valign="top"><p>[FIXME]</p></td>
9399: </tr>
9400: <tr class="question">
9401: <td align="left" valign="top">
1.93 ! rillig 9402: <a name="devfaq.bl3prefix"></a><a name="id2686206"></a><b>21.5.</b>
1.75 rillig 9403: </td>
9404: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
9405: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9406: say it's empty?</p></td>
9407: </tr>
9408: <tr class="answer">
1.91 rillig 9409: <td align="left" valign="top"></td>
1.75 rillig 9410: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9411: available in the “<span class="quote">wrapper</span>” phase and later. To
9412: “<span class="quote">simulate</span>” the wrapper phase, append
9413: <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
9414: command.</p></td>
9415: </tr>
1.78 rillig 9416: <tr class="question">
9417: <td align="left" valign="top">
1.93 ! rillig 9418: <a name="devfaq.master_sites"></a><a name="id2686305"></a><b>21.6.</b>
1.78 rillig 9419: </td>
9420: <td align="left" valign="top"><p>What does
9421: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9422: don't understand the <code class="literal">:=</code> inside
9423: it.</p></td>
9424: </tr>
9425: <tr class="answer">
1.91 rillig 9426: <td align="left" valign="top"></td>
1.78 rillig 9427: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9428: assignment operator, like you might expect at first sight.
9429: Instead, it is a degenerate form of
9430: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9431: 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
9432: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9433: case of <code class="varname">MASTER_SITE_*</code>,
9434: <em class="replaceable"><code>old_string</code></em> is the empty string and
9435: <em class="replaceable"><code>new_string</code></em> is
9436: <code class="literal">package/</code>. That's where the
9437: <code class="literal">:</code> and the <code class="literal">=</code> fall
9438: together.</p></td>
9439: </tr>
9440: <tr class="question">
9441: <td align="left" valign="top">
1.93 ! rillig 9442: <a name="devfaq.mailinglists"></a><a name="id2686381"></a><b>21.7.</b>
1.78 rillig 9443: </td>
9444: <td align="left" valign="top"><p>Which mailing lists are there for package
9445: developers?</p></td>
9446: </tr>
9447: <tr class="answer">
1.91 rillig 9448: <td align="left" valign="top"></td>
1.78 rillig 9449: <td align="left" valign="top"><div class="variablelist"><dl>
9450: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
9451: <dd><p>This is a list for technical discussions related
9452: to pkgsrc development, e.g. soliciting feedback for changes to
9453: pkgsrc infrastructure, proposed new features, questions related
9454: to porting pkgsrc to a new platform, advice for maintaining a
9455: package, patches that affect many packages, help requests moved
9456: from pkgsrc-users when an infrastructure bug is found,
9457: etc.</p></dd>
9458: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
9459: <dd><p>All bug reports in category "pkg" sent with
9460: <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
9461: directly; use one of the other mailing
9462: lists.</p></dd>
9463: </dl></div></td>
9464: </tr>
1.80 rillig 9465: <tr class="question">
9466: <td align="left" valign="top">
1.93 ! rillig 9467: <a name="devfaq.documentation"></a><a name="id2686420"></a><b>21.8.</b>
1.80 rillig 9468: </td>
9469: <td align="left" valign="top"><p>Where is the pkgsrc
9470: documentation?</p></td>
9471: </tr>
9472: <tr class="answer">
1.91 rillig 9473: <td align="left" valign="top"></td>
1.80 rillig 9474: <td align="left" valign="top">
9475: <p>There are many places where you can find
9476: documentation about pkgsrc:</p>
9477: <div class="itemizedlist"><ul type="disc">
9478: <li><p>The pkgsrc guide (this document) is a collection
9479: of chapters that explain large parts of pkgsrc, but some
9480: chapters tend to be outdated. Which ones they are is hard to
9481: say.</p></li>
9482: <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
9483: about certain features, announcements of new parts of the pkgsrc
9484: infrastructure and sometimes even announcements that a certain
9485: feature has been marked as obsolete. The benefit here is that
9486: each message has a date appended to it.</p></li>
9487: <li><p>Many of the files in the
9488: <code class="filename">mk/</code> directory start with a comment that
9489: describes the purpose of the file and how it can be used by the
1.92 rillig 9490: pkgsrc user and package authors. An easy way to find this
9491: documentation is to run <span><strong class="command">bmake
9492: help</strong></span>.</p></li>
1.80 rillig 9493: <li><p>The CVS log messages are a rich source of
9494: information, but they tend to be highly abbreviated, especially
9495: for actions that occur often. Some contain a detailed
9496: description of what has changed, but they are geared towards the
9497: other pkgsrc developers, not towards an average pkgsrc user.
9498: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9499: don't know what has been before, these messages may not be worth
9500: too much to you.</p></li>
9501: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9502: documented</span>”, that is the documentation exists only in the
9503: mind of the developer who wrote the code. To get this
1.93 ! rillig 9504: information, use the <span><strong class="command">cvs annotate</strong></span> command
1.80 rillig 9505: to see who has written it and ask on the
9506: <code class="literal">tech-pkg</code> mailing list, so that others can
9507: find your questions later (see above). To be sure that the
9508: developer in charge reads the mail, you may CC him or
9509: her.</p></li>
9510: </ul></div>
9511: </td>
9512: </tr>
1.92 rillig 9513: <tr class="question">
9514: <td align="left" valign="top">
1.93 ! rillig 9515: <a name="devfaq.too-much-time"></a><a name="id2686482"></a><b>21.9.</b>
1.92 rillig 9516: </td>
9517: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9518: do?</p></td>
9519: </tr>
9520: <tr class="answer">
9521: <td align="left" valign="top"></td>
9522: <td align="left" valign="top">
1.93 ! rillig 9523: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9524: anyway.</p>
9525: <div class="itemizedlist"><ul type="disc">
9526: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
9527: <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
9528: will tell you about newer versions of installed packages that are
9529: available, but not yet updated in pkgsrc.</p></li>
9530: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
9531: — it contains a list of suggested new packages and a list of
9532: cleanups and enhancements for pkgsrc that would be nice to
9533: have.</p></li>
9534: <li><p>Review packages for which review was requested on
9535: the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9536: mailing list.</p></li>
9537: </ul></div>
9538: </td>
9539: </tr>
1.75 rillig 9540: </tbody>
9541: </table>
9542: </div>
9543: </div>
1.85 jmmv 9544: <div class="chapter" lang="en">
9545: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9546: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9547: <div class="toc">
9548: <p><b>Table of Contents</b></p>
9549: <dl>
1.90 rillig 9550: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9551: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9552: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9553: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 9554: </dl>
9555: </div>
9556: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
9557: site</a>:</p>
9558: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9559: environment, an intuitive and attractive desktop for users, and the
9560: GNOME development platform, an extensive framework for building
9561: applications that integrate into the rest of the desktop.</p></blockquote></div>
9562: <p>pkgsrc provides a seamless way to automatically build and install
9563: a complete GNOME environment <span class="emphasis"><em>under many different
9564: platforms</em></span>. We can say with confidence that pkgsrc is one of
9565: the most advanced build and packaging systems for GNOME due to its
9566: included technologies buildlink3, the wrappers and tools framework and
9567: automatic configuration file management. Lots of efforts are put into
9568: achieving a completely clean deinstallation of installed software
9569: components.</p>
9570: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9571: the above also means that great efforts are put into making GNOME work
9572: under this operating system. Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9573: pkgsrc as its preferred packaging system, contributing lots of
9574: portability fixes to make GNOME build and install under it.</p>
9575: <p>This chapter is aimed at pkgsrc developers and other people
9576: interested in helping our GNOME porting and packaging efforts. It
9577: provides instructions on how to manage the existing packages and some
9578: important information regarding their internals.</p>
9579: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9580: <h3 class="title">We need your help!</h3>
9581: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9582: and GNOME and are willing to learn new exciting stuff, please jump
9583: straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9584: work</a> list! There is still a long way to go to get a
9585: fully-functional GNOME desktop under NetBSD and we need your help to
9586: achieve it!</p>
9587: </div>
9588: <div class="sect1" lang="en">
9589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9590: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85 jmmv 9591: <p>pkgsrc includes three GNOME-related meta packages:</p>
9592: <div class="itemizedlist"><ul type="disc">
1.91 rillig 9593: <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 9594: the core GNOME desktop environment. It only includes the necessary
9595: bits to get it to boot correctly, although it may lack important
9596: functionality for daily operation. The idea behind this package is
9597: to let end users build their own configurations on top of this one,
9598: first installing this meta package to achieve a functional setup and
9599: then adding individual applications.</p></li>
1.91 rillig 9600: <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 9601: complete installation of the GNOME platform and desktop as defined
9602: by the GNOME project; this is based on the components distributed in
9603: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9604: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9605: official FTP server. Developer-only tools found in those
9606: directories are not installed unless required by some other
9607: component to work properly. Similarly, packages from the bindings
9608: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9609: in unless required as a dependency for an end-user component. This
1.91 rillig 9610: 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>
9611: <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 9612: Installs all the tools required to build a GNOME component when
9613: fetched from the CVS repository. These are required to let the
9614: <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
9615: </ul></div>
9616: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9617: sorted in a way that eases updates: a package may depend on other
9618: packages listed before it but not on any listed after it. It is very
9619: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9620: change it to alphabetical sorting!</em></span></p>
9621: </div>
9622: <div class="sect1" lang="en">
9623: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9624: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9625: <p>Almost all GNOME applications are written in C and use a common
9626: set of tools as their build system. Things get different with the new
9627: bindings to other languages (such as Python), but the following will
9628: give you a general idea on the minimum required tools:</p>
9629: <div class="itemizedlist"><ul type="disc">
9630: <li>
9631: <p>Almost all GNOME applications use the GNU Autotools as their
9632: build system. As a general rule you will need to tell this to your
9633: package:</p>
9634: <pre class="programlisting">GNU_CONFIGURE=yes
9635: USE_LIBTOOL=yes
9636: USE_TOOLS+=gmake</pre>
9637: </li>
9638: <li>
9639: <p>If the package uses pkg-config to detect dependencies, add this
9640: tool to the list of required utilities:</p>
9641: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9642: <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 9643: the end of the build process to ensure that you did not miss to
9644: specify any dependency in your package and that the version
9645: requirements are all correct.</p>
9646: </li>
1.93 ! rillig 9647: <li><p>If the package uses intltool, be sure to add
! 9648: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9649: to handle dependencies and to force the package to use the latest
9650: available version.</p></li>
9651: <li>
9652: <p>If the package uses gtk-doc (a documentation generation
9653: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9654: tool is rather big and the distfile should come with pregenerated
9655: documentation anyway; if it does not, it is a bug that you ought to
9656: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9657: the default):</p>
9658: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9659: <p>The default location of installed HTML files
9660: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9661: and should not be changed unless the package insists on installing
9662: them somewhere else. Otherwise programs as
9663: <span><strong class="command">devhelp</strong></span> will not be able to open them. You can
9664: do that with an entry similar to:</p>
9665: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9666: </li>
9667: </ul></div>
9668: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9669: files under the installation prefix to maintain databases. In this
9670: context, shared means that those exact same directories and files are
9671: used among several different packages, leading to conflicts in the
9672: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9673: handle the most common cases, so you have to forget about using
9674: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9675: omitting shared files from them. If you find yourself doing those,
9676: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9677: <p>The following table lists the common situations that result in
9678: using shared directories or files. For each of them, the appropriate
9679: solution is given. After applying the solution be sure to
9680: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9681: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
9682: <div class="table">
1.90 rillig 9683: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9684: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9685: <colgroup>
9686: <col>
9687: <col>
9688: </colgroup>
9689: <thead><tr>
9690: <th>If the package...</th>
9691: <th>Then...</th>
9692: </tr></thead>
9693: <tbody>
9694: <tr>
9695: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.90 rillig 9696: <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 9697: </tr>
9698: <tr>
9699: <td>Installs icons under the
9700: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9701: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.90 rillig 9702: <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 9703: </tr>
9704: <tr>
9705: <td>Installs files under
9706: <code class="filename">share/mime/packages</code>.</td>
1.90 rillig 9707: <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 9708: </tr>
9709: <tr>
9710: <td>Installs <code class="filename">.desktop</code> files under
9711: <code class="filename">share/applications</code> and these include MIME
9712: information.</td>
1.90 rillig 9713: <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 9714: </tr>
9715: </tbody>
1.91 rillig 9716: </table></div>
1.85 jmmv 9717: </div>
1.91 rillig 9718: <br class="table-break">
1.85 jmmv 9719: </div>
9720: <div class="sect1" lang="en">
9721: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9722: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9723: <p>When seeing GNOME as a whole, there are two kinds of
9724: updates:</p>
9725: <div class="variablelist"><dl>
9726: <dt><span class="term">Major update</span></dt>
9727: <dd>
9728: <p>Given that there is still a very long way for GNOME 3 (if it
9729: ever appears), we consider a major update one that goes from a
9730: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9731: where <code class="literal">Y</code> is even and greater than
9732: <code class="literal">X</code>. These are hard to achieve because they
9733: introduce lots of changes in the components' code and almost all
9734: GNOME distfiles are updated to newer versions. Some of them can
9735: even break API and ABI compatibility with the previous major
9736: version series. As a result, the update needs to be done all at
9737: once to minimize breakage.</p>
9738: <p>A major update typically consists of around 80 package
9739: updates and the addition of some new ones.</p>
9740: </dd>
9741: <dt><span class="term">Minor update</span></dt>
9742: <dd>
9743: <p>We consider a minor update one that goes from a
9744: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9745: one where <code class="literal">Y</code> is greater than
9746: <code class="literal">X</code>. These are easy to achieve because they do
9747: not update all GNOME components, can be done in an incremental way
9748: and do not break API nor ABI compatibility.</p>
9749: <p>A minor update typically consists of around 50 package
9750: updates, although the numbers here may vary a lot.</p>
9751: </dd>
9752: </dl></div>
9753: <p>In order to update the GNOME components in pkgsrc to a new stable
9754: release (either major or minor), the following steps should be
9755: followed:</p>
9756: <div class="orderedlist"><ol type="1">
9757: <li>
9758: <p>Get a list of all the tarballs that form the new release by
9759: using the following commands. These will leave the full list of the
9760: components's distfiles into the <code class="filename">list.txt</code>
9761: file:</p>
1.88 wiz 9762: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9763: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9764: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9765: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9766: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9767: awk '{ print $9 }' >>list.txt</code></strong></pre>
9768: </li>
9769: <li><p>Open each meta package's <code class="filename">Makefile</code> and
9770: bump their version to the release you are updating them to. The
9771: three meta packages should be always consistent with versioning.
9772: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9773: in them.</p></li>
9774: <li>
9775: <p>For each meta package, update all its
9776: <code class="varname">DEPENDS</code> lines to match the latest versions as
9777: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9778: newer version (even if found in the FTP) because the meta packages
9779: are supposed to list the exact versions that form a specific GNOME
9780: release. Exceptions are permitted here if a newer version solves a
9781: serious issue in the overall desktop experience; these typically
9782: come in the form of a revision bump in pkgsrc, not in newer versions
9783: from the developers.</p>
9784: <p>Packages not listed in the <code class="filename">list.txt</code> file
9785: should be updated to the latest version available (if found in
9786: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 9787: 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 9788: </li>
9789: <li>
9790: <p>Generate a patch from the modified meta packages and extract the
9791: list of "new" lines. This will provide you an outline on what
9792: packages need to be updated in pkgsrc and in what order:</p>
1.93 ! rillig 9793: <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 9794: </li>
9795: <li><p>For major desktop updates it is recommended to zap all your
9796: installed packages and start over from scratch at this point.</p></li>
9797: <li><p>Now comes the longest step by far: iterate over the contents
9798: of <code class="filename">todo.txt</code> and update the packages listed in
9799: it in order. For major desktop updates none of these should be
1.93 ! rillig 9800: committed until the entire set is completed because there are chances
1.85 jmmv 9801: of breaking not-yet-updated packages.</p></li>
9802: <li><p>Once the packages are up to date and working, commit them to
9803: the tree one by one with appropriate log messages. At the end,
9804: commit the three meta package updates and all the corresponding
9805: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9806: <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>
9807: </ol></div>
9808: </div>
9809: <div class="sect1" lang="en">
9810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9811: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 9812: <p>GNOME is a very big component in pkgsrc which approaches 100
9813: packages. Please, it is very important that you always, always,
9814: <span class="strong"><strong>always</strong></span> feed back any portability
1.93 ! rillig 9815: 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 9816: their attention on portability issues and to ensure that future versions
9817: can be built out-of-the box on NetBSD. The less custom patches in
9818: pkgsrc, the easier further updates are. Those developers in charge of
9819: issuing major GNOME updates will be grateful if you do that.</p>
9820: <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
9821: Bugzilla</a>. Not all components use these to track bugs, but most
9822: of them do. Do not be short on your reports: always provide detailed
9823: explanations of the current failure, how it can be improved to achieve
9824: maximum portability and, if at all possible, provide a patch against CVS
9825: head. The more verbose you are, the higher chances of your patch being
9826: accepted.</p>
9827: <p>Also, please avoid using preprocessor magic to fix portability
9828: issues. While the FreeBSD GNOME people are doing a great job in porting
9829: GNOME to their operating system, the official GNOME sources are now
9830: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9831: and similar macros. This hurts portability. Please see our patching
1.93 ! rillig 9832: guidelines (<a href="#components.patches.guidelines" title="10.3.4. Patching guidelines">Section 10.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 9833: details.</p>
9834: </div>
9835: </div>
1.75 rillig 9836: </div>
9837: <div class="part" lang="en">
9838: <div class="titlepage"><div><div><h1 class="title">
9839: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
9840: <div class="partintro" lang="en">
9841: <div></div>
9842: <p>This part of the guide deals with everything
9843: from the infrastructure that is behind the interfaces described
9844: in the developer's guide. A casual package maintainer should not
9845: need anything from this part.</p>
9846: <div class="toc">
9847: <p><b>Table of Contents</b></p>
9848: <dl>
1.90 rillig 9849: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 9850: <dd><dl>
1.90 rillig 9851: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
9852: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
9853: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75 rillig 9854: <dd><dl>
1.90 rillig 9855: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
9856: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75 rillig 9857: </dl></dd>
1.90 rillig 9858: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
9859: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 9860: <dd><dl>
1.90 rillig 9861: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
9862: <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 9863: </dl></dd>
1.90 rillig 9864: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81 rillig 9865: <dd><dl>
1.90 rillig 9866: <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>
9867: <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 9868: </dl></dd>
9869: </dl></dd>
1.90 rillig 9870: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 9871: <dd><dl>
1.90 rillig 9872: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
9873: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
9874: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 9875: <dd><dl>
1.90 rillig 9876: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
9877: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 9878: </dl></dd>
9879: </dl></dd>
1.90 rillig 9880: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 9881: <dd><dl>
1.90 rillig 9882: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
9883: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 9884: </dl></dd>
9885: </dl>
9886: </div>
9887: </div>
9888: <div class="chapter" lang="en">
9889: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9890: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 9891: <div class="toc">
9892: <p><b>Table of Contents</b></p>
9893: <dl>
1.90 rillig 9894: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
9895: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
9896: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 9897: <dd><dl>
1.90 rillig 9898: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
9899: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 9900: </dl></dd>
1.90 rillig 9901: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
9902: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 9903: <dd><dl>
1.90 rillig 9904: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
9905: <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 9906: </dl></dd>
1.90 rillig 9907: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 9908: <dd><dl>
1.90 rillig 9909: <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>
9910: <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 9911: </dl></dd>
9912: </dl>
9913: </div>
9914: <p>The pkgsrc infrastructure consists of many small Makefile
9915: fragments. Each such fragment needs a properly specified
9916: interface. This chapter explains how such an interface looks
9917: like.</p>
9918: <div class="sect1" lang="en">
9919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9920: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 9921: <p>Whenever a variable is defined in the pkgsrc
9922: infrastructure, the location and the way of definition provide
9923: much information about the intended use of that variable.
9924: Additionally, more documentation may be found in a header
9925: comment or in this pkgsrc guide.</p>
9926: <p>A special file is
9927: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9928: variables that are intended to be user-defined. They are either
9929: defined using the <code class="literal">?=</code> operator or they are
9930: left undefined because defining them to anything would
9931: effectively mean “<span class="quote">yes</span>”. All these variables may be
9932: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9933: file.</p>
9934: <p>Outside this file, the following conventions apply:
9935: Variables that are defined using the <code class="literal">?=</code>
9936: operator may be overridden by a package.</p>
9937: <p>Variables that are defined using the <code class="literal">=</code>
9938: operator may be used read-only at run-time.</p>
9939: <p>Variables whose name starts with an underscore must not be
9940: accessed outside the pkgsrc infrastructure at all. They may
9941: change without further notice.</p>
9942: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9943: <h3 class="title">Note</h3>
9944: <p>These conventions are currently not applied
9945: consistently to the complete pkgsrc
9946: infrastructure.</p>
9947: </div>
9948: </div>
9949: <div class="sect1" lang="en">
9950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9951: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 9952: <p>All variables that contain lists of things should default
9953: to being empty. Two examples that do not follow this rule are
9954: <code class="varname">USE_LANGUAGES</code> and
9955: <code class="varname">DISTFILES</code>. These variables cannot simply be
9956: modified using the <code class="literal">+=</code> operator in package
9957: <code class="filename">Makefile</code>s (or other files included by
9958: them), since there is no guarantee whether the variable is
9959: already set or not, and what its value is. In the case of
9960: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
9961: the default value and just define it as in the following
9962: example.</p>
9963: <pre class="programlisting">
9964: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9965: </pre>
9966: <p>Because of the selection of this default value, the same
9967: value appears in many package Makefiles. Similarly for
9968: <code class="varname">USE_LANGUAGES</code>, but in this case the default
9969: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
9970: doesn't stand out. Nevertheless it is mentioned in many
9971: files.</p>
9972: </div>
9973: <div class="sect1" lang="en">
9974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9975: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75 rillig 9976: <div class="sect2" lang="en">
9977: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9978: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75 rillig 9979: <p>Variable evaluation takes place either at load time or at
9980: runtime, depending on the context in which they occur. The
9981: contexts where variables are evaluated at load time are:</p>
9982: <div class="itemizedlist"><ul type="disc">
9983: <li><p>The right hand side of the <code class="literal">:=</code>
9984: and <code class="literal">!=</code> operators,</p></li>
9985: <li><p>Make directives like <code class="literal">.if</code> or
9986: <code class="literal">.for</code>,</p></li>
9987: <li><p>Dependency lines.</p></li>
9988: </ul></div>
9989: <p>A special exception are references to the iteration
9990: variables of <code class="literal">.for</code> loops, which are expanded
9991: inline, no matter in which context they appear.</p>
9992: <p>As the values of variables may change during load time,
9993: care must be taken not to evaluate them by accident. Typical
9994: examples for variables that should not be evaluated at load time
9995: are <code class="varname">DEPENDS</code> and
9996: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9997: clear, here is an example:</p>
9998: <pre class="programlisting">
9999: CONFIGURE_ARGS= # none
10000: CFLAGS= -O
10001: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10002:
1.75 rillig 10003: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10004:
1.75 rillig 10005: CFLAGS+= -Wall
10006: </pre>
10007: <p>This code shows how the use of the <code class="literal">:=</code>
10008: operator can quickly lead to unexpected results. The first
10009: paragraph is fairly common code. The second paragraph evaluates
10010: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10011: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10012: <code class="literal">-Wall</code> is appended to the
10013: <code class="varname">CFLAGS</code>, but this addition will not appear in
10014: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10015: paragraphs from above typically occur in completely unrelated
10016: files.</p>
10017: </div>
10018: <div class="sect2" lang="en">
10019: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10020: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75 rillig 10021: <p>After all the files have been loaded, the values of the
10022: variables cannot be changed anymore. Variables that are used in
10023: the shell commands are expanded at this point.</p>
10024: </div>
10025: </div>
10026: <div class="sect1" lang="en">
10027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10028: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10029: <p>There are many ways in which the definition and use of a
10030: variable can be restricted in order to detect bugs and
10031: violations of the (mostly unwritten) policies. See the
10032: <code class="literal">pkglint</code> developer's documentation for further
10033: details.</p>
10034: </div>
10035: <div class="sect1" lang="en">
10036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10037: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10038: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10039: of the following classes. Cases where a file falls into more
10040: than one class should be avoided as it often leads to subtle
10041: bugs.</p>
10042: <div class="sect2" lang="en">
10043: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10044: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10045: <p>In a traditional imperative programming language some of
1.76 rillig 10046: the <code class="filename">.mk</code> files could be described as
1.89 rillig 10047: procedures. They take some input parameters and—after
10048: inclusion—provide a result in output parameters. Since all
1.76 rillig 10049: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10050: care must be taken not to use parameter names that have already
10051: another meaning. For example, <code class="varname">PKGNAME</code> is a
10052: bad choice for a parameter name.</p>
10053: <p>Procedures are completely evaluated at preprocessing time.
10054: That is, when calling a procedure all input parameters must be
10055: completely resolvable. For example,
10056: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10057: parameter since it is very likely that further text will be
10058: added after calling the procedure, which would effectively apply
10059: the procedure to only a part of the variable. Also, references
10060: to other variables wit will be modified after calling the
10061: procedure.</p>
10062: <p>A procedure can declare its output parameters either as
10063: suitable for use in preprocessing directives or as only
10064: available at runtime. The latter alternative is for variables
10065: that contain references to other runtime variables.</p>
10066: <p>Procedures shall be written such that it is possible to
10067: call the procedure more than once. That is, the file must not
10068: contain multiple-inclusion guards.</p>
10069: <p>Examples for procedures are
1.76 rillig 10070: <code class="filename">mk/bsd.options.mk</code> and
10071: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10072: that the parameters are evaluated at load time, they should be
10073: assigned using the <code class="literal">:=</code> operator, which should
10074: be used only for this purpose.</p>
10075: </div>
10076: <div class="sect2" lang="en">
10077: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10078: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10079: <p>Action files take some input parameters and may define
10080: runtime variables. They shall not define loadtime variables.
10081: There are action files that are included implicitly by the
10082: pkgsrc infrastructure, while other must be included
10083: explicitly.</p>
10084: <p>An example for action files is
1.76 rillig 10085: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10086: </div>
10087: </div>
1.81 rillig 10088: <div class="sect1" lang="en">
10089: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10090: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10091: <p>Package <code class="filename">Makefile</code>s usually consist of
10092: a set of variable definitions, and include the file
10093: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10094: Before that, they may also include various other
10095: <code class="filename">*.mk</code> files if they need to query the
10096: availability of certain features like the type of compiler or
10097: the X11 implementation. Due to the heavy use of preprocessor
10098: directives like <code class="literal">.if</code> and
10099: <code class="literal">.for</code>, the order in which the files are loaded
10100: matters.</p>
10101: <p>This section describes at which point the various files
10102: are loaded and gives reasons for that order.</p>
10103: <div class="sect2" lang="en">
10104: <div class="titlepage"><div><div><h3 class="title">
1.93 ! rillig 10105: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code>
! 10106: </h3></div></div></div>
! 10107: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10108: is to define some essential variables like
10109: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10110: <code class="varname">MACHINE_ARCH</code>.</p>
10111: <p>Then, the user settings are loaded from the file specified
10112: in <code class="varname">MAKECONF</code>. If the bmake command from pkgsrc
10113: is used, <code class="varname">MAKECONF</code> defaults to
10114: <code class="filename"><em class="replaceable"><code>${prefix}</code></em>/etc/mk.conf</code>.
10115: 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
10116: <code class="filename">/etc/mk.conf</code>. After that, those variables
10117: that have not been overridden by the user are loaded from
10118: <code class="filename">mk/defaults/mk.conf</code>.</p>
10119: <p>After the user settings, the system settings and platform
10120: settings are loaded, which may override the user
10121: settings.</p>
10122: <p>Then, the tool definitions are loaded. The tool wrappers
10123: are not yet in effect. This only happens when building a
10124: package, so the proper variables must be used instead of the
10125: direct tool names.</p>
10126: <p>As the last steps, some essential variables from the
10127: wrapper and the package system flavor are loaded, as well as the
10128: variables that have been cached in earlier phases of a package
10129: build.</p>
10130: </div>
10131: <div class="sect2" lang="en">
10132: <div class="titlepage"><div><div><h3 class="title">
1.93 ! rillig 10133: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code>
! 10134: </h3></div></div></div>
1.81 rillig 10135: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10136: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10137: loaded, which fill default values for those variables that have
1.93 ! rillig 10138: not been defined by the package. These variables may later
1.81 rillig 10139: be used even in unrelated files.</p>
10140: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10141: provides the target <code class="literal">error-check</code> that is added
10142: as a special dependency to all other targets that use
10143: <code class="varname">DELAYED_ERROR_MSG</code> or
10144: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10145: <p>Then, the package-specific hacks from
10146: <code class="filename">hacks.mk</code> are included.</p>
10147: <p>Then, various other files follow. Most of them don't have
10148: any dependencies on what they need to have included before or
10149: after them, though some do.</p>
10150: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10151: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10152: restricts the use of these variables to all the files that have
10153: been included before. Appearances in later files will be
10154: silently ignored.</p>
10155: <p>Then, the files for the main targets are included, in the
10156: order of later execution, though the actual order should not
10157: matter.</p>
10158: <p>At last, some more files are included that don't set any
10159: interesting variables but rather just define make targets to be
10160: executed.</p>
10161: </div>
10162: </div>
1.75 rillig 10163: </div>
10164: <div class="chapter" lang="en">
10165: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10166: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75 rillig 10167: <div class="toc">
10168: <p><b>Table of Contents</b></p>
10169: <dl>
1.90 rillig 10170: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10171: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10172: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10173: <dd><dl>
1.90 rillig 10174: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10175: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10176: </dl></dd>
10177: </dl>
10178: </div>
10179: <p>The pkgsrc infrastructure consists of a large codebase,
10180: and there are many corners where every little bit of a file is
10181: well thought out, making pkgsrc likely to fail as soon as
10182: anything is changed near those parts. To prevent most changes
10183: from breaking anything, a suite of regression tests should go
10184: along with every important part of the pkgsrc infrastructure.
10185: This chapter describes how regression tests work in pkgsrc and
10186: how you can add new tests.</p>
10187: <div class="sect1" lang="en">
10188: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10189: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10190: <p></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="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10195: <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 10196: provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
10197: can simply run that command, which will run all tests in the
1.76 rillig 10198: <code class="filename">regress</code> category.</p>
1.75 rillig 10199: </div>
10200: <div class="sect1" lang="en">
10201: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10202: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10203: <p>Every directory in the <code class="filename">regress</code>
10204: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10205: is considered a regression test. This file is a shell program
10206: that is included by the <span><strong class="command">pkg_regress</strong></span> command.
10207: The following functions can be overridden to suit your
10208: needs.</p>
10209: <div class="sect2" lang="en">
10210: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10211: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10212: <p>These functions do not take any parameters. They are all
10213: called in “<span class="quote">set -e</span>” mode, so you should be careful
10214: to check the exitcodes of any commands you run in the
10215: test.</p>
10216: <div class="variablelist"><dl>
10217: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10218: <dd><p>This function prepares the environment for the
10219: test. By default it does nothing.</p></dd>
10220: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10221: <dd><p>This function runs the actual test. By default,
10222: it calls <code class="varname">TEST_MAKE</code> with the arguments
10223: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10224: error messages into the file
10225: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10226: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10227: <dd><p>This function is run after the test and is
10228: typically used to compare the actual output from the one that is
10229: expected. It can make use of the various helper functions from
10230: the next section.</p></dd>
10231: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10232: <dd><p>This function cleans everything up after the
10233: test has been run. By default it does nothing.</p></dd>
10234: </dl></div>
10235: </div>
10236: <div class="sect2" lang="en">
10237: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10238: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10239: <div class="variablelist"><dl>
10240: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10241: <dd><p>This function compares the exitcode of the
10242: <span><strong class="command">do_test()</strong></span> function with its first parameter.
10243: If they differ, the test will fail.</p></dd>
10244: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10245: <dd><p>This function checks for each of its parameters
10246: if the output from <span><strong class="command">do_test()</strong></span> matches the
10247: extended regular expression. If it does not, the test will
10248: fail.</p></dd>
10249: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10250: <dd><p>This function checks for each of its parameters
10251: if the output from <span><strong class="command">do_test()</strong></span> does
10252: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10253: If any of the regular expressions matches, the test will
10254: fail.</p></dd>
10255: </dl></div>
10256: </div>
10257: </div>
10258: </div>
10259: <div class="chapter" lang="en">
10260: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10261: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10262: <div class="toc">
10263: <p><b>Table of Contents</b></p>
10264: <dl>
1.90 rillig 10265: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10266: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10267: </dl>
10268: </div>
10269: <p>The pkgsrc system has already been ported to many
10270: operating systems, hardware architectures and compilers. This
10271: chapter explains the necessary steps to make pkgsrc even more
10272: portable.</p>
10273: <div class="sect1" lang="en">
10274: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10275: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10276: <p>To port pkgsrc to a new operating system (called
10277: <code class="literal">MyOS</code> in this example), you need to touch the
10278: following files:</p>
10279: <div class="variablelist"><dl>
1.93 ! rillig 10280: <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 10281: <dd><p>This file contains some basic definitions, for
10282: example the name of the C
10283: compiler.</p></dd>
1.76 rillig 10284: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10285: <dd><p>Insert code that defines the variables
10286: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10287: <code class="varname">LOWER_OS_VERSION</code>,
10288: <code class="varname">LOWER_VENDOR</code>,
10289: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10290: <code class="varname">APPEND_ELF</code>, and the other variables that
10291: appear in this file.</p></dd>
1.93 ! rillig 10292: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10293: <dd><p>This file contains the platform-specific
10294: definitions that are used by pkgsrc. Start by copying one of the
10295: other files and edit it to your
10296: needs.</p></dd>
1.93 ! rillig 10297: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10298: <dd><p>This file contains a list of directories,
10299: together with their permission bits and ownership. These
10300: directories will be created automatically with every package
10301: that does not explicitly set <code class="varname">NO_MTREE</code>. There
10302: have been some discussions about whether this file is needed at
10303: all, but with no result.</p></dd>
1.93 ! rillig 10304: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10305: <dd><p>Just copy one of the pre-existing x11.dist files
10306: to your
1.76 rillig 10307: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10308: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10309: <dd><p>On some operating systems, the tools that are
10310: provided with the base system are not good enough for pkgsrc.
10311: 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
10312: narrow limit on the line length they can process. Therefore
10313: pkgsrc brings its own tools, which can be enabled
10314: here.</p></dd>
1.93 ! rillig 10315: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10316: <dd><p>This file defines the paths to all the tools
10317: that are needed by one or the other package in pkgsrc, as well
10318: as by pkgsrc itself. Find out where these tools are on your
10319: platform and add them.</p></dd>
10320: </dl></div>
10321: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10322: <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 10323: </div>
10324: <div class="sect1" lang="en">
10325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10326: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10327: <p>TODO</p>
10328: </div>
10329: </div>
10330: </div>
10331: <div class="appendix" lang="en">
10332: <div class="titlepage"><div><div><h2 class="title">
10333: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10334: <div class="toc">
10335: <p><b>Table of Contents</b></p>
10336: <dl>
10337: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10338: <dd><dl>
10339: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10340: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10341: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10342: <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>
10343: </dl></dd>
10344: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10345: </dl>
10346: </div>
10347: <p>We checked to find a piece of software that wasn't in the packages
10348: collection, and picked GNU bison. Quite why someone would want to have
10349: <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
10350: present in the tree is beyond us, but it's useful for the purposes of
10351: this exercise.</p>
10352: <div class="sect1" lang="en">
10353: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10354: <a name="example-files"></a>A.1. files</h2></div></div></div>
10355: <div class="sect2" lang="en">
10356: <div class="titlepage"><div><div><h3 class="title">
10357: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10358: <pre class="programlisting">
1.51 rillig 10359: # $NetBSD$
10360: #
1.1 grant 10361:
1.51 rillig 10362: DISTNAME= bison-1.25
10363: CATEGORIES= devel
10364: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10365:
1.51 rillig 10366: MAINTAINER= thorpej@NetBSD.org
10367: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10368: COMMENT= GNU yacc clone
1.1 grant 10369:
1.51 rillig 10370: GNU_CONFIGURE= yes
10371: INFO_FILES= bison.info
1.1 grant 10372:
1.51 rillig 10373: .include "../../mk/bsd.pkg.mk"
1.1 grant 10374: </pre>
1.75 rillig 10375: </div>
10376: <div class="sect2" lang="en">
10377: <div class="titlepage"><div><div><h3 class="title">
10378: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10379: <pre class="programlisting">
1.51 rillig 10380: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.75 rillig 10381: 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 10382: of the NetBSD source tree is beyond me.
1.1 grant 10383: </pre>
1.75 rillig 10384: </div>
10385: <div class="sect2" lang="en">
10386: <div class="titlepage"><div><div><h3 class="title">
10387: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10388: <pre class="programlisting">
1.51 rillig 10389: @comment $NetBSD$
10390: bin/bison
10391: man/man1/bison.1.gz
10392: share/bison.simple
10393: share/bison.hairy
1.1 grant 10394: </pre>
1.75 rillig 10395: </div>
10396: <div class="sect2" lang="en">
10397: <div class="titlepage"><div><div><h3 class="title">
1.93 ! rillig 10398: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
! 10399: </h3></div></div></div>
1.75 rillig 10400: <p>The NetBSD package system comes with
1.91 rillig 10401: <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 10402: which helps to check the contents of these
10403: files. After installation it is quite easy to use, just change to the
10404: directory of the package you wish to examine and execute
10405: <span><strong class="command">pkglint</strong></span>:</p>
10406: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10407: looks fine.</pre>
10408: <p>Depending on the supplied command line arguments (see pkglint(1)),
10409: more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
10410: -Wall</strong></span> for a very thorough check.</p>
10411: </div>
10412: </div>
10413: <div class="sect1" lang="en">
10414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10415: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10416: <p>Create the directory where the package lives,
10417: plus any auxiliary directories:</p>
10418: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10419: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10420: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10421: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10422: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90 rillig 10423: <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 10424: then continue with fetching the distfile:</p>
10425: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10426: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10427: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10428: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10429: ftp: Error retrieving file: 500 Internal error
10430:
10431: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10432: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10433: ftp: Error retrieving file: 500 Internal error
10434:
10435: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10436: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10437: Successfully retrieved file.</pre>
10438: <p>Generate the checksum of the distfile into
1.76 rillig 10439: <code class="filename">distinfo</code>:</p>
1.88 wiz 10440: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10441: <p>Now compile:</p>
10442: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10443: >> Checksum OK for bison-1.25.tar.gz.
10444: ===> Extracting for bison-1.25
10445: ===> Patching for bison-1.25
10446: ===> Ignoring empty patch directory
10447: ===> Configuring for bison-1.25
10448: creating cache ./config.cache
10449: checking for gcc... cc
10450: checking whether we are using GNU C... yes
10451: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10452: checking how to run the C preprocessor... cc -E
10453: checking for minix/config.h... no
10454: checking for POSIXized ISC... no
10455: checking whether cross-compiling... no
10456: checking for ANSI C header files... yes
10457: checking for string.h... yes
10458: checking for stdlib.h... yes
10459: checking for memory.h... yes
10460: checking for working const... yes
10461: checking for working alloca.h... no
10462: checking for alloca... yes
10463: checking for strerror... yes
10464: updating cache ./config.cache
10465: creating ./config.status
10466: creating Makefile
10467: ===> Building for bison-1.25
10468: 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
10469: 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
10470: 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
10471: 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
10472: 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 10473: 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 10474: 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
10475: 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
10476: 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
10477: 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
10478: 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
10479: 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
10480: 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
10481: 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
10482: 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
10483: 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
10484: 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
10485: 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
10486: 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
10487: 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
10488: 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
10489: 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
10490: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10491: rm -f bison.s1
1.75 rillig 10492: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10493: <p>Everything seems OK, so install the files:</p>
10494: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10495: >> Checksum OK for bison-1.25.tar.gz.
10496: ===> Installing for bison-1.25
10497: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10498: rm -f /usr/pkg/bin/bison
10499: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10500: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10501: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10502: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10503: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10504: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10505: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10506: ===> Registering installation for bison-1.25</pre>
10507: <p>You can now use bison, and also - if you decide so - remove it with
10508: <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
10509: binary package, do this now:</p>
10510: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10511: >> Checksum OK for bison-1.25.tar.gz.
10512: ===> Building package for bison-1.25
10513: Creating package bison-1.25.tgz
10514: Registering depends:.
1.75 rillig 10515: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10516: <p>Now that you don't need the source and object files
10517: any more, clean up:</p>
10518: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10519: ===> Cleaning for bison-1.25</pre>
10520: </div>
10521: </div>
10522: <div class="appendix" lang="en">
10523: <div class="titlepage"><div><div><h2 class="title">
10524: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10525: <div class="toc">
10526: <p><b>Table of Contents</b></p>
10527: <dl>
10528: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10529: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10530: </dl>
10531: </div>
10532: <div class="sect1" lang="en">
10533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10534: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10535: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10536: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10537: => figlet221.tar.gz doesn't seem to exist on this system.
10538: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10539: => [172219 bytes]
10540: Connected to ftp.plig.net.
10541: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10542: 331 Guest login ok, send your complete e-mail address as password.
10543: 230-You are user #5 of 500 simultaneous users allowed.
10544: 230-
1.68 rillig 10545: 230- ___ _ _ _
10546: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10547: 230- | _| _| . |_| . | | | . |_| . | _| . |
10548: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10549: 230- |_| |_| |___| |___|
10550: 230-
10551: 230-** Welcome to ftp.plig.org **
10552: 230-
10553: 230-Please note that all transfers from this FTP site are logged. If you
10554: 230-do not like this, please disconnect now.
10555: 230-
10556: 230-This arhive is available via
10557: 230-
10558: 230-HTTP: http://ftp.plig.org/
10559: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10560: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10561: 230-
10562: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10563: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10564: 230-
10565: 230-
10566: 230 Logged in anonymously.
10567: Remote system type is UNIX.
10568: Using binary mode to transfer files.
10569: 200 Type okay.
10570: 250 "/pub" is new cwd.
10571: 250-"/pub/figlet" is new cwd.
10572: 250-
10573: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10574: 250-
1.75 rillig 10575: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10576: 250-
10577: 250-The official FIGlet web page is:
1.75 rillig 10578: 250- http://www.figlet.org/
1.1 grant 10579: 250-
10580: 250-If you have questions, please mailto:info@figlet.org. If you want to
10581: 250-contribute a font or something else, you can email us.
1.68 rillig 10582: 250
1.1 grant 10583: 250 "/pub/figlet/program" is new cwd.
10584: 250 "/pub/figlet/program/unix" is new cwd.
10585: local: figlet221.tar.gz remote: figlet221.tar.gz
10586: 502 Unimplemented command.
10587: 227 Entering Passive Mode (195,40,6,41,246,104)
10588: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10589: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10590: 226 Transfer completed.
10591: 172219 bytes received in 00:02 (75.99 KB/s)
10592: 221 Goodbye.
10593: => Checksum OK for figlet221.tar.gz.
10594: ===> Extracting for figlet-2.2.1nb2
10595: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10596: ===> Patching for figlet-2.2.1nb2
10597: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10598: ===> Overriding tools for figlet-2.2.1nb2
10599: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10600: ===> Configuring for figlet-2.2.1nb2
10601: ===> Building for figlet-2.2.1nb2
10602: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10603: chmod a+x figlet
10604: gcc -O2 -o chkfont chkfont.c
10605: => Unwrapping files-to-be-installed.
1.14 xtraeme 10606: <code class="prompt">#</code>
1.75 rillig 10607: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10608: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10609: ===> Installing for figlet-2.2.1nb2
10610: install -d -o root -g wheel -m 755 /usr/pkg/bin
10611: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10612: mkdir -p /usr/pkg/share/figlet
10613: cp figlet /usr/pkg/bin
10614: cp chkfont /usr/pkg/bin
10615: chmod 555 figlist showfigfonts
10616: cp figlist /usr/pkg/bin
10617: cp showfigfonts /usr/pkg/bin
10618: cp fonts/*.flf /usr/pkg/share/figlet
10619: cp fonts/*.flc /usr/pkg/share/figlet
10620: cp figlet.6 /usr/pkg/man/man6
10621: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10622: <code class="prompt">#</code></pre>
10623: </div>
10624: <div class="sect1" lang="en">
10625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10626: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10627: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10628: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10629: ===> Packaging figlet-2.2.1nb2
10630: ===> Building binary package for figlet-2.2.1nb2
10631: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10632: Using SrcDir value of /usr/pkg
1.68 rillig 10633: Registering depends:.
1.75 rillig 10634: <code class="prompt">#</code></pre>
10635: </div>
10636: </div>
10637: <div class="appendix" lang="en">
10638: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10639: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10640: <div class="toc">
10641: <p><b>Table of Contents</b></p>
10642: <dl>
10643: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10644: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10645: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10646: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10647: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
10648: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 ! rillig 10649: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10650: source packages</a></span></dt>
10651: </dl>
10652: </div>
10653: <p>As in other big projects, the directory layout of pkgsrc
10654: is quite complex for newbies. This chapter explains where you
10655: find things on the FTP server. The base directory on
1.89 rillig 10656: <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>.
10657: On other servers it may be different, but inside this directory,
10658: everything should look the same, no matter on which server you
10659: are. This directory contains some subdirectories, which are
10660: explained below.</p>
1.76 rillig 10661: <div class="sect1" lang="en">
10662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10663: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
10664: <p>For those who only want to manage binary packages on
10665: systems other than NetBSD, we provide the package management
10666: tools in a separate, small tar file.</p>
10667: </div>
10668: <div class="sect1" lang="en">
10669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10670: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10671: <p>The directory <code class="filename">distfiles</code> contains lots
10672: of archive files from all pkgsrc packages, which are mirrored
10673: here. The subdirectories are called after their package names
10674: and are used when the distributed files have names that don't
10675: explicitly contain a version number or are otherwise too generic
10676: (for example <code class="filename">release.tar.gz</code>).</p>
10677: </div>
10678: <div class="sect1" lang="en">
10679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10680: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10681: <p>This directory is currently not in use.</p>
10682: </div>
10683: <div class="sect1" lang="en">
10684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10685: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10686: <p>This directory contains things that individual pkgsrc
10687: developers find worth publishing.</p>
10688: </div>
10689: <div class="sect1" lang="en">
10690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10691: <a name="ftp-packages"></a>C.5. <code class="filename">packages*</code>: Binary packages</h2></div></div></div>
10692: <p>These directories contain binary packages. Those
10693: directories that have a branch name
10694: (200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>)
10695: contain packages from that particular branch. The directory
10696: <code class="filename">packages</code> contains binary packages from
10697: pkgsrc-current. (However, this does not necessarily mean that
10698: the packages are still current anymore.)</p>
10699: <p>Below the <code class="filename">packages*</code> directories are
10700: directories that distinguish the packages by operating system
10701: and version, the next directory level specifies the hardware
10702: architecture.</p>
10703: <p>In each of the platform-specific directories, there is a
10704: whole binary packages collection. It has a directory called
10705: <code class="filename">All</code> which contains all binary packages.
10706: Besides that, there are various category directories that
10707: contain symbolic links to the real binary packages.</p>
10708: </div>
10709: <div class="sect1" lang="en">
10710: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10711: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
1.93 ! rillig 10712: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10713: source packages</h2></div></div></div>
10714: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
10715: that is the files that define how to create binary packages from
10716: source archives.</p>
10717: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10718: snapshot of the CVS repository, which is updated regularly. The
10719: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10720: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10721: <p>In the directories for the quarterly branches, there is an
10722: additional file called
10723: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10724: which contains the state of pkgsrc when it was branched.</p>
10725: </div>
1.75 rillig 10726: </div>
10727: <div class="appendix" lang="en">
10728: <div class="titlepage"><div><div><h2 class="title">
10729: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
10730: <div class="toc">
10731: <p><b>Table of Contents</b></p>
10732: <dl>
1.79 rillig 10733: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10734: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10735: </dl>
10736: </div>
1.79 rillig 10737: <p>This section contains information on editing the pkgsrc
10738: guide itself.</p>
1.75 rillig 10739: <div class="sect1" lang="en">
10740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10741: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10742: <p>The pkgsrc guide's source code is stored in
10743: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10744: are created from it:</p>
10745: <div class="itemizedlist"><ul type="disc">
10746: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10747: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10748: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/</a></p></li>
10749: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</a>:
10750: The PDF version of the pkgsrc guide.</p></li>
10751: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</a>:
10752: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10753: </ul></div>
10754: </div>
10755: <div class="sect1" lang="en">
10756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10757: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10758: <p>The procedure to edit the pkgsrc guide is:</p>
10759: <div class="procedure"><ol type="1">
10760: <li><p>Make sure you have the packages needed to
1.83 wiz 10761: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 10762: 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
10763: 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 10764: PostScript and PDF versions. You will need both packages
10765: installed, to make sure documentation is consistent across all
10766: formats.</p></li>
10767: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
10768: right directory. All further steps will take place
10769: here.</p></li>
10770: <li><p>Edit the XML file(s) in
10771: <code class="filename">files/</code>.</p></li>
10772: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
10773: guide for valid XML and to build the final output files. If you
10774: get any errors at this stage, you can just edit the files, as
10775: there are only symbolic links in the working directory, pointing
10776: to the files in <code class="filename">files/</code>.</p></li>
10777: <li><p><span><strong class="command">(cd files && cvs
10778: commit)</strong></span></p></li>
10779: <li><p>Run <span><strong class="command">bmake clean && bmake</strong></span> to
10780: regenerate the output files with the proper RCS
10781: Ids.</p></li>
1.91 rillig 10782: <li>
10783: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
10784: commit the files in both <code class="filename">pkgsrc/doc</code> and
10785: <code class="filename">htdocs</code>.</p>
10786: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10787: <h3 class="title">Note</h3>
10788: <p>If you have added, removed or renamed some chapters,
1.83 wiz 10789: you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
10790: <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91 rillig 10791: directory.</p>
10792: </div>
10793: </li>
1.79 rillig 10794: </ol></div>
1.75 rillig 10795: </div>
10796: </div>
10797: </div></body>
1.1 grant 10798: </html>
CVSweb <webmaster@jp.NetBSD.org>