Annotation of pkgsrc/doc/pkgsrc.html, revision 1.91
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.90 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.23 2006/09/19 17:50:38 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>
169: <dt><span class="sect1"><a href="#too-much-time">8.19. I have a little time to kill. What shall I do?</a></span></dt>
1.75 rillig 170: </dl></dd>
171: </dl></dd>
172: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
173: <dd><dl>
1.90 rillig 174: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 ! rillig 175: <dd><dl>
! 176: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
! 177: <dd><dl>
! 178: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
! 179: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
! 180: </dl></dd>
! 181: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
! 182: <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>
! 183: </dl></dd>
1.90 rillig 184: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 185: <dd><dl>
1.90 rillig 186: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
187: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
188: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
189: <dd><dl>
190: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.1. Patching guidelines</a></span></dt>
191: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.2. Feedback to the author</a></span></dt>
192: </dl></dd>
193: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
194: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
195: <dd><dl>
196: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
197: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
198: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
199: </dl></dd>
200: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
201: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
202: </dl></dd>
203: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
204: <dd><dl>
205: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
206: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
207: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
208: <dd><dl>
209: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
210: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
211: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
212: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
213: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
214: </dl></dd>
215: </dl></dd>
216: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
217: <dd><dl>
218: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
219: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
220: <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>
221: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
222: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
223: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
224: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
225: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
226: </dl></dd>
227: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
228: <dd><dl>
229: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
230: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
231: <dd><dl>
232: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
233: <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>
234: </dl></dd>
235: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
236: <dd><dl>
237: <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>
238: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
239: </dl></dd>
240: </dl></dd>
241: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
242: <dd><dl>
243: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
244: <dd><dl>
245: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
246: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
247: </dl></dd>
248: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
249: <dd><dl>
250: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
251: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
252: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
253: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
254: </dl></dd>
255: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
256: <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>
257: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
258: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
259: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
260: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
261: <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>
262: </dl></dd>
263: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
264: <dd><dl>
265: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
266: <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>
267: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
268: </dl></dd>
269: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
270: <dd><dl>
271: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
272: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
273: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
274: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
275: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
276: <dd><dl>
277: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
278: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
279: </dl></dd>
280: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
281: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
282: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
283: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
284: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
285: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
286: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
287: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
288: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
289: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
291: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
292: </dl></dd>
293: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
294: <dd><dl>
295: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
296: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
297: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
298: </dl></dd>
299: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
300: <dd><dl>
301: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
302: <dd><dl>
303: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
304: <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>
305: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
306: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
307: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
308: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
309: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
310: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
311: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
312: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
313: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
314: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
315: </dl></dd>
316: <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>
317: <dd><dl>
318: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
319: <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>
320: </dl></dd>
321: <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>
322: <dd><dl>
323: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
324: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
325: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
326: </dl></dd>
327: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
328: <dd><dl>
329: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
330: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
331: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
332: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
333: </dl></dd>
334: <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>
335: <dd><dl>
336: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
337: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
338: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
339: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
340: </dl></dd>
341: <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>
342: <dd><dl>
343: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
344: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
345: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
346: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
347: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
348: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
349: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
350: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
351: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
352: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
353: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
354: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
355: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
356: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
357: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
358: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
359: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 360: emulation</a></span></dt>
1.90 rillig 361: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
362: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77 rillig 363: </dl></dd>
1.90 rillig 364: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 365: </dl></dd>
1.90 rillig 366: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
367: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 368: <dd><dl>
1.90 rillig 369: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
370: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
371: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
372: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
373: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
374: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
375: </dl></dd>
376: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
377: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
378: <dd><dl>
379: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
380: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
381: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
382: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 383: </dl></dd>
1.75 rillig 384: </dl></dd>
385: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
386: <dd><dl>
1.90 rillig 387: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 388: <dd><dl>
1.90 rillig 389: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
390: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
391: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 392: <dd><dl>
1.90 rillig 393: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
394: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 395: </dl></dd>
1.90 rillig 396: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
397: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 398: <dd><dl>
1.90 rillig 399: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
400: <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 401: </dl></dd>
1.90 rillig 402: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 403: <dd><dl>
1.90 rillig 404: <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>
405: <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 406: </dl></dd>
407: </dl></dd>
1.90 rillig 408: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 409: <dd><dl>
1.90 rillig 410: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
411: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
412: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 413: <dd><dl>
1.90 rillig 414: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
415: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 416: </dl></dd>
417: </dl></dd>
1.90 rillig 418: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 419: <dd><dl>
1.90 rillig 420: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
421: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 422: </dl></dd>
423: </dl></dd>
424: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
425: <dd><dl>
426: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
427: <dd><dl>
428: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
429: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
430: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
431: <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>
432: </dl></dd>
433: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
434: </dl></dd>
435: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
436: <dd><dl>
437: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
438: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
439: </dl></dd>
1.76 rillig 440: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
441: <dd><dl>
442: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
443: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
444: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
445: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
446: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
447: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
448: <code class="filename">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
449: source packages</a></span></dt>
450: </dl></dd>
1.75 rillig 451: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
452: <dd><dl>
1.79 rillig 453: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 454: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
455: </dl></dd>
456: </dl>
457: </div>
1.82 rillig 458: <div class="list-of-tables">
459: <p><b>List of Tables</b></p>
460: <dl>
461: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
462: </dt>
463: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
464: </dt>
1.90 rillig 465: <dt>10.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 466: </dt>
1.90 rillig 467: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 468: </dt>
1.82 rillig 469: </dl>
470: </div>
1.75 rillig 471: <div class="chapter" lang="en">
472: <div class="titlepage"><div><div><h2 class="title">
473: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
474: <div class="toc">
475: <p><b>Table of Contents</b></p>
476: <dl>
477: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 478: <dd><dl>
479: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
480: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
481: </dl></dd>
1.75 rillig 482: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
483: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 484: <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 485: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
486: </dl>
487: </div>
488: <div class="sect1" lang="en">
489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
490: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 491: <p>There is a lot of software freely available for Unix-based
492: systems, which is usually available in form of the source code. Before
493: such software can be used, it needs to be configured to the local
494: system, compiled and installed, and this is exactly what The NetBSD
495: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
496: to handle binary packages, so that not every user has to build the
497: packages for himself, which is a time-costly task.</p>
1.75 rillig 498: <p>pkgsrc currently contains several thousand packages,
499: including:</p>
500: <div class="itemizedlist"><ul type="disc">
1.91 ! rillig 501: <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 502: web server</p></li>
1.91 ! rillig 503: <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 504: web browser</p></li>
1.91 ! rillig 505: <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 506: Desktop Environment</p></li>
1.91 ! rillig 507: <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 508: Desktop Environment</p></li>
509: </ul></div>
510: <p>...just to name a few.</p>
511: <p>pkgsrc has built-in support for handling varying dependencies,
512: such as pthreads and X11, and extended features such as IPv6 support on
513: a range of platforms.</p>
1.82 rillig 514: <div class="sect2" lang="en">
515: <div class="titlepage"><div><div><h3 class="title">
516: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
517: <p>
518: pkgsrc provides the following key features:
519: </p>
520: <div class="itemizedlist"><ul type="disc">
521: <li><p>Easy building of software from source as well as the creation
522: and installation of binary packages. The source and latest
523: patches are retrieved from a master or mirror download site, checksum
524: verified, then built on your system. Support for binary-only
525: distributions is available for both native platforms and NetBSD
526: emulated platforms.</p></li>
527: <li><p>All packages are installed in a consistent directory tree,
528: including binaries, libraries, man pages and other
529: documentation.</p></li>
530: <li><p>Package dependencies, including when performing package updates,
531: are handled automatically. The configuration files of various
532: packages are handled automatically during updates, so local changes
533: are preserved.</p></li>
534: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
535: consists of highly portable code. This allows the greatest speed of
536: development when porting to new a platform. This portability also
537: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
538: platforms</em></span>.</p></li>
539: <li><p>The installation prefix, acceptable software licenses,
540: international encryption requirements and build-time options for a
541: large number of packages are all set in a simple, central
542: configuration file.</p></li>
543: <li><p>The entire source (not including the distribution files) is
544: freely available under a BSD license, so you may extend and adapt
545: pkgsrc to your needs. Support for local packages and patches is
546: available right out of the box, so you can configure it specifically
547: for your environment.</p></li>
548: </ul></div>
1.91 ! rillig 549: <p>The following principles are basic to pkgsrc:</p>
! 550: <div class="itemizedlist"><ul type="disc">
! 551: <li><p>“<span class="quote">It should only work if it's right.</span>”
! 552: — That means, if a package contains bugs, it's better to find
! 553: them and to complain about them rather than to just install the package
! 554: and hope that it works. There are numerous checks in pkgsrc that try to
! 555: 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
! 556: of shell scripts), and post-installation checks (installed files,
! 557: references to shared libraries, script interpreters).</p></li>
! 558: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
! 559: — Like NetBSD has been ported to many hardware architectures,
! 560: pkgsrc has been ported to many operating systems. Care is taken that
! 561: packages behave the same on all platforms.</p></li>
! 562: </ul></div>
1.82 rillig 563: </div>
564: <div class="sect2" lang="en">
565: <div class="titlepage"><div><div><h3 class="title">
566: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
567: <p>pkgsrc consists of both a source distribution and a binary
568: distribution for these operating systems. After retrieving the required
569: source or binaries, you can be up and running with pkgsrc in just
570: minutes!</p>
1.75 rillig 571: <p>pkgsrc was derived from FreeBSD's ports system, and
572: initially developed for NetBSD only. Since then, pkgsrc has
573: grown a lot, and now supports the following platforms:</p>
1.82 rillig 574: <div class="table">
575: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 ! rillig 576: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 577: <colgroup>
578: <col>
579: <col>
580: </colgroup>
581: <thead><tr>
582: <th>Platform</th>
583: <th>Date Support Added</th>
584: </tr></thead>
585: <tbody>
586: <tr>
587: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
588: <td align="center">Aug 1997</td>
589: </tr>
590: <tr>
591: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
592: <td align="center">Mar 1999</td>
593: </tr>
594: <tr>
595: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
596: <td align="center">Jun 1999</td>
597: </tr>
598: <tr>
599: <td>
600: <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
601: (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
602: </td>
603: <td align="center">Oct 2001</td>
604: </tr>
605: <tr>
606: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
607: <td align="center">Nov 2002</td>
608: </tr>
609: <tr>
610: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
611: <td align="center">Nov 2002</td>
612: </tr>
613: <tr>
614: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
615: <td align="center">Dec 2002</td>
616: </tr>
617: <tr>
618: <td>BSD/OS</td>
619: <td align="center">Dec 2003</td>
620: </tr>
621: <tr>
622: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
623: <td align="center">Dec 2003</td>
624: </tr>
625: <tr>
626: <td>
627: <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
628: (Microsoft Windows Services for Unix)
629: </td>
630: <td align="center">Mar 2004</td>
631: </tr>
632: <tr>
633: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
634: <td align="center">Oct 2004</td>
635: </tr>
636: <tr>
637: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
638: <td align="center">Nov 2004</td>
639: </tr>
640: </tbody>
1.91 ! rillig 641: </table></div>
1.82 rillig 642: </div>
1.91 ! rillig 643: <br class="table-break">
1.82 rillig 644: </div>
1.75 rillig 645: </div>
646: <div class="sect1" lang="en">
647: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
648: <a name="overview"></a>1.2. Overview</h2></div></div></div>
649: <p>This document is divided into three parts. The first,
650: <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
651: describes how one can use one of the packages in the Package
652: Collection, either by installing a precompiled binary package,
653: or by building one's own copy using the NetBSD package system.
654: 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
655: package so it can be easily built by other NetBSD users without
656: knowing about the package's building details. The third part,
657: <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
658: is intended for those who want to understand how pkgsrc is
659: implemented.</p>
660: <p>This document is available in various formats:
661: <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>
662: </div>
663: <div class="sect1" lang="en">
664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
665: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
666: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
667: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
668: terminology used within this document.</p>
669: <div class="variablelist"><dl>
670: <dt><span class="term">Package</span></dt>
671: <dd><p>A set of files and building instructions
672: that describe what's necessary
673: to build a certain piece of software using
674: pkgsrc. Packages are traditionally stored under
1.76 rillig 675: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 676: <dt><span class="term">The NetBSD package system</span></dt>
1.87 wiz 677: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
678: is part of the NetBSD operating system and can be bootstrapped
679: to run on non-NetBSD operating systems as well. It handles
680: building (compiling), installing, and removing of
681: packages.</p></dd>
1.75 rillig 682: <dt><span class="term">Distfile</span></dt>
683: <dd><p>This term describes the file or files that are
684: provided by the author of the piece of software to
685: distribute his work. All the changes necessary to build on
686: NetBSD are reflected in the corresponding package. Usually
687: the distfile is in the form of a compressed tar-archive,
688: but other types are possible, too. Distfiles are usually
689: stored below
1.76 rillig 690: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 691: <dt><span class="term">Port</span></dt>
692: <dd><p>This is the term used by FreeBSD and OpenBSD people
693: for what we call a package.
694: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
695: architecture.</p></dd>
696: <dt><span class="term">Precompiled/binary package</span></dt>
697: <dd>
698: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 699: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 700: file so it can be installed on machines of the same
701: machine architecture without the need to
702: recompile. Packages are usually generated in
1.76 rillig 703: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.75 rillig 704: an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
705: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
706: especially in the context of precompiled packages.</p>
707: </dd>
708: <dt><span class="term">Program</span></dt>
1.88 wiz 709: <dd><p>The piece of software to be installed which will be
710: constructed from all the files in the distfile by the
711: actions defined in the corresponding package.</p></dd>
1.75 rillig 712: </dl></div>
713: <div class="sect2" lang="en">
714: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 715: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75 rillig 716: <div class="variablelist"><dl>
717: <dt><span class="term">pkgsrc users</span></dt>
718: <dd>
719: <p>The
720: pkgsrc users are people who use the packages provided by pkgsrc.
721: Typically they are system administrators. The people using the
722: software that is inside the packages (maybe called “<span class="quote">end
723: users</span>”) are not covered by the pkgsrc guide.</p>
724: <p>There are two kinds of pkgsrc users: Some only want to
725: install pre-built binary packages. Others build the pkgsrc
726: packages from source, either for installing them directly or for
727: 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
728: documentation.</p>
729: </dd>
730: <dt><span class="term">package maintainers</span></dt>
731: <dd><p>A
732: 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>
733: <dt><span class="term">infrastructure developers</span></dt>
734: <dd><p>These people are involved in all those files
1.76 rillig 735: that live in the <code class="filename">mk/</code> directory and below.
1.75 rillig 736: 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,
737: too.</p></dd>
738: </dl></div>
739: </div>
740: </div>
741: <div class="sect1" lang="en">
742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
743: <a name="typography"></a>1.4. Typography</h2></div></div></div>
744: <p>When giving examples for commands, shell prompts are used to
745: show if the command should/can be issued as root, or if
746: “<span class="quote">normal</span>” user privileges are sufficient. We use a
747: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
748: shell prompt, assuming they use the C-shell or tcsh.</p>
749: </div>
750: </div>
751: <div class="part" lang="en">
752: <div class="titlepage"><div><div><h1 class="title">
753: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
754: <div class="toc">
755: <p><b>Table of Contents</b></p>
756: <dl>
757: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
758: <dd><dl>
759: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
760: <dd><dl>
761: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
762: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
763: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
764: </dl></dd>
765: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
766: <dd><dl>
767: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
768: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
769: </dl></dd>
770: </dl></dd>
771: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
772: <dd><dl>
1.82 rillig 773: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
774: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
775: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
776: <dd><dl>
777: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
778: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
779: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
780: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
781: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
782: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
783: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 784: </dl></dd>
785: </dl></dd>
786: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
787: <dd><dl>
788: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
789: <dd><dl>
790: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
791: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 792: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
793: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
794: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
795: <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>
796: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
797: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 798: </dl></dd>
799: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
800: <dd><dl>
801: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
802: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
803: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
804: </dl></dd>
805: </dl></dd>
806: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
807: <dd><dl>
808: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
809: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 810: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 811: <dd><dl>
1.89 rillig 812: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
813: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
814: <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 815: </dl></dd>
1.78 rillig 816: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
817: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 818: </dl></dd>
819: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
820: <dd><dl>
821: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
822: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
823: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
824: <dd><dl>
825: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
826: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
827: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
828: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
829: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
830: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
831: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
832: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
833: </dl></dd>
834: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
835: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
836: </dl></dd>
1.90 rillig 837: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
838: <dd><dl>
1.91 ! rillig 839: <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 840: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
841: </dl></dd>
842: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
1.75 rillig 843: <dd><dl>
1.90 rillig 844: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
845: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
846: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
847: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
848: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
849: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
850: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
851: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
852: <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>
853: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
854: <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 855: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 856: <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>
857: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
858: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
859: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
860: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
861: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
862: <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>
863: <dt><span class="sect1"><a href="#too-much-time">8.19. I have a little time to kill. What shall I do?</a></span></dt>
1.75 rillig 864: </dl></dd>
865: </dl>
866: </div>
867: <div class="chapter" lang="en">
868: <div class="titlepage"><div><div><h2 class="title">
869: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
870: <div class="toc">
871: <p><b>Table of Contents</b></p>
872: <dl>
873: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
874: <dd><dl>
875: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
876: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
877: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via CVS</a></span></dt>
878: </dl></dd>
879: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
880: <dd><dl>
881: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
882: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
883: </dl></dd>
884: </dl>
885: </div>
1.91 ! rillig 886: <p>Before you download and extract the files, you need to decide
! 887: where you want to extract them. When using pkgsrc as root user, pkgsrc
! 888: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
! 889: free to install the sources and binary packages wherever you want in
! 890: your filesystem, provided that the pathname does not contain white-space
! 891: or other characters that are interpreted specially by the shell and some
! 892: other programs. A safe bet is to use only letters, digits, underscores
! 893: and dashes.</p>
1.75 rillig 894: <div class="sect1" lang="en">
895: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
896: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
897: <p>Before you download any pkgsrc files, you should decide
898: whether you want the <span class="emphasis"><em>current</em></span> branch or the
899: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
900: quarterly basis from the current branch and only gets modified
901: for security updates. The names of the stable branches are built
902: from the year and the quarter, for example
903: <code class="literal">2006Q1</code>.</p>
904: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
905: want to download pkgsrc. You can get it as a tar file, via SUP,
906: or via CVS. All three ways are described here.</p>
907: <div class="sect2" lang="en">
908: <div class="titlepage"><div><div><h3 class="title">
909: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
910: <p>The primary download location for all pkgsrc files is
911: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
912: number of subdirectories for different purposes, which are
1.76 rillig 913: 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 914: <p>The tar file for the current branch is in the directory
1.76 rillig 915: <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 916: It is autogenerated daily.</p>
917: <p>The tar file for the stable branch 2006Q1 is in the
1.76 rillig 918: directory <code class="filename">2006Q1</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/2006Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.75 rillig 919: <p>After downloading the tar file, change to the directory
920: where you want to have pkgsrc. This is usually
1.91 ! rillig 921: <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
! 922: pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
1.75 rillig 923: </div>
924: <div class="sect2" lang="en">
925: <div class="titlepage"><div><div><h3 class="title">
926: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
927: <p>As an alternative to the tar file, you can get pkgsrc via
928: the Software Update Protocol, SUP. To do so, make sure your
929: supfile has a line
1.1 grant 930:
1.75 rillig 931: </p>
932: <pre class="programlisting">
1.51 rillig 933: release=pkgsrc
1.1 grant 934: </pre>
1.75 rillig 935: <p>
1.1 grant 936:
1.75 rillig 937: in it, see the examples in
1.76 rillig 938: <code class="filename">/usr/share/examples/supfiles</code>, and that the
939: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.75 rillig 940: run <span><strong class="command">sup -v
941: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
942: </div>
943: <div class="sect2" lang="en">
944: <div class="titlepage"><div><div><h3 class="title">
945: <a name="getting-via-cvs"></a>2.1.3. Via CVS</h3></div></div></div>
946: <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>
947: installed. To do an initial (full) checkout of pkgsrc, you first
948: have to set some environment variables. For the C-Shell,
949: type:</p>
950: <pre class="screen">
951: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
952: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
953: </pre>
954: <p>Or, the same for the bourne shell:</p>
955: <pre class="screen">
956: <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
957: <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
958: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
959: </pre>
960: <p>Then, you change to the directory where you want to have
961: your copy of pkgsrc. In most cases this is
1.76 rillig 962: <code class="filename">/usr</code>. In that directory you run the
1.75 rillig 963: checkout command, which is <span><strong class="command">cvs -q checkout -P
964: pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
965: checkout -rpkgsrc-2006Q1 -P pkgsrc</strong></span> for the stable
966: branch. This command will create a directory called
1.76 rillig 967: <code class="filename">pkgsrc</code> with all the pkgsrc files in
1.75 rillig 968: it.</p>
969: </div>
970: </div>
971: <div class="sect1" lang="en">
972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
973: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
974: <p>The preferred way to keep pkgsrc up-to-date is via CVS
975: (which also works if you have first installed it via a tar
976: file). It saves bandwidth and hard disk activity, compared to
977: downloading the tar file again.</p>
978: <div class="sect2" lang="en">
979: <div class="titlepage"><div><div><h3 class="title">
980: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
981: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
982: <h3 class="title">Warning</h3>
1.77 rillig 983: <p>When updating from a tar file, you first need to
984: completely remove the old pkgsrc directory. Otherwise those
985: files that have been removed from pkgsrc in the mean time will
986: not be removed on your local disk, resulting in inconsistencies.
987: When removing the old files, any changes that you have done to
988: the pkgsrc files will be lost after updating. Therefore updating
989: via CVS is strongly recommended.</p>
1.75 rillig 990: </div>
1.82 rillig 991: <p>Note that by default the distfiles and the binary packages
992: are saved in the pkgsrc tree, so don't forget to rescue them
993: before updating. You can also configure pkgsrc to use other than
994: the default directories by setting the
995: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
996: variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 997: <p>To update pkgsrc from a tar file, download the tar file as
998: explained above. Then, make sure that you have not made any
999: changes to the files in the pkgsrc directory. Remove the pkgsrc
1000: directory and extract the new tar file. Done.</p>
1001: </div>
1002: <div class="sect2" lang="en">
1003: <div class="titlepage"><div><div><h3 class="title">
1004: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1005: <p>To update pkgsrc via CVS, make sure the environment
1006: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1007: change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1.77 rillig 1008: -dP</strong></span>.</p>
1.75 rillig 1009: <div class="sect3" lang="en">
1010: <div class="titlepage"><div><div><h4 class="title">
1011: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1012: <p>When updating pkgsrc, the CVS program keeps track of the
1013: branch you selected. But if you, for whatever reason, want to
1014: switch from the stable branch to the current one, you can do it
1015: by adding the option “<span class="quote">-A</span>” after the
1016: “<span class="quote">update</span>” keyword. To switch from the current branch
1017: back to the stable branch, add the
1018: “<span class="quote">-rpkgsrc-2006Q1</span>” option.</p>
1019: </div>
1020: <div class="sect3" lang="en">
1021: <div class="titlepage"><div><div><h4 class="title">
1022: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1023: <p>When you update pkgsrc, the CVS program will only touch
1024: those files that are registered in the CVS repository. That
1025: means that any packages that you created on your own will stay
1026: unmodified. If you change files that are managed by CVS, later
1027: updates will try to merge your changes with those that have been
1028: done by others. See the CVS manual, chapter
1029: “<span class="quote">update</span>” for details.</p>
1030: </div>
1031: </div>
1032: </div>
1033: </div>
1034: <div class="chapter" lang="en">
1035: <div class="titlepage"><div><div><h2 class="title">
1036: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1037: <div class="toc">
1038: <p><b>Table of Contents</b></p>
1039: <dl>
1.82 rillig 1040: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1041: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1042: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1043: <dd><dl>
1044: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1045: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1046: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1047: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1048: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1049: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1050: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1051: </dl></dd>
1052: </dl>
1053: </div>
1054: <div class="sect1" lang="en">
1055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1056: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1057: <p>
1058: We provide a bootstrap kit in both source and binary form for other
1059: platforms than NetBSD, consisting of the pkg administration tools and other
1060: tools required to use pkgsrc and build packages.
1061: </p>
1062: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1063: <h3 class="title">Note</h3>
1064: <p>
1065: Older binary snapshots are available in the
1066: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
1067: directory on ftp.NetBSD.org.</p>
1068: </div>
1069: <div class="table">
1070: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1.91 ! rillig 1071: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1.82 rillig 1072: <colgroup>
1073: <col>
1074: <col>
1075: <col>
1076: <col>
1077: </colgroup>
1078: <thead><tr>
1079: <th>Platform</th>
1080: <th>Latest snapshot</th>
1081: <th>Binary kit</th>
1082: <th>Binary packages</th>
1083: </tr></thead>
1084: <tbody>
1085: <tr>
1086: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
1087: <td class="date">20021209</td>
1088: <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>
1089: <td class="binary-pkgs-url"> </td>
1090: </tr>
1091: <tr>
1092: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
1093: <td class="date">20030623</td>
1094: <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>
1095: <td class="binary-pkgs-url"> </td>
1096: </tr>
1097: <tr>
1098: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
1099: <td class="date">20041219</td>
1100: <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>
1101: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
1102: </tr>
1103: <tr>
1104: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
1105: <td class="date">20050320</td>
1106: <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>
1107: <td class="binary-pkgs-url"> </td>
1108: </tr>
1109: <tr>
1110: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
1111: <td class="date">20050625</td>
1112: <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>
1113: <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>
1114: </tr>
1115: <tr>
1116: <td class="osname">Debian GNU Linux/i386</td>
1117: <td class="date">20031023</td>
1118: <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>
1119: <td class="binary-pkgs-url"> </td>
1120: </tr>
1121: <tr>
1122: <td class="osname">Fedora Core 2 Linux/i386</td>
1123: <td class="date">20050618</td>
1124: <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>
1125: <td class="binary-pkgs-url"> </td>
1126: </tr>
1127: <tr>
1128: <td class="osname">Fedora Core 4 Linux/i386</td>
1129: <td class="date">20060105</td>
1130: <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>
1131: <td class="binary-pkgs-url"> </td>
1132: </tr>
1133: <tr>
1134: <td class="osname">FreeBSD 3.5/i386</td>
1135: <td class="date">20030411</td>
1136: <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>
1137: <td class="binary-pkgs-url"> </td>
1138: </tr>
1139: <tr>
1140: <td class="osname">FreeBSD 4.7/i386</td>
1141: <td class="date">20021211</td>
1142: <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>
1143: <td class="binary-pkgs-url"> </td>
1144: </tr>
1145: <tr>
1146: <td class="osname">FreeBSD 5.0/i386</td>
1147: <td class="date">20030411</td>
1148: <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>
1149: <td class="binary-pkgs-url"> </td>
1150: </tr>
1151: <tr>
1152: <td class="osname">FreeBSD 5.1/i386</td>
1153: <td class="date">20030630</td>
1154: <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>
1155: <td class="binary-pkgs-url"> </td>
1156: </tr>
1157: <tr>
1158: <td class="osname">FreeBSD 5.2.1/i386</td>
1159: <td class="date">20040227</td>
1160: <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>
1161: <td class="binary-pkgs-url"> </td>
1162: </tr>
1163: <tr>
1164: <td class="osname">FreeBSD 5.3/i386</td>
1165: <td class="date">20050119</td>
1166: <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>
1167: <td class="binary-pkgs-url"> </td>
1168: </tr>
1169: <tr>
1170: <td class="osname">Interix 3.5</td>
1171: <td class="date">20051010</td>
1172: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Interix-3.5-i386-20051010.tar.gz" target="_top">binary kit</a></td>
1173: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Interix-3.5/i386/current/" target="_top">binary packages</a></td>
1174: </tr>
1175: <tr>
1176: <td class="osname">IRIX 6.5 n32-bit ABI</td>
1177: <td class="date">20040911</td>
1178: <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>
1179: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
1180: </tr>
1181: <tr>
1182: <td class="osname">IRIX 6.5 64-bit ABI</td>
1183: <td class="date">20040912</td>
1184: <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>
1185: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
1186: </tr>
1187: <tr>
1188: <td class="osname">OpenBSD 3.2/i386</td>
1189: <td class="date">20030420</td>
1190: <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>
1191: <td class="binary-pkgs-url"> </td>
1192: </tr>
1193: <tr>
1194: <td class="osname">OpenBSD 3.3/i386</td>
1195: <td class="date">20030503</td>
1196: <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>
1197: <td class="binary-pkgs-url"> </td>
1198: </tr>
1199: <tr>
1200: <td class="osname">OpenBSD 3.5/i386</td>
1201: <td class="date">20040507</td>
1202: <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>
1203: <td class="binary-pkgs-url"> </td>
1204: </tr>
1205: <tr>
1206: <td class="osname">Slackware Linux 8.1/i386</td>
1207: <td class="date">20030417</td>
1208: <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>
1209: <td class="binary-pkgs-url"> </td>
1210: </tr>
1211: <tr>
1212: <td class="osname">Slackware Linux 9/i386</td>
1213: <td class="date">20031023</td>
1214: <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>
1215: <td class="binary-pkgs-url"> </td>
1216: </tr>
1217: <tr>
1218: <td class="osname">Solaris 8/sparc</td>
1219: <td class="date">20050220</td>
1220: <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>
1221: <td class="binary-pkgs-url"> </td>
1222: </tr>
1223: <tr>
1224: <td class="osname">Solaris 8/i386</td>
1225: <td class="date">20050220</td>
1226: <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>
1227: <td class="binary-pkgs-url"> </td>
1228: </tr>
1229: <tr>
1230: <td class="osname">Solaris 9/sparc</td>
1231: <td class="date">20041208</td>
1232: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-sparc-20041208.tar.gz" target="_top">binary kit</a></td>
1233: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/SunOS-5.9/sparc/" target="_top">binary packages</a></td>
1234: </tr>
1235: <tr>
1236: <td class="osname">Solaris 9/i386</td>
1237: <td class="date">20030411</td>
1238: <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>
1239: <td class="binary-pkgs-url"> </td>
1240: </tr>
1241: </tbody>
1.91 ! rillig 1242: </table></div>
1.82 rillig 1243: </div>
1.91 ! rillig 1244: <br class="table-break"><p>
1.82 rillig 1245: Simply download the binary kit for your platform, and extract it into
1246: <code class="filename">/</code> e.g.
1247: </p>
1248: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
1249: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
1250: | tar -xpf -</code></strong></pre>
1251: <p>
1252: Of course, as with any binary distributions, you should verify the
1253: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
1254: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
1255: file and inspect the contents before extracting it.
1256: </p>
1257: </div>
1258: <div class="sect1" lang="en">
1259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1260: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1261: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1262: <pre class="screen">
1263: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1264: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1265: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1266: </pre>
1.75 rillig 1267: <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 1268: pkgsrc before bootstrapping. The given
1269: <span><strong class="command">bootstrap</strong></span> command will use the defaults of
1270: <code class="filename">/usr/pkg</code> for the
1271: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1272: and <code class="filename">/var/db/pkg</code> for the package database
1273: directory where pkgsrc will do its internal bookkeeping.
1274: However, these can also be set using command-line
1275: arguments.</p>
1.75 rillig 1276: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1.87 wiz 1277: available for supported platforms. An up-to-date list of these can be
1278: found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
1279: Note that this only works for privileged builds that install
1280: into <code class="filename">/usr/pkg</code>.</p>
1.75 rillig 1281: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1282: <h3 class="title">Note</h3>
1283: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1.87 wiz 1284: Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
1285: For examples in this guide, use <span><strong class="command">bmake</strong></span>
1286: instead of “<span class="quote">make</span>”.</p>
1.75 rillig 1287: </div>
1288: </div>
1289: <div class="sect1" lang="en">
1290: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1291: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1292: <p>Here are some platform-specific notes you should be aware of.</p>
1293: <div class="sect2" lang="en">
1294: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1295: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85 jmmv 1296: <p>Darwin 5.x and up are supported. There are two methods of using
1.82 rillig 1297: 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 1298: 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 1299: partition</a>.</p>
1300: <p>Before you start, you will need to download and install the Mac OS X Developer
1.87 wiz 1301: Tools from Apple's Developer Connection. See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1302: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1303: from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1304: if you intend to build packages that use the X11 Window System.</p>
1.89 rillig 1305: <p>If you already have a UFS or HFSX partition, or have a spare partition
1306: that you can format as UFS or HFSX, it is recommended to use that instead of
1.87 wiz 1307: the disk image. It'll be somewhat faster and will mount automatically
1308: at boot time, where you must manually mount a disk image.</p>
1.75 rillig 1309: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1310: <h3 class="title">Note</h3>
1.85 jmmv 1311: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89 rillig 1312: 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 1313: </div>
1314: <div class="sect3" lang="en">
1315: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1316: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75 rillig 1317: <p>Create the disk image:</p>
1318: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.85 jmmv 1319: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 512</code></strong> # megabytes - season to taste
1320: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75 rillig 1321: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85 jmmv 1322: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1323: <h3 class="title">Note</h3>
1.89 rillig 1324: <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 1325: </div>
1.89 rillig 1326: <p>Allow suid:</p>
1327: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.75 rillig 1328: </div>
1329: <div class="sect3" lang="en">
1330: <div class="titlepage"><div><div><h4 class="title">
1.89 rillig 1331: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76 rillig 1332: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87 wiz 1333: system, normally HFS+. It is possible to use the default
1334: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1335: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89 rillig 1336: or HFSX file system. Obviously, another symlink is required if you want to
1.87 wiz 1337: place the package database directory outside the
1338: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75 rillig 1339: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1340: <p>If you created your partitions at the time of installing Mac OS X
1.89 rillig 1341: and formatted the target partition as UFS or HFSX, it should automatically
1.87 wiz 1342: mount on <code class="filename">/Volumes/<volume name></code> when the
1.89 rillig 1343: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87 wiz 1344: to ensure that the partition map correctly reflects
1.89 rillig 1345: “<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 1346: <p>The problem is that none of the disk tools will let you touch a
1.87 wiz 1347: disk that is booted from. You can unmount the partition, but even if
1348: you newfs it, the partition type will be incorrect and the
1349: automounter won't mount it. It can be mounted manually, but it won't
1350: appear in Finder.</p>
1.75 rillig 1351: <p>You'll need to boot off of the OS X Installation (User) CD. When
1.87 wiz 1352: the Installation program starts, go up to the menu and select Disk
1353: Utility. Now, you will be able to select the partition you want
1.89 rillig 1354: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1355: installer which will reboot your machine. The new UFS or HFSX file system
1.87 wiz 1356: will appear in Finder.</p>
1.75 rillig 1357: <p>Be aware that the permissions on the new file system will be writable
1.87 wiz 1358: by root only.</p>
1.75 rillig 1359: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87 wiz 1360: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75 rillig 1361: </div>
1362: </div>
1363: <div class="sect2" lang="en">
1364: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1365: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1366: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1367: other versions may work.</p>
1.75 rillig 1368: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1369: with the FreeBSD userland tools. There are several steps:</p>
1.75 rillig 1370: <div class="orderedlist"><ol type="1">
1371: <li><p>FreeBSD stores its ports pkg database in
1.87 wiz 1372: <code class="filename">/var/db/pkg</code>. It is therefore
1373: recommended that you choose a different location (e.g.
1374: <code class="filename">/usr/pkgdb</code>) by
1375: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1376: <li>
1377: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1378: good idea to move them out of the way to avoid confusion, e.g.</p>
1379: <pre class="screen">
1380: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1381: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1382: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1383: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1384: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1385: </pre>
1.75 rillig 1386: </li>
1.76 rillig 1387: <li><p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87 wiz 1388: <code class="filename">/etc/mk.conf.example</code> file
1389: when you use the bootstrap script.</p></li>
1.75 rillig 1390: </ol></div>
1391: </div>
1392: <div class="sect2" lang="en">
1393: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1394: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1395: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1396: providing a Unix-like environment with a tighter kernel integration than
1397: available with Cygwin. It is part of the Windows Services for Unix
1398: package, available for free for any licensed copy of Windows 2000, XP
1399: (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.75 rillig 1400: <p>Services for Unix 3.5, current as of this writing, has been tested. 3.0
1.87 wiz 1401: or 3.1 may work, but are not officially supported. (The main difference
1402: in 3.0/3.1 is lack of pthreads.)</p>
1.75 rillig 1403: <div class="sect3" lang="en">
1404: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1405: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1406: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1407: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75 rillig 1408: <div class="itemizedlist"><ul type="disc">
1409: <li><p>Utilities -> Base Utilities</p></li>
1410: <li><p>Interix GNU Components -> (all)</p></li>
1411: <li><p>Remote Connectivity</p></li>
1412: <li><p>Interix SDK</p></li>
1413: </ul></div>
1414: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1415: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1416: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1417: pkgsrc (or from a binary package).</p>
1.75 rillig 1418: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1419: not need to be installed, but Remote Connectivity itself should be
1420: installed in order to have a working inetd.</p>
1.75 rillig 1421: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1422: behavior for Interix programs, and whether to make pathnames default to
1423: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1424: enabled. (Without case-sensitivity, a large number of packages including
1425: perl will not build.)</p>
1.75 rillig 1426: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1427: works (via the Data Execution Prevention feature). In order to use
1428: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1429: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1430: must be installed. Hotfixes are available from Microsoft through a
1431: support contract; however, a NetBSD developer has made most Interix
1432: 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.75 rillig 1433: </div>
1434: <div class="sect3" lang="en">
1435: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1436: <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 1437: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1438: with pkgsrc, note the following things.</p>
1.75 rillig 1439: <div class="itemizedlist"><ul type="disc">
1440: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1441: Windows Services for UNIX, then click Change. In the installer, choose
1442: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.75 rillig 1443: <li>
1444: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1445: change the following registry key:</p>
1.75 rillig 1446: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1447: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1448: </li>
1449: <li>
1450: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1451: following registry key:</p>
1.75 rillig 1452: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1453: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1454: </li>
1455: </ul></div>
1456: </div>
1457: <div class="sect3" lang="en">
1458: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1459: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1460: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1461: running "pkg_add") must be a member of the local Administrators
1462: group. Such a user must also be used to run the bootstrap. This is
1463: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1464: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1465: automatically complain if this is not the case. This ensures that
1466: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1467: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1468: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1469: NOT be used in conjunction with pkgsrc. If you choose to use them at
1470: the same time as the pkgsrc packages, ensure that you use the proper
1471: pkg_* tools for each type of binary package.</p>
1.75 rillig 1472: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1473: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1474: don't have a termcap/terminfo entry for it, but the following .termcap
1475: entry provides adequate emulation in most cases:</p>
1.75 rillig 1476: <pre class="programlisting">
1.87 wiz 1477: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1478: </pre>
1.75 rillig 1479: </div>
1480: <div class="sect3" lang="en">
1481: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1482: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1483: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1484: for a full Unix-like platform, it has some drawbacks that should
1485: be noted for those desiring to make the most of Interix.</p>
1.75 rillig 1486: <div class="itemizedlist"><ul type="disc">
1487: <li>
1488: <p><span class="strong"><strong>X11:</strong></span></p>
1489: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1490: and can run X11 based applications, but it does
1491: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1492: <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1493: <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1494: (available in a trimmed version for Interix from Interop Systems as the
1495: <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1496: and the free X11 server included with
1497: <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1498: <p>Also, StarNet Communications has graciously provided a free
1.87 wiz 1499: version of their X-Win32 product that accepts connections only
1500: from localhost:
1501: <a href="http://www.starnet.com/xwin32LX/get_xwin32LX.htm" target="_top">X-Win32 LX</a>,
1502: recommended by the maintainer of Interix pkgsrc support.</p>
1.75 rillig 1503: </li>
1504: <li>
1505: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1506: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1507: Win32 applications, it does not currently support various X11
1508: protocol extensions for acceleration (such as MIT-SHM or DGA).
1509: Most interactive applications to a local X server will run
1510: reasonably fast, but full motion video and other graphics
1511: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1512: </li>
1513: <li>
1514: <p><span class="strong"><strong>Audio:</strong></span></p>
1515: <p>Interix has no native support for audio output. For audio
1.87 wiz 1516: support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
1517: audio system on Interix. Unlike on most platforms, the
1.91 ! rillig 1518: <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 1519: <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
1520: server component. To output audio via an Interix host, the
1.91 ! rillig 1521: <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 1522: must also be installed.</p>
1.75 rillig 1523: </li>
1524: <li>
1525: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1526: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1527: is not currently possible to access CD/DVD drives, USB devices,
1528: or SCSI devices through non-filesystem means. Among other things,
1529: this makes it impossible to use Interix directly for CD/DVD
1530: burning.</p>
1.75 rillig 1531: </li>
1532: <li>
1533: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1534: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1535: drives are also not directly accessible in Interix. However,
1536: support is in work to make tape drive access possible by using
1537: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1538: esound server).</p>
1.75 rillig 1539: </li>
1540: </ul></div>
1541: </div>
1542: <div class="sect3" lang="en">
1543: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1544: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1545: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1546: Windows system; any member of the local Administrators group will
1547: suffice. However, some packages currently assume that the user
1548: named "root" is the privileged user. To accommodate these, you
1549: may create such a user; make sure it is in the local group
1550: Administrators (or your language equivalent).</p>
1551: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
1552: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1553: time being, install packages as the local Administrator (or
1554: your language equivalent), or run the following command after
1555: installing a package to work around the issue:</p>
1.75 rillig 1556: <pre class="screen">
1.87 wiz 1557: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1558: </pre>
1.75 rillig 1559: </div>
1560: </div>
1561: <div class="sect2" lang="en">
1562: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1563: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1564: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1565: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1566: according to your preference. If you do not have a license for the MIPSpro
1567: 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 1568: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87 wiz 1569: 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>,
1570: etc.</p>
1.86 schwarz 1571: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1572: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1573: you start out using "abi=n32", that's what all your packages will be built
1574: with.</p>
1575: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1576: <code class="varname">CFLAGS</code> in your environment or the
1577: <code class="filename">/etc/mk.conf</code>. Particularly, make sure that you do not
1578: try to link n32 object files with lib64 or vice versa. Check your
1579: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1580: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1581: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1582: as it appears that IRIX linker occasionally runs into issues when trying to
1583: link over a network-mounted file system.</p>
1.75 rillig 1584: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1585: as imake(1), but you may want to set some options depending on your local
1586: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1587: course, your compiler's man pages for details.</p>
1.75 rillig 1588: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1589:
1.87 wiz 1590: </p>
1.75 rillig 1591: <pre class="programlisting">
1.87 wiz 1592: PKGSRC_COMPILER= mipspro
1593: </pre>
1.75 rillig 1594: <p>
1.1 grant 1595:
1.87 wiz 1596: in <code class="filename">/etc/mk.conf</code>. Otherwise, pkgsrc will assume you
1597: are using gcc and may end up passing invalid flags to the compiler. Note that
1598: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1599: default.</p>
1.75 rillig 1600: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.87 wiz 1601: but want to make sure that MIPRPro is used, please set your <code class="varname">PATH</code>
1602: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1603: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1604: '--preserve-path' flag.</p>
1.75 rillig 1605: </div>
1606: <div class="sect2" lang="en">
1607: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1608: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1609: <p>Some versions of Linux (for example Debian GNU/Linux) need
1610: either libtermcap or libcurses (libncurses). Installing the
1611: distributions libncurses-dev package (or equivalent) should fix
1612: the problem.</p>
1613: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1614: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1615: i386 have been tested.</p>
1.75 rillig 1616: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1617: directory:</p>
1.75 rillig 1618: <pre class="programlisting">
1.87 wiz 1619: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1620: ac_cv___attribute__=yes ./bootstrap
1621: </pre>
1.75 rillig 1622: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1623: <h3 class="title">Note</h3>
1624: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1625: </div>
1626: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1627: function, which icc does not support. #undef'ing __attribute__ has the
1628: unfortunate side-effect of breaking many of the Linux header files, which
1629: cannot be compiled properly without __attribute__. The test must be
1630: overridden so that __attribute__ is assumed supported by the
1631: compiler.</p>
1.75 rillig 1632: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.87 wiz 1633: in <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 1634: <pre class="programlisting">
1.87 wiz 1635: PKGSRC_COMPILER= icc
1636: </pre>
1.75 rillig 1637: <p>The default installation directory for icc is
1.87 wiz 1638: <code class="filename">/opt/intel_cc_80</code>, which
1639: is also the pkgsrc default. If you have installed it into a different
1640: directory, set <code class="varname">ICCBASE</code> in
1641: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 1642: <pre class="programlisting">
1.87 wiz 1643: ICCBASE= /opt/icc
1644: </pre>
1.75 rillig 1645: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1646: provided by icc, so binaries can be run on other systems which do not
1647: have the shared libraries installed.</p>
1648: <p>Libtool, however, extracts a list of libraries from the
1649: <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
1650: records it, throwing away the -Bstatic and -Bdynamic options
1651: interspersed between the libraries. This means that
1652: libtool-linked C++ shared libraries will have a runtime
1653: dependency on the icc libraries until this is fixed in
1654: libtool.</p>
1.75 rillig 1655: </div>
1656: <div class="sect2" lang="en">
1657: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1658: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1659: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1660: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1661: with the OpenBSD userland tools. There are several steps:</p>
1.75 rillig 1662: <div class="orderedlist"><ol type="1">
1663: <li><p>OpenBSD stores its ports pkg database in
1.87 wiz 1664: <code class="filename">/var/db/pkg</code>. It is therefore
1665: recommended that you choose a different location (e.g.
1666: <code class="filename">/usr/pkgdb</code>) by
1667: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1668: <li>
1669: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1670: good idea to move them out of the way to avoid confusion, e.g.</p>
1671: <pre class="screen">
1672: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1673: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1674: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1675: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1676: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1677: </pre>
1.75 rillig 1678: </li>
1679: <li>
1.76 rillig 1680: <p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87 wiz 1681: <code class="filename">/etc/mk.conf.example</code> file
1682: when you use the bootstrap script. OpenBSD's make program uses
1683: <code class="filename">/etc/mk.conf</code>
1684: as well. You can work around this by enclosing all the pkgsrc-specific parts
1685: of the file with:</p>
1686: <pre class="programlisting">
1687: .ifdef BSD_PKG_MK
1688: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1689: .else
1690: # OpenBSD stuff
1691: .endif
1692: </pre>
1.75 rillig 1693: </li>
1694: </ol></div>
1695: </div>
1696: <div class="sect2" lang="en">
1697: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1698: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1699: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1700: You will need a working C compiler. Both gcc 2.95.3 and
1701: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1702: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1703: process and to build packages.</p>
1.75 rillig 1704: <div class="itemizedlist"><ul type="disc">
1705: <li><p>SUNWsprot</p></li>
1706: <li><p>SUNWarc</p></li>
1707: <li><p>SUNWbtool</p></li>
1708: <li><p>SUNWtoo</p></li>
1709: <li><p>SUNWlibm</p></li>
1710: </ul></div>
1.78 rillig 1711: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1712: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1713: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1714: your $prefix are in your <code class="varname">PATH</code>. This includes
1715: <code class="filename">/usr/ccs/{bin,lib}</code>
1716: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75 rillig 1717: <div class="sect3" lang="en">
1718: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1719: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1720: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1721: for building all packages.</p>
1.75 rillig 1722: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1723: then either build gcc from
1.91 ! rillig 1724: <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 1725: package, then remove gcc used during bootstrapping.</p>
1.75 rillig 1726: <p>Binary packages of gcc can be found through <a href="http://www.sun.com/bigadmin/common/freewareSearch.html" target="_top">http://www.sun.com/bigadmin/common/freewareSearch.html</a>.</p>
1727: </div>
1728: <div class="sect3" lang="en">
1729: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1730: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1731: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1732: 5.0)</p>
1.75 rillig 1733: <div class="itemizedlist"><ul type="disc">
1734: <li><p>SPROcc
1.87 wiz 1735: - Sun WorkShop Compiler C 5.0</p></li>
1.75 rillig 1736: <li><p>SPROcpl
1.87 wiz 1737: - Sun WorkShop Compiler C++ 5.0</p></li>
1.75 rillig 1738: <li><p>SPROild
1.87 wiz 1739: - Sun WorkShop Incremental Linker</p></li>
1.75 rillig 1740: <li><p>SPROlang
1.87 wiz 1741: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1742: </ul></div>
1743: <p>You should set <code class="varname">CC</code>, <code class="varname">CXX</code> and
1.87 wiz 1744: optionally, <code class="varname">CPP</code> in <code class="filename">/etc/mk.conf</code>,
1745: e.g.:</p>
1.75 rillig 1746: <pre class="programlisting">
1.87 wiz 1747: CC= cc
1748: CXX= CC
1749: CPP= /usr/ccs/lib/cpp
1750: </pre>
1.75 rillig 1751: </div>
1752: <div class="sect3" lang="en">
1753: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1754: <a name="solaris-sunpro-64"></a>3.3.7.3. Buildling 64-bit binaries with SunPro</h4></div></div></div>
1.75 rillig 1755: <p>Building 64-bit binaries is a little trickier. First, you
1756: need to bootstrap pkgsrc in 64-bit mode. One problem here is
1757: that while building one of the programs in the bootstrap kit
1.76 rillig 1758: (<code class="filename">bmake</code>), the <code class="varname">CFLAGS</code>
1.75 rillig 1759: variable is not honored, even if it is set in the environment.
1760: To work around this bug, you can create a simple shell script
1.76 rillig 1761: called <code class="filename">cc64</code> and put it somewhere in the
1.75 rillig 1762: <code class="varname">PATH</code>:</p>
1763: <pre class="programlisting">
1.87 wiz 1764: #! /bin/sh
1765: exec /opt/SUNWspro/bin/cc -xtarget=ultra -xarch=v9 ${1+"$@"}
1766: </pre>
1.75 rillig 1767: <p>Then, pass the definition for <code class="varname">CC</code> in the
1768: environment of the <span><strong class="command">bootstrap</strong></span> command:</p>
1769: <pre class="programlisting">
1.87 wiz 1770: <code class="prompt">$</code> <strong class="userinput"><code>cd bootstrap</code></strong>
1771: <code class="prompt">$</code> <strong class="userinput"><code>CC=cc64 ./bootstrap</code></strong>
1772: </pre>
1.75 rillig 1773: <p>After bootstrapping, there are two alternative ways,
1774: depending on whether you want to find bugs in packages or get
1775: your system ready quickly. If you just want a running system,
1.76 rillig 1776: add the following lines to your <code class="filename">mk.conf</code>
1.75 rillig 1777: file:</p>
1778: <pre class="programlisting">
1.87 wiz 1779: CC= cc64
1780: CXX= CC64
1781: PKGSRC_COMPILER= sunpro
1782: </pre>
1.75 rillig 1783: <p>This way, all calls to the compiler will be intercepted by
1784: the above wrapper and therefore get the necessary ABI options
1785: automatically. (Don't forget to create the shell script
1.76 rillig 1786: <code class="filename">CC64</code>, too.)</p>
1.75 rillig 1787: <p>To find packages that ignore the user-specified
1788: <code class="varname">CFLAGS</code> and <code class="varname">CXXFLAGS</code>, add
1.76 rillig 1789: the following lines to your <code class="filename">mk.conf</code>
1.75 rillig 1790: file:</p>
1791: <pre class="programlisting">
1.87 wiz 1792: CC= cc
1793: CXX= CC
1794: PKGSRC_COMPILER= sunpro
1795: CFLAGS= -xtarget=ultra -xarch=v9
1796: CXXFLAGS= -xtarget=ultra -xarch=v9
1797: LDFLAGS= -xtarget=ultra -xarch=v9
1798: </pre>
1.75 rillig 1799: <p>Packages that don't use the flags provided in the
1800: configuration file will try to build 32-bit binaries and fail
1801: during linking. Detecting this is useful to prevent bugs on
1802: other platforms where the error would not show up but pass
1803: silently.</p>
1804: </div>
1805: <div class="sect3" lang="en">
1806: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1807: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75 rillig 1808: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87 wiz 1809: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1810: The workaround is to use another shell for the configure
1.91 ! rillig 1811: 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 1812: to your <code class="filename">mk.conf</code>:</p>
1813: <pre class="programlisting">
1814: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1815: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1816: </pre>
1.91 ! rillig 1817: <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 1818: </div>
1819: </div>
1820: </div>
1821: </div>
1822: <div class="chapter" lang="en">
1823: <div class="titlepage"><div><div><h2 class="title">
1824: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1825: <div class="toc">
1826: <p><b>Table of Contents</b></p>
1827: <dl>
1828: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1829: <dd><dl>
1830: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1831: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1832: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1833: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1834: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1835: <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>
1836: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1837: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1838: </dl></dd>
1839: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1840: <dd><dl>
1841: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1842: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1843: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1844: </dl></dd>
1845: </dl>
1846: </div>
1847: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1848: is to only install the package tools and to use binary packages
1849: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1850: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1851: of pkgsrc, too. Then you are able to build your own packages,
1852: and you can still use binary packages from someone else.</p>
1.75 rillig 1853: <div class="sect1" lang="en">
1854: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1855: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1856: <p>To use binary packages, you need some tools to manage
1.88 wiz 1857: them. On NetBSD, these tools are already installed. On all other
1858: operating systems, you need to install them first. For the
1859: following platforms, prebuilt versions of the package tools
1860: are available and can simply be downloaded and unpacked in the
1861: <code class="filename">/</code> directory:</p>
1.75 rillig 1862: <div class="informaltable">
1863: <a name="binary-bootstrap-kits"></a><table border="1">
1864: <colgroup>
1865: <col>
1866: <col>
1867: </colgroup>
1868: <thead><tr>
1869: <th>Platform</th>
1870: <th>URL</th>
1871: </tr></thead>
1872: <tbody>
1873: <tr>
1874: <td>Solaris 9</td>
1.76 rillig 1875: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1876: </tr>
1877: <tr>
1878: <td>Solaris 10</td>
1.76 rillig 1879: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1880: </tr>
1881: </tbody>
1882: </table>
1883: </div>
1.82 rillig 1884: <p>These pre-built package tools use
1.88 wiz 1885: <code class="filename">/usr/pkg</code> for the base directory, and
1886: <code class="filename">/var/db/pkg</code> for the database of installed
1887: packages. If you cannot use these directories for whatever
1888: reasons (maybe because you're not root), you have to build the
1889: 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 1890: <div class="sect2" lang="en">
1891: <div class="titlepage"><div><div><h3 class="title">
1892: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1893: <p>To install binary packages, you first need to know from
1.88 wiz 1894: where to get them. You can get them on CD-ROMs, DVDs, or via FTP
1895: or HTTP.</p>
1.81 rillig 1896: <p>The binary packages can be found at the following
1.88 wiz 1897: locations.</p>
1.75 rillig 1898: <div class="informaltable">
1899: <a name="binary-packages"></a><table border="1">
1900: <colgroup>
1901: <col>
1902: <col>
1903: </colgroup>
1904: <thead><tr>
1905: <th>Platform</th>
1906: <th>URL</th>
1907: </tr></thead>
1908: <tbody>
1909: <tr>
1.81 rillig 1910: <td>NetBSD</td>
1911: <td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
1912: </tr>
1913: <tr>
1.75 rillig 1914: <td>Solaris 9</td>
1.76 rillig 1915: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
1.75 rillig 1916: </tr>
1917: <tr>
1918: <td>Solaris 10</td>
1.76 rillig 1919: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/</code></td>
1.75 rillig 1920: </tr>
1921: </tbody>
1922: </table>
1923: </div>
1.81 rillig 1924: <p>Most of these directories contain binary packages for
1.88 wiz 1925: multiple platforms. Select the appropriate subdirectories,
1926: according to your machine architecture and operating system,
1927: until you find a directory called <code class="filename">All</code>. This
1928: directory contains all the binary packages. Further, there are
1929: subdirectories for categories that contain symbolic links that
1930: point to the actual binary package in
1931: <code class="filename">../All</code>. This directory layout is used for
1932: all package repositories, no matter if they are accessed via
1933: HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
1.75 rillig 1934: </div>
1935: <div class="sect2" lang="en">
1936: <div class="titlepage"><div><div><h3 class="title">
1937: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87 wiz 1938: <p>If you have the files on a CD-ROM or downloaded them to
1.88 wiz 1939: your hard disk, you can install them with the following command
1940: (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75 rillig 1941: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87 wiz 1942: <p>If you have FTP access and you don't want to download the
1.88 wiz 1943: packages via FTP prior to installation, you can do this
1944: automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.82 rillig 1945: <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 1946: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1947: package in question will be installed, too, assuming they are
1948: present where you install from.</p>
1.75 rillig 1949: <p>To save some typing, you can set the
1.88 wiz 1950: <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
1951: list of paths (including remote URLs); trailing slashes are not allowed.
1952: </p>
1.76 rillig 1953: <p>Additionally to the <code class="filename">All</code> directory
1.88 wiz 1954: there exists a <code class="filename">vulnerable</code> directory to
1955: which binary packages with known vulnerabilities are
1956: moved, since removing them could cause missing dependencies. To
1957: use these packages, add the <code class="filename">vulnerable</code>
1958: directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91 ! rillig 1959: <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 1960: especially after installing new packages, and verify that the
1961: vulnerabilities are acceptable for your configuration. An example
1962: <code class="varname">PKG_PATH</code> would be:
1963: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
1964: Please note that semicolon (';') is a shell meta-character, so
1965: you'll probably have to quote it.</p>
1.75 rillig 1966: <p>After you've installed packages, be sure to have
1.88 wiz 1967: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1968: <code class="varname">PATH</code> so you can actually start the just
1969: installed program.</p>
1.75 rillig 1970: </div>
1971: <div class="sect2" lang="en">
1972: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1973: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1974: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1975: installed from source code or from a binary package. The
1976: <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
1977: To delete a package, you can just run <span><strong class="command">pkg_delete
1978: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1979: name can be given with or without version number. Wildcards can
1980: also be used to deinstall a set of packages, for example
1981: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1982: so that the shell does not expand them before
1983: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1984: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1985: removes all the packages that require the package in question
1986: and then removes the package itself. For example:
1.82 rillig 1987:
1.88 wiz 1988: </p>
1.82 rillig 1989: <pre class="screen">
1.88 wiz 1990: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1991: </pre>
1.82 rillig 1992: <p>
1993:
1.88 wiz 1994: will remove jpeg and all the packages that used it; this allows
1995: upgrading the jpeg package.</p>
1.82 rillig 1996: </div>
1997: <div class="sect2" lang="en">
1998: <div class="titlepage"><div><div><h3 class="title">
1999: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
2000: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88 wiz 2001: installed packages or binary package files.</p>
1.82 rillig 2002: </div>
2003: <div class="sect2" lang="en">
2004: <div class="titlepage"><div><div><h3 class="title">
2005: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
2006: <p>
1.88 wiz 2007: The NetBSD Security-Officer and Packages Groups maintain a list of
2008: known security vulnerabilities to packages which are (or have been)
2009: included in pkgsrc. The list is available from the NetBSD
2010: FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
2011: </p>
1.82 rillig 2012: <p>
1.91 ! rillig 2013: 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 2014: this list can be downloaded
2015: automatically, and a security audit of all packages installed on a system
2016: can take place.
2017: </p>
1.82 rillig 2018: <p>
1.88 wiz 2019: There are two components to
1.91 ! rillig 2020: <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 2021: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
2022: the list of vulnerabilities from the NetBSD FTP site. The second
2023: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
2024: installed packages are vulnerable. If a package is vulnerable, you
2025: will see output similar to the following:
2026: </p>
1.82 rillig 2027: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 2028: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 2029: <p>
1.91 ! rillig 2030: 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 2031: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
2032: file daily, and include a package audit in the daily security script.
2033: 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 2034: 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 2035: </p>
1.82 rillig 2036: </div>
2037: <div class="sect2" lang="en">
2038: <div class="titlepage"><div><div><h3 class="title">
2039: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
2040: <p>
1.91 ! rillig 2041: 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 2042: <span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
2043: argument to check if your packages are up-to-date, e.g.
2044: </p>
2045: <pre class="screen">
2046: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 2047: ...
1.88 wiz 2048: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
2049: </pre>
1.82 rillig 2050: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88 wiz 2051: package on your system and rebuild any dependencies.
2052: </p>
1.82 rillig 2053: </div>
2054: <div class="sect2" lang="en">
2055: <div class="titlepage"><div><div><h3 class="title">
2056: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
2057: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88 wiz 2058: administrative functions on the package system.</p>
1.82 rillig 2059: </div>
2060: <div class="sect2" lang="en">
2061: <div class="titlepage"><div><div><h3 class="title">
2062: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 2063: <p>Please pay very careful attention to the warnings
1.88 wiz 2064: 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
2065: inherent dangers of installing binary packages which you did
2066: not create yourself, and the security holes that can be
2067: introduced onto your system by indiscriminate adding of such
2068: files.</p>
1.75 rillig 2069: <p>The same warning of course applies to every package you
1.88 wiz 2070: install from source when you haven't completely read and
2071: understood the source code of the package, the compiler that
2072: is used to build the package and all the other tools that are
2073: involved.</p>
1.75 rillig 2074: </div>
2075: </div>
2076: <div class="sect1" lang="en">
2077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2078: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 2079: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
2080: directory now contains a set of packages, organized into
2081: categories. You can browse the online index of packages, or run
2082: <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
2083: directory to build local <code class="filename">README.html</code> files for
1.91 ! rillig 2084: 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 2085: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
2086: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
2087: should do so by setting <code class="varname">LOCALBASE</code> in
2088: <code class="filename">mk.conf</code>. You should not try to use multiple
2089: different <code class="varname">LOCALBASE</code> definitions on the same
2090: system (inside a chroot is an exception). </p>
2091: <p>The rest of this chapter assumes that the package is already
2092: 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
2093: instructions how to create your own packages.</p>
1.75 rillig 2094: <div class="sect2" lang="en">
2095: <div class="titlepage"><div><div><h3 class="title">
2096: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 2097: <p>To build packages from source, you need a working C
1.88 wiz 2098: compiler. On NetBSD, you need to install the
2099: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
2100: sets. If you want to build X11-related packages, the
2101: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
2102: sets are required, too.</p>
1.75 rillig 2103: </div>
2104: <div class="sect2" lang="en">
2105: <div class="titlepage"><div><div><h3 class="title">
2106: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
2107: <p>The first step for building a package is downloading the
1.88 wiz 2108: distfiles (i.e. the unmodified source). If they have not yet been
2109: downloaded, pkgsrc will fetch them automatically.</p>
2110: <p>If you have all files that you need in the
2111: <code class="filename">distfiles</code> directory,
2112: you don't need to connect. If the distfiles are on CD-ROM, you can
2113: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
2114: </p>
1.82 rillig 2115: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
2116: <p>
1.88 wiz 2117: to your <code class="filename">mk.conf</code>.</p>
1.91 ! rillig 2118: <p>By default a list of distribution sites will be randomly
! 2119: intermixed to prevent huge load on servers which holding popular
! 2120: packages (for example, SourceForge.net mirrors). Thus, every
! 2121: time when you need to fetch yet another distfile all the mirrors
! 2122: will be tried in new (random) order. You can turn this feature
! 2123: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
! 2124: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 2125: <p>You can overwrite some of the major distribution sites to
2126: fit to sites that are close to your own. By setting one or two
2127: variables you can modify the order in which the master sites are
2128: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
2129: delimited list of domain suffixes.
2130: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
2131: contains a whitespace delimited list of regular expressions. It
2132: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
2133: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
2134: some examples. This may save some of your bandwidth and
2135: time.</p>
1.75 rillig 2136: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 2137: if you want to keep the settings, by editing the
2138: <code class="filename">/etc/mk.conf</code> file,
2139: and adding the definitions there.</p>
1.82 rillig 2140: <p>
1.88 wiz 2141: If a package depends on many other packages (such as
1.91 ! rillig 2142: <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 2143: alternate between periods of
2144: downloading source, and compiling. To ensure you have all the source
2145: downloaded initially you can run the command:
2146: </p>
1.82 rillig 2147: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
2148: <p>
1.88 wiz 2149: which will output and run a set of shell commands to fetch the
2150: necessary files into the <code class="filename">distfiles</code> directory. You can
2151: also choose to download the files manually.
2152: </p>
1.75 rillig 2153: </div>
2154: <div class="sect2" lang="en">
2155: <div class="titlepage"><div><div><h3 class="title">
2156: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 2157: <p>
1.88 wiz 2158: Once the software has downloaded, any patches will be applied, then it
2159: will be compiled for you. This may take some time depending on your
2160: computer, and how many other packages the software depends on and their
2161: compile time.
2162: </p>
1.75 rillig 2163: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2164: <h3 class="title">Note</h3>
2165: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88 wiz 2166: use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
2167: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 2168: </div>
1.87 wiz 2169: <p>For example, type</p>
1.88 wiz 2170: <pre class="screen">
2171: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2172: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2173: </pre>
1.75 rillig 2174: <p>at the shell prompt to build the various components of the
1.88 wiz 2175: package.</p>
1.82 rillig 2176: <p>The next stage is to actually install the newly compiled
1.88 wiz 2177: program onto your system. Do this by entering:
1.82 rillig 2178:
1.88 wiz 2179: </p>
1.82 rillig 2180: <pre class="screen">
1.88 wiz 2181: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2182: </pre>
1.82 rillig 2183: <p>
2184:
1.88 wiz 2185: while you are still in the directory for whatever package you
2186: are installing.</p>
1.82 rillig 2187: <p>Installing the package on your system may require you to
1.88 wiz 2188: be root. However, pkgsrc has a
2189: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2190: to only become root for the actual installation step.</p>
1.82 rillig 2191: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2192: You can now enter:
1.82 rillig 2193:
1.88 wiz 2194: </p>
1.82 rillig 2195: <pre class="screen">
1.88 wiz 2196: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2197: </pre>
1.82 rillig 2198: <p>
2199:
1.88 wiz 2200: to remove the compiled files in the work directory, as you shouldn't need
2201: them any more. If other packages were also added to your system
2202: (dependencies) to allow your program to compile, you can tidy these up
2203: also with the command:</p>
1.82 rillig 2204: <pre class="screen">
1.88 wiz 2205: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2206: </pre>
1.75 rillig 2207: <p>Taking the figlet utility as an example, we can install it on our
1.88 wiz 2208: system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
2209: <p>The program is installed under the default root of the
2210: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2211: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2212: variable in your environment, and it will use that value as the
2213: root of your packages tree. So, to use
2214: <code class="filename">/usr/local</code>, set
2215: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2216: Please note that you should use a directory which is dedicated to
2217: packages and not shared with other programs (i.e., do not try and
2218: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2219: to add any of your own files or directories (such as
2220: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2221: <code class="filename">pkgsrc/</code>) below the
2222: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2223: conflicts between programs and other files installed by the
2224: package system and whatever else may have been installed
2225: there.</p>
2226: <p>Some packages look in <code class="filename">/etc/mk.conf</code> to
2227: alter some configuration options at build time. Have a look at
2228: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2229: of what will be set there by default. Environment variables such
2230: as <code class="varname">LOCALBASE</code> can be set in
2231: <code class="filename">/etc/mk.conf</code> to save having to remember to
2232: set them each time you want to use pkgsrc.</p>
2233: <p>Occasionally, people want to “<span class="quote">look under the
2234: covers</span>” to see what is going on when a package is building
2235: or being installed. This may be for debugging purposes, or out of
2236: simple curiosity. A number of utility values have been added to
2237: help with this.</p>
1.75 rillig 2238: <div class="orderedlist"><ol type="1">
2239: <li>
1.88 wiz 2240: <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
2241: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2242: information will be displayed. For example,</p>
1.75 rillig 2243: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2244: <p>will show all the commands that are invoked, up to and
2245: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 2246: </li>
2247: <li>
1.88 wiz 2248: <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>
2249: definition, then the <code class="varname">VARNAME</code> definition
2250: should be used, in conjunction with the show-var
2251: 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>
2252: variable <code class="varname">LOCALBASE</code>:</p>
2253: <pre class="screen">
2254: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2255: /usr/pkg
2256: <code class="prompt">%</code>
1.88 wiz 2257: </pre>
1.75 rillig 2258: </li>
2259: </ol></div>
2260: <p>If you want to install a binary package that you've either
1.88 wiz 2261: created yourself (see next section), that you put into
2262: pkgsrc/packages manually or that is located on a remote FTP
2263: server, you can use the "bin-install" target. This target will
2264: 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>,
2265: else do a <span><strong class="command">make package</strong></span>. The list of remote FTP
2266: sites searched is kept in the variable
2267: <code class="varname">BINPKG_SITES</code>, which defaults to
2268: 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>
2269: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2270: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2271: details.</p>
2272: <p>A final word of warning: If you set up a system that has a
2273: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2274: set that before any packages are installed, as you cannot use
2275: several directories for the same purpose. Doing so will result in
2276: pkgsrc not being able to properly detect your installed packages,
2277: and fail miserably. Note also that precompiled binary packages are
2278: usually built with the default <code class="varname">LOCALBASE</code> of
2279: <code class="filename">/usr/pkg</code>, and that you should
2280: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2281: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2282: </div>
2283: </div>
2284: </div>
2285: <div class="chapter" lang="en">
2286: <div class="titlepage"><div><div><h2 class="title">
2287: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2288: <div class="toc">
2289: <p><b>Table of Contents</b></p>
2290: <dl>
2291: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2292: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.78 rillig 2293: <dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2294: <dd><dl>
1.89 rillig 2295: <dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
2296: <dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2297: <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 2298: </dl></dd>
1.78 rillig 2299: <dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
2300: <dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
1.75 rillig 2301: </dl>
2302: </div>
1.89 rillig 2303: <p>The whole pkgsrc system is configured in a single file, usually
2304: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2305: that file depends on the installation. On NetBSD, when you use
2306: <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
2307: <code class="filename">/etc/</code>. In all other cases the default location is
2308: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2309: bootstrap program to install the binary packages.</p>
2310: <p>During the bootstrap, an example configuration file is created. To
2311: use that, you have to create the directory
2312: <code class="filename">${PREFIX}/etc</code> and copy the example file
2313: there.</p>
2314: <p>The format of the configuration file is that of the usual
2315: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2316: is done by setting variables in this file. Note that you can define all
2317: kinds of variables, and no special error checking (for example for
2318: spelling mistakes) takes place, so you have to try it out to see if it
2319: works.</p>
1.75 rillig 2320: <div class="sect1" lang="en">
2321: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2322: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2323: <p>In this section, you can find some variables that apply to all
1.89 rillig 2324: pkgsrc packages. A complete list of the variables that can be
2325: configured by the user is available in
2326: <code class="filename">mk/defaults/mk.conf</code>, together with some
2327: comments that describe each variable's intent.</p>
1.75 rillig 2328: <div class="itemizedlist"><ul type="disc">
2329: <li><p><code class="varname">LOCALBASE</code>: Where
2330: packages will be installed. The default is
1.76 rillig 2331: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2332: with different <code class="varname">LOCALBASE</code>s!</p></li>
2333: <li><p><code class="varname">CROSSBASE</code>: Where
2334: “<span class="quote">cross</span>” category packages will be
2335: installed. The default is
1.76 rillig 2336: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2337: <li><p><code class="varname">X11BASE</code>: Where
2338: X11 is installed on the system. The default is
1.76 rillig 2339: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2340: <li><p><code class="varname">DISTDIR</code>: Where to store the
2341: downloaded copies of the original source distributions used
2342: for building pkgsrc packages. The default is
1.76 rillig 2343: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.75 rillig 2344: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2345: If set, override the packages'
2346: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2347: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2348: Backup location(s) for distribution files and patch files
2349: if not found locally or in
1.76 rillig 2350: <code class="filename">${MASTER_SITES}</code> or
2351: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2352: The defaults are
1.76 rillig 2353: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2354: and
1.76 rillig 2355: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2356: <li><p><code class="varname">BINPKG_SITES</code>:
2357: List of sites carrying binary pkgs.</p></li>
1.82 rillig 2358: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2359: List of acceptable licenses. Whenever you try to build a package
2360: whose license is not in this list, you will get an error message
2361: that includes instructions on how to change this variable.</p></li>
1.75 rillig 2362: </ul></div>
2363: </div>
2364: <div class="sect1" lang="en">
2365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2366: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2367: <p>XXX
2368: </p>
2369: <div class="itemizedlist"><ul type="disc">
2370: <li><p><code class="varname">PACKAGES</code>: The top level
2371: directory for the binary packages. The default is
1.76 rillig 2372: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2373: <li><p><code class="varname">WRKOBJDIR</code>:
2374: The top level directory where, if defined, the separate
2375: working directories will get created, and symbolically
1.76 rillig 2376: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2377: This is useful for building packages on several
1.76 rillig 2378: architectures, then <code class="filename">${PKGSRCDIR}</code>
2379: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2380: is local to every architecture. (It should be noted that
2381: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.89 rillig 2382: — it is an internal definition which refers to the
1.75 rillig 2383: root of the pkgsrc tree. It is possible to have many
2384: pkgsrc tree instances.)</p></li>
2385: <li><p><code class="varname">LOCALPATCHES</code>:
2386: Directory for local patches that aren't part of pkgsrc.
1.90 rillig 2387: See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more
1.75 rillig 2388: information. <em class="replaceable"><code>rel</code></em> and
2389: <em class="replaceable"><code>arch</code></em> are replaced with OS
2390: release (“<span class="quote">2.0</span>”, etc.) and architecture
2391: (“<span class="quote">mipsel</span>”, etc.).</p></li>
2392: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.76 rillig 2393: the <code class="filename">mk.conf</code> file used by a package's
1.75 rillig 2394: BSD-style Makefile. If this is not set,
2395: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2396: <code class="filename">/dev/null</code> to avoid picking up
2397: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2398: <li><p><code class="varname">DEPENDS_TARGET</code>:
2399: By default, dependencies are only installed, and no binary
2400: package is created for them. You can set this variable to
2401: <code class="literal">package</code> to automatically create binary
2402: packages after installing dependencies.</p></li>
1.75 rillig 2403: </ul></div>
2404: </div>
2405: <div class="sect1" lang="en">
2406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78 rillig 2407: <a name="conf.compiler"></a>5.3. Selecting and configuring the compiler</h2></div></div></div>
2408: <div class="sect2" lang="en">
2409: <div class="titlepage"><div><div><h3 class="title">
1.89 rillig 2410: <a name="selecting-the-compiler"></a>5.3.1. Selecting the compiler</h3></div></div></div>
2411: <p>By default, pkgsrc will use GCC to build packages. This may be
2412: overridden by setting the following variables in /etc/mk.conf:</p>
2413: <div class="variablelist"><dl>
2414: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2415: <dd>
2416: <p>This is a list of values specifying the chain of
2417: compilers to invoke when building packages. Valid values
2418: are:</p>
2419: <div class="itemizedlist"><ul type="disc">
2420: <li><p><code class="varname">distcc</code>:
2421: distributed C/C++ (chainable)</p></li>
2422: <li><p><code class="varname">ccache</code>:
2423: compiler cache (chainable)</p></li>
2424: <li><p><code class="varname">gcc</code>:
2425: GNU C/C++ Compiler</p></li>
2426: <li><p><code class="varname">mipspro</code>:
2427: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2428: <li><p><code class="varname">mipspro</code>:
2429: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2430: <li><p><code class="varname">sunpro</code>:
2431: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2432: </ul></div>
2433: <p>The default is
2434: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2435: <code class="varname">ccache</code> and/or
2436: <code class="varname">distcc</code> with an appropriate
2437: <code class="varname">PKGSRC_COMPILER</code> setting,
2438: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
2439: variable should always be
2440: terminated with a value for a real compiler.</p>
2441: </dd>
2442: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2443: <dd><p>This specifies the minimum version of GCC to use
2444: when building packages. If the system GCC doesn't
2445: satisfy this requirement, then pkgsrc will build and
2446: install one of the GCC packages to use instead.</p></dd>
2447: </dl></div>
2448: </div>
2449: <div class="sect2" lang="en">
2450: <div class="titlepage"><div><div><h3 class="title">
2451: <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 2452: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2453: please make sure to use the <code class="literal">+=</code> operator
2454: instead of the <code class="literal">=</code> operator:</p>
2455: <pre class="programlisting">
2456: CFLAGS+= -your -flags
2457: </pre>
2458: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2459: “<span class="quote">+</span>”) may lead to problems with packages that need
2460: to add their own flags. Also, you may want to take a look at
1.91 ! rillig 2461: 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 2462: you're interested in optimization for the current CPU.</p>
2463: </div>
1.88 wiz 2464: <div class="sect2" lang="en">
2465: <div class="titlepage"><div><div><h3 class="title">
1.89 rillig 2466: <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 2467: <p>If you want to pass flags to the linker, both in the configure
2468: step and the build step, you can do this in two ways. Either set
2469: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2470: between the two is that <code class="varname">LIBS</code> will be appended to
2471: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2472: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2473: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2474: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2475: <code class="varname">CFLAGS</code>, if you do not wish to override these
2476: settings, use the <code class="literal">+=</code> operator:</p>
2477: <pre class="programlisting">
2478: LDFLAGS+= -your -linkerflags
2479: </pre>
2480: </div>
1.78 rillig 2481: </div>
2482: <div class="sect1" lang="en">
2483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2484: <a name="developer-advanced-settings"></a>5.4. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2485: <p>XXX
2486: </p>
2487: <div class="itemizedlist"><ul type="disc">
2488: <li>
2489: <p><code class="varname">PKG_DEVELOPER</code>:
2490: Run some sanity checks that package developers want:
2491: </p>
2492: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2493: <li><p>make sure patches apply with zero
2494: fuzz</p></li>
2495: <li><p>run check-shlibs to see that all
2496: binaries will find their shared libs.</p></li>
1.75 rillig 2497: </ul></div>
2498: <p>
1.87 wiz 2499: </p>
1.75 rillig 2500: </li>
1.88 wiz 2501: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2502: of debugging output which is displayed whilst making and
2503: installing the package. The default value for this is 0,
2504: which will not display the commands as they are executed
2505: (normal, default, quiet operation); the value 1 will display
2506: all shell commands before their invocation, and the value 2
2507: will display both the shell commands before their invocation,
2508: and their actual execution progress with <span><strong class="command">set
2509: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2510: </ul></div>
2511: <p>
2512: </p>
2513: </div>
2514: <div class="sect1" lang="en">
2515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.78 rillig 2516: <a name="selecting-build-options"></a>5.5. Selecting Build Options</h2></div></div></div>
1.88 wiz 2517: <p>Some packages have build time options, usually to select
2518: between different dependencies, enable optional support for big
2519: dependencies or enable experimental features.</p>
1.75 rillig 2520: <p>To see which options, if any, a package supports, and which
1.88 wiz 2521: options are mutually exclusive, run <span><strong class="command">make
2522: show-options</strong></span>, for example:</p>
1.75 rillig 2523: <pre class="programlisting">
2524: The following options are supported by this package:
2525: ssl Enable SSL support.
2526: Exactly one of the following gecko options is required:
2527: firefox Use firefox as gecko rendering engine.
2528: mozilla Use mozilla as gecko rendering engine.
2529: At most one of the following database options may be selected:
2530: mysql Enable support for MySQL database.
2531: pgsql Enable support for PostgreSQL database.
1.1 grant 2532:
1.75 rillig 2533: These options are enabled by default: firefox
2534: These options are currently enabled: mozilla ssl
1.1 grant 2535: </pre>
1.75 rillig 2536: <p>The following variables can be defined in
1.88 wiz 2537: <code class="filename">/etc/mk.conf</code> to select which options to
2538: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2539: which can be used to select or disable options for all packages
2540: that support them, and
2541: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2542: which can be used to select or disable options specifically for
2543: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2544: these variables are selected, options preceded by “<span class="quote">-</span>”
2545: are disabled. A few examples:</p>
1.75 rillig 2546: <pre class="screen">
2547: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" /etc/mk.conf</strong></span>
2548: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2549: PKG_OPTIONS.kdebase= debug -sasl
2550: PKG_OPTIONS.apache= suexec </pre>
1.88 wiz 2551: <p>The following settings are consulted in the order given, and
2552: the last setting that selects or disables an option is
2553: used:</p>
1.75 rillig 2554: <div class="orderedlist"><ol type="1">
2555: <li><p>the default options as suggested by the package
1.88 wiz 2556: maintainer</p></li>
1.75 rillig 2557: <li><p>the options implied by the settings of legacy
1.88 wiz 2558: variables (see below)</p></li>
1.75 rillig 2559: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2560: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2561: </ol></div>
2562: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2563: selected is used, all others are automatically disabled. If an
2564: option of the group is explicitly disabled, the previously
2565: selected option, if any, is used. It is an error if no option
2566: from a required group of options is selected, and building the
2567: package will fail.</p>
2568: <p>Before the options framework was introduced, build options
2569: were selected by setting a variable (often named
2570: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
2571: <code class="filename">/etc/mk.conf</code> for each option. To ease
2572: transition to the options framework for the user, these legacy
2573: variables are converted to the appropriate options setting
2574: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2575: automatically. A warning is issued to prompt the user to update
2576: <code class="filename">/etc/mk.conf</code> to use the options framework
2577: directly. Support for the legacy variables will be removed
2578: eventually.</p>
1.75 rillig 2579: </div>
2580: </div>
2581: <div class="chapter" lang="en">
2582: <div class="titlepage"><div><div><h2 class="title">
2583: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2584: <div class="toc">
2585: <p><b>Table of Contents</b></p>
2586: <dl>
2587: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2588: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2589: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
2590: <dd><dl>
2591: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
2592: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
2593: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
2594: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
2595: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
2596: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2597: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
2598: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
2599: </dl></dd>
2600: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2601: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
2602: </dl>
2603: </div>
2604: <div class="sect1" lang="en">
2605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2606: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2607: <p>Once you have built and installed a package, you can create
2608: a <span class="emphasis"><em>binary package</em></span> which can be installed on
2609: 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
2610: the same package on a group of hosts and wasting CPU time. It also
2611: provides a simple means for others to install your package, should
2612: you distribute it.</p>
2613: <p>To create a binary package, change into the appropriate
2614: directory in pkgsrc, and run <span><strong class="command">make
2615: package</strong></span>:</p>
2616: <pre class="screen">
2617: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2618: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2619: </pre>
2620: <p>This will build and install your package (if not already done),
2621: and then build a binary package from what was installed. You can
2622: then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
2623: it. Binary packages are created by default in
2624: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2625: gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 ! rillig 2626: 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 2627: <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 2628: such a binary package.</p>
1.75 rillig 2629: </div>
2630: <div class="sect1" lang="en">
2631: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2632: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90 rillig 2633: <p>See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, “Other helpful targets”</a>.</p>
1.75 rillig 2634: </div>
2635: <div class="sect1" lang="en">
2636: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2637: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
2638: <p>If you want to get a full set of precompiled binary
1.87 wiz 2639: packages, this section describes how to get them. Beware that
2640: the bulk build will remove all currently installed packages from
2641: your system!</p>
1.75 rillig 2642: <p>Having an FTP server configured either on the
1.87 wiz 2643: machine doing the bulk builds or on a nearby NFS server can help
2644: to make the packages available to other machines that can then
2645: 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
2646: more information. If you use a remote NFS server's storage, be
2647: sure to not actually compile on NFS storage, as this slows
2648: things down a lot.</p>
1.75 rillig 2649: <div class="sect2" lang="en">
2650: <div class="titlepage"><div><div><h3 class="title">
2651: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
2652: <div class="sect3" lang="en">
2653: <div class="titlepage"><div><div><h4 class="title">
1.76 rillig 2654: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code></h4></div></div></div>
2655: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2656: configuration file for bulk builds. You can configure how your
2657: copy of pkgsrc is kept up to date, how the distfiles are
2658: downloaded, how the packages are built and how the report is
2659: generated. You can find an annotated example file in
2660: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2661: it, copy <code class="filename">build.conf-example</code> to
2662: <code class="filename">build.conf</code> and edit it, following the
2663: comments in that file.</p>
1.75 rillig 2664: </div>
2665: <div class="sect3" lang="en">
2666: <div class="titlepage"><div><div><h4 class="title">
2667: <a name="binary.mk.conf"></a>6.3.1.2. /etc/mk.conf</h4></div></div></div>
2668: <p>You may want to set variables in
1.87 wiz 2669: <code class="filename">/etc/mk.conf</code>.
2670: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2671: details of the default settings. You will want to ensure that
2672: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2673: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
2674: accepts <span class="emphasis"><em>all</em></span> licenses.</p>
2675: <pre class="programlisting">
2676: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2677: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2678: BSDSRCDIR= /usr/src
2679: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2680: OBJHOSTNAME?= yes # use work.`hostname`
2681: FAILOVER_FETCH= yes # insist on the correct checksum
2682: PKG_DEVELOPER?= yes
2683: _ACCEPTABLE= yes
2684: </pre>
1.75 rillig 2685: <p>Some options that are especially useful for bulk builds
2686: can be found at the top lines of the file
1.76 rillig 2687: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2688: options of these are briefly described here.</p>
2689: <div class="itemizedlist"><ul type="disc">
2690: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2691: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2692: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2693: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2694: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2695: to the directory where all log files are created. Otherwise the
2696: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2697: <li><p>Another important variable is
1.87 wiz 2698: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2699: should be always available while building other
2700: packages.</p></li>
1.75 rillig 2701: </ul></div>
2702: <p>Some other options are scattered in the pkgsrc
2703: infrastructure:</p>
2704: <div class="itemizedlist"><ul type="disc">
2705: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2706: should be set to <code class="literal">yes</code>. The purpose of the bulk
2707: builds is creating binary packages, no matter if they are
2708: vulnerable or not. When uploading the packages to a public
2709: server, the vulnerable packages will be put into a directory of
2710: their own. Leaving this variable unset would prevent the bulk
2711: build system from even trying to build them, so possible
2712: building errors would not show up.</p></li>
1.75 rillig 2713: <li><p><code class="varname">CHECK_FILES</code>
1.87 wiz 2714: (<code class="filename">pkgsrc/mk/bsd.pkg.check.mk</code>) can be set to
2715: “<span class="quote">yes</span>” to check that the installed set of files
2716: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2717: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.87 wiz 2718: (<code class="filename">pkgsrc/mk/bsd.pkg.check.mk</code>) can be set to
2719: “<span class="quote">yes</span>” to check that the installed
2720: “<span class="quote">#!</span>”-scripts will find their
2721: interpreter.</p></li>
1.91 ! rillig 2722: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
! 2723: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
! 2724: package's self-test before installing it. Note that some
! 2725: packages make heavy use of “<span class="quote">good</span>” random
! 2726: numbers, so you need to assure that the machine on which you
! 2727: are doing the bulk builds is not completely idle. Otherwise
! 2728: some test programs will seem to hang, while they are just
! 2729: waiting for new random data to be
! 2730: available.</p></li>
1.75 rillig 2731: </ul></div>
2732: </div>
2733: <div class="sect3" lang="en">
2734: <div class="titlepage"><div><div><h4 class="title">
1.76 rillig 2735: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code></h4></div></div></div>
1.75 rillig 2736: <p>It is possible to configure the bulk build to perform
1.87 wiz 2737: certain site-specific tasks at the end of the pre-build
2738: stage. If the file
2739: <code class="filename">pre-build.local</code> exists in
2740: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2741: (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
2742: stage. An example use of
2743: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2744: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2745: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2746: <p>to prevent the system from trying to build a particular package
1.87 wiz 2747: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2748: </div>
2749: </div>
2750: <div class="sect2" lang="en">
2751: <div class="titlepage"><div><div><h3 class="title">
2752: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2753: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2754: deleted at the start of bulk builds, make sure your login
2755: shell is placed somewhere else. Either drop it into
2756: <code class="filename">/usr/local/bin</code> (and adjust your login
2757: shell in the passwd file), or (re-)install it via
2758: <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
2759: you can login after a reboot (remember that your current
2760: process won't die if the package is removed, you just can't
2761: start any new instances of the shell any more). Also, if you
2762: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2763: version of ssh for some reason, be sure to install ssh before
2764: starting it from <code class="filename">rc.local</code>:</p>
2765: <pre class="programlisting">
2766: ( cd /usr/pkgsrc/security/ssh ; make bulk-install )
2767: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2768: /usr/pkg/etc/rc.d/sshd
2769: fi
2770: </pre>
1.75 rillig 2771: <p>Not doing so will result in you being not able to log in
1.87 wiz 2772: via ssh after the bulk build is finished or if the machine
2773: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2774: </div>
2775: <div class="sect2" lang="en">
2776: <div class="titlepage"><div><div><h3 class="title">
2777: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
2778: <p>Make sure you don't need any of the packages still
1.87 wiz 2779: installed.</p>
1.75 rillig 2780: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2781: <h3 class="title">Warning</h3>
2782: <p>During the bulk build, <span class="emphasis"><em>all packages will be
1.87 wiz 2783: removed!</em></span></p>
1.75 rillig 2784: </div>
2785: <p>Be sure to remove all other things that might
1.87 wiz 2786: interfere with builds, like some libs installed in
2787: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2788: <pre class="screen">
2789: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2790: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2791: </pre>
1.75 rillig 2792: <p>If for some reason your last build didn't complete (power
1.87 wiz 2793: failure, system panic, ...), you can continue it by
2794: running:</p>
1.75 rillig 2795: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2796: <p>At the end of the bulk build, you will get a summary via mail,
2797: and find build logs in the directory specified by
2798: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2799: file.</p>
1.75 rillig 2800: </div>
2801: <div class="sect2" lang="en">
2802: <div class="titlepage"><div><div><h3 class="title">
2803: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
2804: <p>The bulk builds consist of three steps:</p>
2805: <div class="variablelist"><dl>
2806: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2807: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2808: cleans out any broken distfiles, and removes all
2809: packages installed.</p></dd>
1.75 rillig 2810: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2811: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2812: an optimised order in which packages will be
2813: built. Packages that don't require other packages will
2814: be built first, and packages with many dependencies will
2815: be built later.</p></dd>
1.75 rillig 2816: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2817: <dd><p>Generates a report that's placed in the directory
2818: specified in the <code class="filename">build.conf</code> file
2819: named <code class="filename">broken.html</code>, a short version
2820: of that report will also be mailed to the build's
2821: admin.</p></dd>
1.75 rillig 2822: </dl></div>
1.87 wiz 2823: <p>During the build, a list of broken packages will be compiled
2824: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2825: <code class="filename">.../.broken.${MACHINE}</code> if
2826: <code class="varname">OBJMACHINE</code> is set), individual build logs
2827: of broken builds can be found in the package's
2828: directory. These files are used by the bulk-targets to mark
2829: broken builds to not waste time trying to rebuild them, and
2830: they can be used to debug these broken package builds
2831: later.</p>
1.75 rillig 2832: </div>
2833: <div class="sect2" lang="en">
2834: <div class="titlepage"><div><div><h3 class="title">
2835: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
2836: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2837: NetBSD 2.0/i386:</p>
1.75 rillig 2838: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2839: <li><p>10 GB - distfiles (NFS ok)</p></li>
2840: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2841: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2842: </ul></div>
2843: <p>Note that all pkgs will be de-installed as soon as they are
2844: turned into a binary package, and that sources are removed,
2845: so there is no excessively huge demand to disk
2846: space. Afterwards, if the package is needed again, it will
2847: 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
2848: there are no cycles wasted by recompiling.</p>
1.75 rillig 2849: </div>
2850: <div class="sect2" lang="en">
2851: <div class="titlepage"><div><div><h3 class="title">
2852: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2853: <p>If you don't want all the packages nuked from a machine
2854: (rendering it useless for anything but pkg compiling), there
2855: is the possibility of doing the package bulk build inside a
2856: chroot environment.</p>
2857: <p>The first step is to set up a chroot sandbox,
2858: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2859: using null mounts, or manually.</p>
2860: <p>There is a shell script called
2861: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2862: up the sandbox environment using null mounts. It will also
2863: create a script called <code class="filename">sandbox</code> in the
2864: root of the sandbox environment, which will allow the null
2865: mounts to be activated using the <span><strong class="command">sandbox
2866: mount</strong></span> command and deactivated using the
2867: <span><strong class="command">sandbox umount</strong></span> command.</p>
2868: <p>To set up a sandbox environment by hand, after extracting all
2869: the sets from a NetBSD installation or doing a <span><strong class="command">make
2870: distribution DESTDIR=/usr/sandbox</strong></span> in
2871: <code class="filename">/usr/src/etc</code>, be sure the following items
2872: are present and properly configured:</p>
1.75 rillig 2873: <div class="procedure"><ol type="1">
2874: <li>
2875: <p>Kernel</p>
2876: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2877: </li>
2878: <li>
1.76 rillig 2879: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2880: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2881: </li>
2882: <li>
1.91 ! rillig 2883: <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 2884: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2885: </li>
2886: <li>
2887: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2888: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2889: </li>
2890: <li>
1.91 ! rillig 2891: <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 2892: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2893: </li>
2894: <li>
1.76 rillig 2895: <p><code class="filename">/usr/src</code> (system sources,
1.91 ! rillig 2896: 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 2897: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2898: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2899: </li>
2900: <li>
1.76 rillig 2901: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2902: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2903: </li>
2904: <li>
1.76 rillig 2905: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2906: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2907: </li>
2908: <li>
2909: <p>Checkout pkgsrc via cvs into
1.87 wiz 2910: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2911: <pre class="screen">
2912: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2913: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2914: </pre>
1.75 rillig 2915: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2916: you do development in, as this will likely cause problems!</p>
1.75 rillig 2917: </li>
2918: <li><p>Make
1.87 wiz 2919: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2920: <code class="filename">.../distfiles</code> point somewhere
2921: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.76 rillig 2922: <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>
2923: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2924: </ol></div>
2925: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2926: the build with the following steps:</p>
2927: <pre class="screen">
2928: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2929: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2930: </pre>
2931: <p>This will just jump inside the sandbox and start building. At
2932: the end of the build, mail will be sent with the results of
2933: the build. Created binary pkgs will be in
2934: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2935: (wherever that points/mounts to/from).</p>
1.75 rillig 2936: </div>
2937: <div class="sect2" lang="en">
2938: <div class="titlepage"><div><div><h3 class="title">
2939: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2940: <p>In addition to building a complete set of all packages in
2941: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2942: may be used to build a subset of the packages contained in
2943: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
2944: in <code class="filename">/etc/mk.conf</code>, the variables</p>
1.75 rillig 2945: <div class="itemizedlist"><ul type="disc">
2946: <li><p>SITE_SPECIFIC_PKGS</p></li>
2947: <li><p>HOST_SPECIFIC_PKGS</p></li>
2948: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2949: <li><p>USER_SPECIFIC_PKGS</p></li>
2950: </ul></div>
1.87 wiz 2951: <p>will define the set of packages which should be built.
2952: The bulk build code will also include any packages which are
2953: needed as dependencies for the explicitly listed packages.</p>
2954: <p>One use of this is to do a bulk build with
2955: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2956: periodically to have a complete set of the binary packages
2957: needed for your site available without the overhead of
2958: building extra packages that are not needed.</p>
1.75 rillig 2959: </div>
2960: <div class="sect2" lang="en">
2961: <div class="titlepage"><div><div><h3 class="title">
2962: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2963: <p>This section describes how pkgsrc developers can upload binary
2964: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2965: <p>If you would like to automatically create checksum files for the
2966: binary packages you intend to upload, remember to set
2967: <code class="varname">MKSUMS=yes</code> in your
2968: <code class="filename">mk/bulk/build.conf</code>.</p>
2969: <p>If you would like to PGP sign the checksum files (highly
2970: recommended!), remember to set
2971: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2972: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2973: your GPG password to sign the files before uploading everything.</p>
2974: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2975: set properly in your <code class="filename">mk/bulk/build.conf</code>
2976: file, i.e. adjust it to something like one of the following:</p>
1.75 rillig 2977: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload </pre>
2978: <p>Please use appropriate values for "pkgsrc-200xQy",
1.87 wiz 2979: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2980: is different from your local login, write your login directly
2981: into the variable, e.g. my local account is "feyrer", but for my
2982: login "hubertf", I use:</p>
2983: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload</pre>
2984: <p>A separate <code class="filename">upload</code> directory is used
2985: here to allow "closing" the directory during upload. To do
2986: so, run the following command on ftp.NetBSD.org next:</p>
1.75 rillig 2987: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87 wiz 2988: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2989: only appropriate for packages for the NetBSD operating
2990: system. Binary packages for other operating systems should go
2991: into <code class="filename">/pub/pkgsrc</code>.</p>
2992: <p>Before uploading the binary pkgs, ssh authentication needs
2993: to be set up. This example shows how to set up temporary keys
2994: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2995: (assuming that no keys should be present there usually):</p>
2996: <pre class="screen">
2997: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 2998: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2999: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 3000: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
3001: </pre>
3002: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
3003: append it to your <code class="filename">~/.ssh/authorized_keys</code>
3004: file on ftp.NetBSD.org. You can remove the key after the
3005: upload is done!</p>
3006: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 3007: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 3008: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
3009: <p>Now after all this works, you can exit the sandbox and start
3010: the upload:</p>
3011: <pre class="screen">
3012: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 3013: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 3014: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3015: </pre>
3016: <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
3017: <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
3018: upload. The upload script will take care of not uploading
3019: restricted packages and putting vulnerable packages into the
3020: <code class="filename">vulnerable</code> subdirectory.</p>
3021: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 3022: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 3023: Gdd:x! </pre>
3024: <p>Use whatever is needed to remove the key you've entered
3025: before! Last, move the uploaded packages out of the
3026: <code class="filename">upload</code> directory to have them accessible
3027: to everyone:</p>
3028: <pre class="screen">
3029: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 3030: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3031: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 3032: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
3033: </pre>
1.75 rillig 3034: </div>
3035: </div>
3036: <div class="sect1" lang="en">
3037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3038: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 3039: <p>After your pkgsrc bulk-build has completed, you may wish to
3040: create a CD-ROM set of the resulting binary packages to assist
3041: in installing packages on other machines. The
1.91 ! rillig 3042: <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 3043: a simple tool for creating the ISO 9660 images.
3044: <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
3045: way that keeps all the dependencies for a given package on the same
3046: CD as that package.</p>
1.75 rillig 3047: <div class="sect2" lang="en">
3048: <div class="titlepage"><div><div><h3 class="title">
3049: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 3050: <p>Complete documentation for cdpack is found in the cdpack(1)
3051: man page. The following short example assumes that the binary
3052: packages are left in
3053: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3054: sufficient disk space exists in <code class="filename">/u2</code> to
3055: hold the ISO 9660 images.</p>
3056: <pre class="screen">
3057: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3058: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3059: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3060: </pre>
3061: <p>If you wish to include a common set of files
3062: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3063: etc.) on each CD in the collection, then you need to create a
3064: directory which contains these files. e.g.</p>
3065: <pre class="screen">
3066: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3067: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3068: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3069: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3070: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3071: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3072: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3073: </pre>
1.75 rillig 3074: <p>Now create the images:</p>
3075: <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 3076: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3077: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3078: in their root directories.</p>
1.75 rillig 3079: </div>
3080: </div>
3081: </div>
3082: <div class="chapter" lang="en">
3083: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3084: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
3085: <div class="toc">
3086: <p><b>Table of Contents</b></p>
3087: <dl>
1.91 ! rillig 3088: <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 3089: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
3090: </dl>
3091: </div>
3092: <p>The files that are installed by pkgsrc are organized in a way that
3093: is similar to what you find in the <code class="filename">/usr</code> directory
3094: of the base system. But some details are different. This is because
3095: pkgsrc initially came from FreeBSD and had adopted its file system
3096: hierarchy. Later it was largely influenced by NetBSD. But no matter
3097: which operating system you are using pkgsrc with, you can expect the
3098: same layout for pkgsrc.</p>
1.91 ! rillig 3099: <p>There are mainly four root directories for pkgsrc, which are all
! 3100: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
! 3101: When pkgsrc has been installed as root, the default locations
! 3102: are:</p>
! 3103: <pre class="programlisting">
! 3104: LOCALBASE= /usr/pkg
! 3105: PKG_SYSCONFBASE= /usr/pkg/etc
! 3106: VARBASE= /var
! 3107: PKGDBDIR= /var/db/pkg
! 3108: </pre>
! 3109: <p>In unprivileged mode (when pkgsrc has been installed as any other
! 3110: user), the default locations are:</p>
! 3111: <pre class="programlisting">
! 3112: LOCALBASE= ${HOME}/pkg
! 3113: PKG_SYSCONFBASE= ${HOME}/pkg/etc
! 3114: VARBASE= ${HOME}/pkg/var
! 3115: PKGDBDIR= ${HOME}/pkg/var/db/pkg
! 3116: </pre>
! 3117: <p>What these four directories are for, and what they look like is
! 3118: explained below.</p>
1.90 rillig 3119: <div class="itemizedlist"><ul type="disc">
3120: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3121: <code class="filename">/usr</code> directory in the base system. It is the
3122: “<span class="quote">main</span>” directory where the files are installed and contains
3123: the well-known subdirectories like <code class="filename">bin</code>,
3124: <code class="filename">include</code>, <code class="filename">lib</code>,
3125: <code class="filename">share</code> and
3126: <code class="filename">sbin</code>.</p></li>
3127: <li><p><code class="varname">VARBASE</code> corresponds to
3128: <code class="filename">/var</code> in the base system. Some programs (especially
3129: games, network daemons) need write access to it during normal
3130: operation.</p></li>
3131: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3132: <code class="filename">/etc</code> in the base system. It contains configuration
3133: files of the packages, as well as pkgsrc's <code class="filename">mk.conf</code>
3134: itself.</p></li>
3135: </ul></div>
3136: <div class="sect1" lang="en">
3137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.91 ! rillig 3138: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code></h2></div></div></div>
1.90 rillig 3139: <p>The following directories exist in a typical pkgsrc installation
1.91 ! rillig 3140: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3141: <div class="variablelist"><dl>
3142: <dt><span class="term"><code class="filename">bin</code></span></dt>
3143: <dd><p>Contains executable programs that are intended to be
3144: directly used by the end user.</p></dd>
3145: <dt><span class="term"><code class="filename">emul</code></span></dt>
3146: <dd><p>Contains files for the emulation layers of various other
3147: operating systems, especially for
3148: NetBSD.</p></dd>
3149: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3150: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3151: <dd><p>Contains
3152: the configuration files.</p></dd>
3153: <dt><span class="term"><code class="filename">include</code></span></dt>
3154: <dd><p>Contains headers for the C and C++ programming
3155: languages.</p></dd>
3156: <dt><span class="term"><code class="filename">info</code></span></dt>
3157: <dd><p>Contains GNU info files of various
3158: packages.</p></dd>
3159: <dt><span class="term"><code class="filename">lib</code></span></dt>
3160: <dd><p>Contains shared and static
3161: libraries.</p></dd>
3162: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3163: <dd><p>Contains data files that don't change after
3164: installation. Other data files belong into
3165: <code class="filename">${VARBASE}</code>.</p></dd>
3166: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3167: <dd><p>Contains programs that are not intended to be used by
3168: end users, such as helper programs or network
3169: daemons.</p></dd>
3170: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3171: <dd><p>Contains programs that are intended to be executed as
3172: CGI scripts by a web server.</p></dd>
3173: <dt><span class="term"><code class="filename">man</code> (the usual value of
3174: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3175: <dd><p>Contains brief
3176: documentation in form of manual pages.</p></dd>
3177: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3178: <dd><p>Contains programs that are intended to be used only by
3179: the super-user.</p></dd>
3180: <dt><span class="term"><code class="filename">share</code></span></dt>
3181: <dd><p>Contains platform-independent data files that don't
3182: change after installation.</p></dd>
3183: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3184: <dd><p>Contains documentation files provided by the
3185: packages.</p></dd>
3186: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3187: <dd><p>Contains example files provided by the packages. Among
3188: others, the original configuration files are saved here and copied to
3189: <code class="filename">${PKG_SYSCONFDIR}</code> during
3190: installation.</p></dd>
3191: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3192: <dd><p>Contains the original files for rc.d
3193: scripts.</p></dd>
3194: <dt><span class="term"><code class="filename">var</code> (the usual location of
3195: <code class="filename">${VARBASE}</code>)</span></dt>
3196: <dd><p>Contains files
3197: that may be modified after
3198: installation.</p></dd>
3199: </dl></div>
3200: </div>
3201: <div class="sect1" lang="en">
3202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3203: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code></h2></div></div></div>
3204: <div class="variablelist"><dl>
3205: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3206: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3207: <dd><p>Contains
3208: information about the currently installed
3209: packages.</p></dd>
3210: <dt><span class="term"><code class="filename">games</code></span></dt>
3211: <dd><p>Contains highscore
3212: files.</p></dd>
3213: <dt><span class="term"><code class="filename">log</code></span></dt>
3214: <dd><p>Contains log files.</p></dd>
3215: <dt><span class="term"><code class="filename">run</code></span></dt>
3216: <dd><p>Contains informational files about daemons that are
3217: currently running.</p></dd>
3218: </dl></div>
3219: </div>
3220: </div>
3221: <div class="chapter" lang="en">
3222: <div class="titlepage"><div><div><h2 class="title">
3223: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3224: <div class="toc">
3225: <p><b>Table of Contents</b></p>
3226: <dl>
1.90 rillig 3227: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3228: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
3229: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
3230: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
3231: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
3232: <dt><span class="sect1"><a href="#XFree86-from-pkgsrc">8.6. How can I install/use XFree86 from pkgsrc?</a></span></dt>
3233: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.7. How can I install/use X.org from pkgsrc?</a></span></dt>
3234: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.8. How to fetch files from behind a firewall</a></span></dt>
3235: <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>
3236: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.10. How to fetch all distfiles at once</a></span></dt>
3237: <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 3238: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.90 rillig 3239: <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>
3240: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.13. Using 'sudo' with pkgsrc</a></span></dt>
3241: <dt><span class="sect1"><a href="#faq.conf">8.14. How do I change the location of configuration files?</a></span></dt>
3242: <dt><span class="sect1"><a href="#audit-packages">8.15. Automated security checks</a></span></dt>
3243: <dt><span class="sect1"><a href="#ufaq-cflags">8.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3244: <dt><span class="sect1"><a href="#ufaq-fail">8.17. A package does not build. What shall I do?</a></span></dt>
3245: <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>
3246: <dt><span class="sect1"><a href="#too-much-time">8.19. I have a little time to kill. What shall I do?</a></span></dt>
1.75 rillig 3247: </dl>
3248: </div>
3249: <p>This section contains hints, tips & tricks on special things in
3250: pkgsrc that we didn't find a better place for in the previous chapters, and
3251: it contains items for both pkgsrc users and developers.</p>
3252: <div class="sect1" lang="en">
3253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3254: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3255: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3256: <div class="itemizedlist"><ul type="disc">
1.78 rillig 3257: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
3258: This is a general purpose list for most issues regarding
3259: pkgsrc, regardless of platform, e.g. soliciting user help
3260: for pkgsrc configuration, unexpected build failures, using
3261: particular packages, upgrading pkgsrc installations,
3262: questions regarding the pkgsrc release branches, etc. General announcements or
3263: proposals for changes that impact the pkgsrc user community,
3264: e.g. major infrastructure changes, new features, package
3265: removals, etc., may also be posted.</p></li>
1.75 rillig 3266: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
3267: A list where the results of pkgsrc bulk builds are sent and
3268: discussed.</p></li>
3269: <li><p><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
3270: This list is for those who are interested in getting a
3271: commit message for every change committed to pkgsrc. It is
3272: also available in digest form, meaning one daily message
3273: containing all commit messages for changes to the package
3274: source tree in that 24 hour period.</p></li>
3275: </ul></div>
3276: <p>To subscribe, do:</p>
3277: <pre class="programlisting">
3278: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3279: </pre>
3280: <p>Archives for all these mailing lists are available from
3281: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3282: </div>
3283: <div class="sect1" lang="en">
3284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3285: <a name="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3286: <p>Pkgviews is tightly integrated with buildlink. You can find a
3287: pkgviews User's guide in
1.76 rillig 3288: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3289: </div>
3290: <div class="sect1" lang="en">
3291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3292: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3293: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3294: a number of useful utilities for both users and developers of pkgsrc. This
3295: section attempts only to make the reader aware of the utilities and when
3296: they might be useful, and not to duplicate the documentation that comes
3297: with each package.</p>
3298: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 ! rillig 3299: <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 3300: Symlinks for use by buildlink.</p></li></ul></div>
3301: <p>OS tool augmentation (automatically installed when needed):</p>
3302: <div class="itemizedlist"><ul type="disc">
1.91 ! rillig 3303: <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 3304: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 ! rillig 3305: <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 3306: Compatibility library for pkgsrc tools.</p></li>
1.91 ! rillig 3307: <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 3308: non-BSD systems due to lack of native mtree.</p></li>
1.91 ! rillig 3309: <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 3310: Up-to-date replacement for
1.76 rillig 3311: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3312: systems where pkg_install is not present.</p></li>
3313: </ul></div>
3314: <p>Utilities used by pkgsrc (not automatically installed):</p>
3315: <div class="itemizedlist"><ul type="disc">
1.91 ! rillig 3316: <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 3317: Create a binary package from an
3318: already-installed package. Used by <span><strong class="command">make replace</strong></span> to
3319: save the old package.</p></li>
1.91 ! rillig 3320: <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 3321: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3322: from multiple locations. It currently supports the following
3323: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 ! rillig 3324: <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 3325: packages someplace else (enabled by default).</p></li>
1.91 ! rillig 3326: <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 3327: best compiler flags to optimise code for your current CPU and
3328: compiler.</p></li>
3329: </ul></div>
3330: <p>Utilities for keeping track of installed packages, being up to date,
3331: etc:</p>
3332: <div class="itemizedlist"><ul type="disc">
1.91 ! rillig 3333: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75 rillig 3334: packages whose installed versions do not match the latest pkgsrc
3335: entries.</p></li>
1.91 ! rillig 3336: <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 3337: dependency graphs of packages, to aid in choosing a strategy for
3338: updating.</p></li>
1.91 ! rillig 3339: <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
! 3340: 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>
! 3341: <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 3342: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3343: does various checks on the complete pkgsrc system.</p></li>
1.91 ! rillig 3344: <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 3345: packages you have installed.</p></li>
3346: </ul></div>
3347: <p>Utilities for people maintaining or creating individual packages:</p>
3348: <div class="itemizedlist"><ul type="disc">
1.91 ! rillig 3349: <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 3350: making and maintaining patches for a package (includes pkgdiff,
3351: pkgvi, mkpatches, etc.).</p></li>
1.91 ! rillig 3352: <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>,
! 3353: <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 3354: converting to pkgsrc.</p></li>
1.91 ! rillig 3355: <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 3356: pkgsrc to a Solaris package.</p></li>
3357: </ul></div>
3358: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3359: utilities)</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/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75 rillig 3362: packages in a chrooted area.</p></li>
1.91 ! rillig 3363: <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 3364: kernel version for chrooted cross builds.</p></li>
3365: </ul></div>
3366: </div>
3367: <div class="sect1" lang="en">
3368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3369: <a name="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3370: <p>If you want to use pkgsrc as non-root user, you can set some
3371: variables to make pkgsrc work under these conditions. At the very least,
3372: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3373: will turn on unprivileged mode and set multiple related variables to allow
3374: installation of packages as non-root.</p>
3375: <p>In case the defaults are not enough, you may want to tune some other
3376: variables used. For example, if the automatic user/group detection leads
3377: to incorrect values (or not the ones you would like to use), you can change
3378: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3379: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3380: <p>As regards bootstrapping, please note that the
3381: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
3382: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3383: use multiple default directories under <code class="filename">~/pkg</code> as the
1.75 rillig 3384: installation targets. These directories can be overriden by the
3385: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3386: that allow finer tuning of the tree layout.</p>
3387: </div>
3388: <div class="sect1" lang="en">
3389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3390: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3391: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3392: enable this feature by adding the option
3393: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.76 rillig 3394: <code class="filename">/etc/mk.conf</code>. If, during a fetch step, an incomplete
1.75 rillig 3395: distfile is found, pkgsrc will try to resume it.</p>
3396: <p>You can also
3397: 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
3398: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3399: <code class="varname">FETCH_RESUME_ARGS</code> and
3400: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3401: values.</p>
3402: <p>For example, if you want to use
1.76 rillig 3403: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75 rillig 3404: like:</p>
3405: <pre class="programlisting">
3406: FETCH_CMD= wget
3407: FETCH_BEFORE_ARGS= --passive-ftp
3408: FETCH_RESUME_ARGS= -c
3409: FETCH_OUTPUT_ARGS= -O
1.1 grant 3410: </pre>
1.75 rillig 3411: </div>
3412: <div class="sect1" lang="en">
3413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3414: <a name="XFree86-from-pkgsrc"></a>8.6. How can I install/use XFree86 from pkgsrc?</h2></div></div></div>
1.75 rillig 3415: <p>If you want to use XFree86 from pkgsrc instead of your system's own
1.76 rillig 3416: X11 (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>,
1.75 rillig 3417: ...), you will have to add the following line into
1.76 rillig 3418: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3419: <pre class="programlisting">
3420: X11_TYPE=XFree86
1.1 grant 3421: </pre>
1.75 rillig 3422: </div>
3423: <div class="sect1" lang="en">
3424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3425: <a name="x.org-from-pkgsrc"></a>8.7. How can I install/use X.org from pkgsrc?</h2></div></div></div>
1.75 rillig 3426: <p>If you want to use X.org from pkgsrc instead of your system's own X11
1.76 rillig 3427: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3428: you will have to add the following line into
1.76 rillig 3429: <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3430: <pre class="programlisting">
3431: X11_TYPE=xorg
1.1 grant 3432: </pre>
1.75 rillig 3433: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3434: <h3 class="title">Note</h3>
3435: <p>The DragonFly operating system defaults to using
1.87 wiz 3436: this X.org X11 implementation from pkgsrc.</p>
1.75 rillig 3437: </div>
3438: </div>
3439: <div class="sect1" lang="en">
3440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3441: <a name="fetch-behind-firewall"></a>8.8. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3442: <p>If you are sitting behind a firewall which does not allow direct
3443: connections to Internet hosts (i.e. non-NAT), you may specify the
3444: relevant proxy hosts. This is done using an environment variable in the
3445: form of a URL, e.g. in Amdahl, the machine
3446: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3447: port 80 as the proxy port number. So the proxy environment variables
3448: are:</p>
3449: <pre class="programlisting">
3450: ftp_proxy=ftp://orpheus.amdahl.com:80/
3451: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3452: </pre>
1.75 rillig 3453: </div>
3454: <div class="sect1" lang="en">
3455: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3456: <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 3457: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3458: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3459: the first available command from the following list:</p>
3460: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3461: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3462: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3463: </ul></div>
3464: <p>On a default NetBSD installation, this will be
1.76 rillig 3465: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3466: connections first, and falls back to active connections if the server
3467: refuses to do passive. For the other tools, add the following to your
1.76 rillig 3468: <code class="filename">/etc/mk.conf</code> file:
1.75 rillig 3469: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3470: <p>Having that option present will prevent
1.76 rillig 3471: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3472: transfers.</p>
3473: </div>
3474: <div class="sect1" lang="en">
3475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3476: <a name="fetching-all-distfiles"></a>8.10. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3477: <p>You would like to download all the distfiles in a single batch
3478: from work or university, where you can't run a <span><strong class="command">make
3479: 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 3480: but downloading the entire directory may not be appropriate.</p>
3481: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76 rillig 3482: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3483: resulting list to your machine at work/school and use it there. If you
3484: 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
3485: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3486: URL:</p>
3487: <p>At home:</p>
3488: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3489: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3490: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3491: <p>At work:</p>
3492: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3493: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3494: home.</p>
3495: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3496: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3497: machine architecture), you can do so by using the above-mentioned
3498: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
3499: directly by running:</p>
1.75 rillig 3500: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3501: <p>If you even decide to ignore
3502: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3503: by running:</p>
3504: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3505: </div>
3506: <div class="sect1" lang="en">
3507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3508: <a name="tmac.andoc-missing"></a>8.11. What does “<span class="quote">Don't know how to make
1.75 rillig 3509: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 ! rillig 3510: <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 3511: package, you get the error from make that it doesn't know how to make
1.76 rillig 3512: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3513: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3514: the NetBSD base distribution on your machine. It is recommended to do
3515: that to format man pages.</p>
1.91 ! rillig 3516: <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 3517: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.76 rillig 3518: environment or in <code class="filename">/etc/mk.conf</code>.</p>
1.75 rillig 3519: </div>
3520: <div class="sect1" lang="en">
3521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3522: <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 3523: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3524: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3525: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3526: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3527: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3528: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.75 rillig 3529: the one that corresponds to your release (determine via <span><strong class="command">uname
3530: -r</strong></span>).</p>
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="using-sudo-with-pkgsrc"></a>8.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3535: <p>When installing packages as non-root user and using the just-in-time
3536: <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
3537: password for each required package installed. To avoid this, the sudo
3538: package can be used, which does password caching over a limited time. To
3539: use it, install sudo (either as binary package or from
1.91 ! rillig 3540: <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 3541: into your <code class="filename">/etc/mk.conf</code>:</p>
1.75 rillig 3542: <pre class="programlisting">
3543: .if exists(${LOCALBASE}/bin/sudo)
3544: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3545: .endif
1.1 grant 3546: </pre>
1.75 rillig 3547: </div>
3548: <div class="sect1" lang="en">
3549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3550: <a name="faq.conf"></a>8.14. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3551: <p>As the system administrator, you can choose where configuration files
3552: are installed. The default settings make all these files go into
1.76 rillig 3553: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3554: be suboptimal depending on your expectations (e.g., a read-only,
3555: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3556: configuration of the provided packages).</p>
3557: <p>In order to change the defaults, you can modify the
3558: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.76 rillig 3559: <code class="filename">/etc/mk.conf</code>) to point to your preferred configuration
3560: directory; some common examples include <code class="filename">/etc</code> or
3561: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3562: <p>Furthermore, you can change this value on a per-package basis by
3563: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3564: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3565: package you would like to modify, that is, the contents of
3566: <code class="varname">PKGBASE</code>.</p>
3567: <p>Note that after changing these settings, you must rebuild and
3568: reinstall any affected packages.</p>
3569: </div>
3570: <div class="sect1" lang="en">
3571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3572: <a name="audit-packages"></a>8.15. Automated security checks</h2></div></div></div>
1.75 rillig 3573: <p>Please be aware that there can often be bugs in third-party software,
3574: and some of these bugs can leave a machine vulnerable to exploitation by
3575: attackers. In an effort to lessen the exposure, the NetBSD packages team
3576: maintains a database of known-exploits to packages which have at one time
3577: been included in pkgsrc. The database can be downloaded automatically, and
3578: a security audit of all packages installed on a system can take place. To
1.91 ! rillig 3579: 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 3580: components:</p>
3581: <div class="orderedlist"><ol type="1">
3582: <li>
3583: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
3584: download a list of the security vulnerabilities information. This list
3585: is kept up to date by the NetBSD security officer and the NetBSD
3586: packages team, and is distributed from the NetBSD ftp server:</p>
3587: <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>
3588: </li>
3589: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
3590: current machine, checking each vulnerability which is known. If a
3591: vulnerable package is installed, it will be shown by output to stdout,
3592: including a description of the type of vulnerability, and a URL
3593: containing more information.</p></li>
3594: </ol></div>
1.91 ! rillig 3595: <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 3596: package is strongly recommended! After
3597: “<span class="quote">audit-packages</span>” is installed, please read
3598: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3599: audit-packages</code></strong>.</p>
1.87 wiz 3600: <p>If this package is installed, pkgsrc builds will use it to
3601: 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
3602: check.</p>
1.75 rillig 3603: </div>
3604: <div class="sect1" lang="en">
3605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3606: <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 3607: <p>When you add your own preferences to the
3608: <code class="varname">CFLAGS</code> variable in your
1.76 rillig 3609: <code class="filename">mk.conf</code>, these flags are passed in
3610: environment variables to the <code class="filename">./configure</code>
1.75 rillig 3611: 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
3612: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3613: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3614: package.</p>
3615: <p>Currently there is no solution to this problem. If you
3616: really need the package to use your <code class="varname">CFLAGS</code>
3617: you should run <span><strong class="command">make patch</strong></span> in the package
1.76 rillig 3618: directory and then inspect any <code class="filename">Makefile</code> and
3619: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3620: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3621: these lines. But be aware that some “<span class="quote">smart</span>”
3622: programmers write so bad code that it only works for the
3623: specific combination of <code class="varname">CFLAGS</code> they have
3624: chosen.</p>
3625: </div>
1.80 rillig 3626: <div class="sect1" lang="en">
3627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3628: <a name="ufaq-fail"></a>8.17. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3629: <div class="procedure"><ol type="1">
3630: <li><p>Make sure that your copy of pkgsrc is consistent. A
3631: case that occurs often is that people only update pkgsrc in
3632: parts, because of performance reasons. Since pkgsrc is one large
3633: system, not a collection of many small systems, there are
3634: sometimes changes that only work when the whole pkgsrc tree is
3635: updated.</p></li>
3636: <li><p>Make sure that you don't have any CVS conflicts.
3637: Search for “<span class="quote"><<<<<<</span>” or
3638: “<span class="quote">>>>>>></span>” in all your pkgsrc
3639: files.</p></li>
3640: <li><p>Make sure that you don't have old copies of the packages
3641: extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
3642: verify this.</p></li>
3643: <li><p>If the problem still exists, write a mail to the
3644: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3645: </ol></div>
3646: </div>
1.88 wiz 3647: <div class="sect1" lang="en">
3648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3649: <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 3650: <p>You have modified a file from pkgsrc, and someone else has
3651: modified that same file afterwards in the CVS repository. Both changes
3652: are in the same region of the file, so when you updated pkgsrc, the
3653: <code class="literal">cvs</code> command marked the conflicting changes in the
3654: file. Because of these markers, the file is no longer a valid
3655: <code class="filename">Makefile</code>.</p>
3656: <p>Have a look at that file, and if you don't need your local changes
3657: anymore, you can remove that file and run <span><strong class="command">cvs -q update
3658: -dP</strong></span> in that directory to download the current version.</p>
3659: </div>
3660: <div class="sect1" lang="en">
3661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3662: <a name="too-much-time"></a>8.19. I have a little time to kill. What shall I do?</h2></div></div></div>
1.88 wiz 3663: <p>This is not really an FAQ yet, but here's the answer
3664: anyway.</p>
3665: <div class="itemizedlist"><ul type="disc">
3666: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
1.91 ! rillig 3667: <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
1.88 wiz 3668: will tell you about newer versions of installed packages that are
3669: available, but not yet updated in pkgsrc.</p></li>
3670: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.89 rillig 3671: — it contains a list of suggested new packages and a list of
1.88 wiz 3672: cleanups and enhancements for pkgsrc that would be nice to
3673: have.</p></li>
3674: <li><p>Review packages for which review was requested on
3675: the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
3676: mailing list.</p></li>
3677: </ul></div>
3678: </div>
1.75 rillig 3679: </div>
3680: </div>
3681: <div class="part" lang="en">
3682: <div class="titlepage"><div><div><h1 class="title">
3683: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3684: <div class="partintro" lang="en">
3685: <div></div>
3686: <p>This part of the book deals with creating and
3687: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3688: guide on creating a new package. The remaining chapters are more
3689: like a reference manual for pkgsrc.</p>
1.75 rillig 3690: <div class="toc">
3691: <p><b>Table of Contents</b></p>
3692: <dl>
1.90 rillig 3693: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 ! rillig 3694: <dd><dl>
! 3695: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
! 3696: <dd><dl>
! 3697: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
! 3698: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
! 3699: </dl></dd>
! 3700: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
! 3701: <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>
! 3702: </dl></dd>
1.90 rillig 3703: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 3704: <dd><dl>
1.90 rillig 3705: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
3706: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
3707: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
3708: <dd><dl>
3709: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.1. Patching guidelines</a></span></dt>
3710: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.2. Feedback to the author</a></span></dt>
3711: </dl></dd>
3712: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
3713: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
3714: <dd><dl>
3715: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
3716: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
3717: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
3718: </dl></dd>
3719: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
3720: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
3721: </dl></dd>
3722: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3723: <dd><dl>
3724: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
3725: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
3726: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
3727: <dd><dl>
3728: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
3729: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
3730: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
3731: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
3732: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.2.5. Workaround for a bug in BSD Make</a></span></dt>
3733: </dl></dd>
3734: </dl></dd>
3735: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
3736: <dd><dl>
3737: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
3738: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3739: <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>
3740: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
3741: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
3742: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3743: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
3744: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
3745: </dl></dd>
3746: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
3747: <dd><dl>
3748: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
3749: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3750: <dd><dl>
3751: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3752: <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>
3753: </dl></dd>
3754: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3755: <dd><dl>
3756: <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>
3757: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3758: </dl></dd>
3759: </dl></dd>
3760: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
3761: <dd><dl>
3762: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
3763: <dd><dl>
3764: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
3765: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
3766: </dl></dd>
3767: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
3768: <dd><dl>
3769: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3770: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
3771: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
3772: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
3773: </dl></dd>
3774: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
3775: <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>
3776: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
3777: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
3778: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
3779: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
3780: <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>
3781: </dl></dd>
3782: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
3783: <dd><dl>
3784: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
3785: <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>
3786: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
3787: </dl></dd>
3788: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
3789: <dd><dl>
3790: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
3791: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
3792: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
3793: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
3794: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3795: <dd><dl>
3796: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
3797: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
3798: </dl></dd>
3799: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3800: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3801: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3802: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3803: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3804: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3805: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3806: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3807: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3808: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3809: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
3810: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
3811: </dl></dd>
3812: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
3813: <dd><dl>
3814: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3815: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3816: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3817: </dl></dd>
3818: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
3819: <dd><dl>
3820: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
3821: <dd><dl>
3822: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
3823: <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>
3824: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
3825: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
3826: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
3827: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
3828: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
3829: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
3830: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
3831: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
3832: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3833: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3834: </dl></dd>
3835: <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>
3836: <dd><dl>
3837: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3838: <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>
3839: </dl></dd>
3840: <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>
3841: <dd><dl>
3842: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
3843: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3844: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
3845: </dl></dd>
3846: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
3847: <dd><dl>
3848: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
3849: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
3850: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
3851: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
3852: </dl></dd>
3853: <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>
3854: <dd><dl>
3855: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
3856: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
3857: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3858: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
3859: </dl></dd>
3860: <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>
3861: <dd><dl>
3862: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
3863: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
3864: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
3865: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
3866: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
3867: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
3868: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
3869: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
3870: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
3871: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
3872: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
3873: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
3874: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
3875: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
3876: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
3877: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
3878: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 3879: emulation</a></span></dt>
1.90 rillig 3880: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
3881: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.77 rillig 3882: </dl></dd>
1.90 rillig 3883: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3884: </dl></dd>
1.90 rillig 3885: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
3886: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 3887: <dd><dl>
1.90 rillig 3888: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
3889: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3890: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
3891: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
3892: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
3893: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
3894: </dl></dd>
3895: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
3896: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3897: <dd><dl>
3898: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3899: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3900: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3901: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 3902: </dl></dd>
1.75 rillig 3903: </dl>
3904: </div>
1.77 rillig 3905: </div>
3906: <div class="chapter" lang="en">
3907: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3908: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 ! rillig 3909: <div class="toc">
! 3910: <p><b>Table of Contents</b></p>
! 3911: <dl>
! 3912: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
! 3913: <dd><dl>
! 3914: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
! 3915: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
! 3916: </dl></dd>
! 3917: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
! 3918: <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>
! 3919: </dl>
! 3920: </div>
1.77 rillig 3921: <p>When you find a package that is not yet in pkgsrc, you
1.91 ! rillig 3922: most likely have a URL from where you can download the source
! 3923: code. Starting with this URL, creating a package involves only a
! 3924: few steps.</p>
1.77 rillig 3925: <div class="procedure"><ol type="1">
1.91 ! rillig 3926: <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 3927: <li><p>Then, choose one of the top-level directories as the
1.91 ! rillig 3928: category in which you want to place your package. You can also create a
! 3929: directory of your own (maybe called <code class="filename">local</code>). In that
! 3930: category directory, create another directory for your package and change
! 3931: into it.</p></li>
! 3932: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
! 3933: you for a URL. Enter the URL of the distribution file (in most cases a
! 3934: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
! 3935: of your package are created automatically. The distribution file is
! 3936: extracted automatically to fill in some details in the
! 3937: <code class="filename">Makefile</code> that would otherwise have to be done
! 3938: manually.</p></li>
! 3939: <li>
! 3940: <p>Examine the extracted files to determine the dependencies of
! 3941: your package. Ideally, this is mentioned in some
! 3942: <code class="filename">README</code> file, but things may differ. For each of
! 3943: these dependencies, look where it exists in pkgsrc, and if there is a
! 3944: file called <code class="filename">buildlink3.mk</code> in that directory, add a
! 3945: line to your package <code class="filename">Makefile</code> which includes that
! 3946: file just before the last line. If the
! 3947: <code class="filename">buildlink3.mk</code> file does not exist, add a
! 3948: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
! 3949: version of the dependency and where it can be found in pkgsrc. This line
! 3950: should be placed in the third paragraph. If the dependency is only
! 3951: needed for building the package, but not when using it, use
! 3952: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
! 3953: Your package may then look like this:</p>
1.77 rillig 3954: <pre class="programlisting">
3955: [...]
3956:
3957: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3958: DEPENDS+= screen-[0-9]*:../../misc/screen
3959: DEPENDS+= screen>=4.0:../../misc/screen
3960:
3961: [...]
3962:
3963: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3964: .include "../../devel/glib2/buildlink3.mk"
3965: .include "../../mk/bsd.pkg.mk"
3966: </pre>
3967: </li>
1.91 ! rillig 3968: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
! 3969: to be done to make your package a “<span class="quote">good</span>” one. If you don't
! 3970: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
! 3971: --explain</strong></span> or <span><strong class="command">pkglint
! 3972: -e</strong></span>, which outputs additional
! 3973: explanations.</p></li>
! 3974: <li><p>In many cases the package is not yet ready to build. You can
! 3975: 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
! 3976: over there, you can hopefully continue here.</p></li>
! 3977: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
! 3978: directory from the extracted files. Besides these files, a lot of cache
! 3979: files and other system information has been saved in the working
! 3980: directory, which may become wrong after you edited the
! 3981: <code class="filename">Makefile</code>.</p></li>
! 3982: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
! 3983: 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>
! 3984: <li><p>When the package builds fine, the next step is to install
! 3985: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
! 3986: everything works.</p></li>
! 3987: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
! 3988: contains a list of the files that are installed by the package, is
! 3989: nearly empty. Run <span><strong class="command">bmake print-PLIST
! 3990: >PLIST</strong></span> to generate a probably correct list. Check
! 3991: the file using your preferred text editor to see if the list of
! 3992: files looks plausible.</p></li>
! 3993: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
! 3994: <code class="filename">PLIST</code> contains garbage or not.</p></li>
! 3995: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
! 3996: has been registered in the database of installed files, but with an
! 3997: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
! 3998: and <span><strong class="command">bmake install</strong></span> again. Now the package is
! 3999: registered with the list of files from
! 4000: <code class="filename">PLIST</code>.</p></li>
! 4001: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
! 4002: package from the set of installed files.</p></li>
1.77 rillig 4003: </ol></div>
1.91 ! rillig 4004: <div class="sect1" lang="en">
! 4005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
! 4006: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
! 4007: <div class="sect2" lang="en">
! 4008: <div class="titlepage"><div><div><h3 class="title">
! 4009: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
! 4010: <p>Simple Perl modules are handled automatically by
! 4011: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
! 4012: </div>
! 4013: <div class="sect2" lang="en">
! 4014: <div class="titlepage"><div><div><h3 class="title">
! 4015: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
! 4016: <p>KDE applications should always include
! 4017: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
! 4018: settings that are typical of KDE packages.</p>
! 4019: </div>
! 4020: </div>
! 4021: <div class="sect1" lang="en">
! 4022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
! 4023: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
! 4024: <div class="sect2" lang="en">
! 4025: <div class="titlepage"><div><div><h3 class="title">
! 4026: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
! 4027: <div class="sect3" lang="en">
! 4028: <div class="titlepage"><div><div><h4 class="title">
! 4029: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
! 4030: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
! 4031: that the “<span class="quote">nvu</span>” package has not yet been imported into
! 4032: pkgsrc. As the description says it has to do with the web, the obvious
! 4033: choice for the category is “<span class="quote">www</span>”.</p>
! 4034: <pre class="programlisting">
! 4035: <code class="prompt">$</code> mkdir www/nvu
! 4036: <code class="prompt">$</code> cd www/nvu
! 4037: </pre>
! 4038: <p>The web site says that the sources are available as a tar file, so
! 4039: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
! 4040: <pre class="programlisting">
! 4041: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
! 4042: </pre>
! 4043: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
! 4044: below the <code class="varname">DISTNAME</code> line, as the package name should
! 4045: not have the word “<span class="quote">sources</span>” in it. I also filled in the
! 4046: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
! 4047: <code class="varname">COMMENT</code> fields. Then the package
! 4048: <code class="filename">Makefile</code> looked like that:</p>
! 4049: <pre class="programlisting">
! 4050: # $NetBSD$
! 4051: #
! 4052:
! 4053: DISTNAME= nvu-1.0-sources
! 4054: PKGNAME= nvu-1.0
! 4055: CATEGORIES= www
! 4056: MASTER_SITES= http://cvs.nvu.com/download/
! 4057: EXTRACT_SUFX= .tar.bz2
! 4058:
! 4059: MAINTAINER= rillig@NetBSD.org
! 4060: HOMEPAGE= http://cvs.nvu.com/
! 4061: COMMENT= Web Authoring System
! 4062:
! 4063: # url2pkg-marker (please do not remove this line.)
! 4064: .include "../../mk/bsd.pkg.mk"
! 4065: </pre>
! 4066: <p>Then, I quit the editor and watched pkgsrc downloading a large
! 4067: source archive:</p>
! 4068: <pre class="programlisting">
! 4069: url2pkg> Running "make makesum" ...
! 4070: => Required installed package digest>=20010302: digest-20060826 found
! 4071: => Fetching nvu-1.0-sources.tar.bz2
! 4072: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
! 4073: 100% |*************************************| 28992 KB 150.77 KB/s 00:00 ETA
! 4074: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
! 4075: url2pkg> Running "make extract" ...
! 4076: => Required installed package digest>=20010302: digest-20060826 found
! 4077: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
! 4078: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
! 4079: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
! 4080: ===> Installing dependencies for nvu-1.0
! 4081: ===> Overriding tools for nvu-1.0
! 4082: ===> Extracting for nvu-1.0
! 4083: url2pkg> Adjusting the Makefile.
! 4084:
! 4085: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
! 4086:
! 4087: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
! 4088: </pre>
! 4089: </div>
! 4090: <div class="sect3" lang="en">
! 4091: <div class="titlepage"><div><div><h4 class="title">
! 4092: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
! 4093: <p>Now that the package has been extracted, let's see what's inside
! 4094: it. The package has a <code class="filename">README.txt</code>, but that only
! 4095: says something about mozilla, so it's probably useless for seeing what
! 4096: dependencies this package has. But since there is a GNU configure script
! 4097: in the package, let's hope that it will complain about everything it
! 4098: needs.</p>
! 4099: <pre class="programlisting">
! 4100: <code class="prompt">$</code> bmake
! 4101: => Required installed package digest>=20010302: digest-20060826 found
! 4102: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
! 4103: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
! 4104: ===> Patching for nvu-1.0
! 4105: ===> Creating toolchain wrappers for nvu-1.0
! 4106: ===> Configuring for nvu-1.0
! 4107: [...]
! 4108: configure: error: Perl 5.004 or higher is required.
! 4109: [...]
! 4110: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
! 4111: [...]
! 4112: </pre>
! 4113: <p>That worked quite well. So I opened the package Makefile in my
! 4114: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
! 4115: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
! 4116: package have changed now, and since a perl wrapper is automatically
! 4117: installed in the “<span class="quote">tools</span>” phase, I need to build the package
! 4118: from scratch.</p>
! 4119: <pre class="programlisting">
! 4120: <code class="prompt">$</code> bmake clean
! 4121: ===> Cleaning for nvu-1.0
! 4122: <code class="prompt">$</code> bmake
! 4123: [...]
! 4124: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
! 4125: GNU Make. You will not be able to build Mozilla without GNU Make.
! 4126: [...]
! 4127: </pre>
! 4128: <p>So I added “<span class="quote">gmake</span>” to the
! 4129: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
! 4130: <pre class="programlisting">
! 4131: [...]
! 4132: checking for GTK - version >= 1.2.0... no
! 4133: *** Could not run GTK test program, checking why...
! 4134: [...]
! 4135: </pre>
! 4136: <p>Now to the other dependencies. The first question is: Where is the
! 4137: GTK package hidden in pkgsrc?</p>
! 4138: <pre class="programlisting">
! 4139: <code class="prompt">$</code> echo ../../*/gtk*
! 4140: [many packages ...]
! 4141: <code class="prompt">$</code> echo ../../*/gtk
! 4142: ../../x11/gtk
! 4143: <code class="prompt">$</code> echo ../../*/gtk2
! 4144: ../../x11/gtk2
! 4145: <code class="prompt">$</code> echo ../../*/gtk2/bui*
! 4146: ../../x11/gtk2/buildlink3.mk
! 4147: </pre>
! 4148: <p>The first try was definitely too broad. The second one had exactly
! 4149: one result, which is very good. But there is one pitfall with GNOME
! 4150: packages. Before GNOME 2 had been released, there were already many
! 4151: GNOME 1 packages in pkgsrc. To be able to continue to use these
! 4152: packages, the GNOME 2 packages were imported as separate packages, and
! 4153: their names usually have a “<span class="quote">2</span>” appended. So I checked
! 4154: whether this was the case here, and indeed it was.</p>
! 4155: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
! 4156: file, adding the dependency is very easy. I just inserted an
! 4157: <code class="literal">.include</code> line before the last line of the package
! 4158: <code class="filename">Makefile</code>, so that it now looks like this:</p>
! 4159: <pre class="programlisting">
! 4160: [...]
! 4161: .include "../../x11/gtk2/buildlink3.mk"
! 4162: .include "../../mk/bsd.pkg.mk
! 4163: </pre>
! 4164: <p>After another <span><strong class="command">bmake clean && bmake</strong></span>, the answer
! 4165: was:</p>
! 4166: <pre class="programlisting">
! 4167: [...]
! 4168: checking for gtk-config... /home/roland/pkg/bin/gtk-config
! 4169: checking for GTK - version >= 1.2.0... no
! 4170: *** Could not run GTK test program, checking why...
! 4171: *** The test program failed to compile or link. See the file config.log for the
! 4172: *** exact error that occured. This usually means GTK was incorrectly installed
! 4173: *** or that you have moved GTK since it was installed. In the latter case, you
! 4174: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
! 4175: configure: error: Test for GTK failed.
! 4176: [...]
! 4177: </pre>
! 4178: <p>In this particular case, the assumption that “<span class="quote">every package
! 4179: prefers GNOME 2</span>” had been wrong. The first of the lines above
! 4180: told me that this package really wanted to have the GNOME 1 version of
! 4181: GTK. If the package had looked for GTK2, it would have looked for
! 4182: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
! 4183: So I changed the <code class="literal">x11/gtk2</code> to
! 4184: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
! 4185: and tried again.</p>
! 4186: <pre class="programlisting">
! 4187: [...]
! 4188: 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
! 4189: In file included from xpidl.c:42:
! 4190: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
! 4191: In file included from xpidl.c:42:
! 4192: xpidl.h:132: error: parse error before "IDL_ns"
! 4193: [...]
! 4194: </pre>
! 4195: <p>The package still does not find all of its dependencies. Now the
! 4196: question is: Which package provides the
! 4197: <code class="filename">libIDL/IDL.h</code> header file?</p>
! 4198: <pre class="programlisting">
! 4199: <code class="prompt">$</code> echo ../../*/*idl*
! 4200: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
! 4201: <code class="prompt">$</code> echo ../../*/*IDL*
! 4202: ../../net/libIDL
! 4203: </pre>
! 4204: <p>Let's take the one from the second try. So I included the
! 4205: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
! 4206: again. But the error didn't change. After digging through some of the
! 4207: code, I concluded that the build process of the package was broken and
! 4208: couldn't have ever worked, but since the Mozilla source tree is quite
! 4209: large, I didn't want to fix it. So I added the following to the package
! 4210: <code class="filename">Makefile</code> and tried again:</p>
! 4211: <pre class="programlisting">
! 4212: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
! 4213: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
! 4214: </pre>
! 4215: <p>The latter line is needed because the package expects the library
! 4216: <code class="filename">libIDL.so</code>, but only
! 4217: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
! 4218: wrapper to rewrite that on the fly.</p>
! 4219: <p>The next problem was related to a recent change of the FreeType
! 4220: 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>
! 4221: which patch files were relevant for this issue and copied them to the
! 4222: <code class="filename">patches</code> directory. Then I retried, fixed the
! 4223: patches so that they applied cleanly and retried again. This time,
! 4224: everything worked.</p>
! 4225: </div>
! 4226: <div class="sect3" lang="en">
! 4227: <div class="titlepage"><div><div><h4 class="title">
! 4228: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
! 4229: <pre class="programlisting">
! 4230: <code class="prompt">$</code> bmake CHECK_FILES=no install
! 4231: [...]
! 4232: <code class="prompt">$</code> bmake print-PLIST >PLIST
! 4233: <code class="prompt">$</code> bmake deinstall
! 4234: <code class="prompt">$</code> bmake install
! 4235: </pre>
! 4236: </div>
! 4237: </div>
! 4238: </div>
1.77 rillig 4239: </div>
1.75 rillig 4240: <div class="chapter" lang="en">
4241: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4242: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4243: <div class="toc">
4244: <p><b>Table of Contents</b></p>
4245: <dl>
1.90 rillig 4246: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
4247: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
4248: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
4249: <dd><dl>
4250: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.1. Patching guidelines</a></span></dt>
4251: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.2. Feedback to the author</a></span></dt>
4252: </dl></dd>
4253: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
4254: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
4255: <dd><dl>
4256: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
4257: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
4258: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4259: </dl></dd>
1.90 rillig 4260: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
4261: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4262: </dl>
4263: </div>
1.87 wiz 4264: <p>Whenever you're preparing a package, there are a number of
4265: files involved which are described in the following
4266: sections.</p>
1.75 rillig 4267: <div class="sect1" lang="en">
4268: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4269: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code></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.90 rillig 4407: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code></h2></div></div></div>
1.76 rillig 4408: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4409: digest, or checksum, of each distfile needed for the package. This
4410: ensures that the distfiles retrieved from the Internet have not been
4411: corrupted during transfer or altered by a malign force to introduce
4412: a security hole. Due to recent rumor about weaknesses of digest
4413: algorithms, all distfiles are protected using both SHA1 and RMD160
4414: message digests, as well as the file size.</p>
1.76 rillig 4415: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4416: checksums for all the patches found in the
1.90 rillig 4417: <code class="filename">patches</code> directory (see <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a>).</p>
1.76 rillig 4418: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87 wiz 4419: <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
4420: command.</p>
1.75 rillig 4421: <p>Some packages have different sets of distfiles depending on
1.91 ! rillig 4422: 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 4423: <code class="filename">distinfo</code> file and care should be taken when
4424: upgrading such a package to ensure distfile information is not
4425: lost.</p>
1.75 rillig 4426: </div>
4427: <div class="sect1" lang="en">
4428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4429: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.75 rillig 4430: <p>This directory contains files that are used by the
1.87 wiz 4431: <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> command to
4432: modify the sources as distributed in the distribution file into a form
4433: that will compile and run perfectly on NetBSD. The files are applied
4434: successively in alphabetic order (as returned by a shell
4435: “<span class="quote">patches/patch-*</span>” glob expansion), so
4436: <code class="filename">patch-aa</code> is applied before
4437: <code class="filename">patch-ab</code>, etc.</p>
1.76 rillig 4438: <p>The <code class="filename">patch-*</code> files should be in
1.87 wiz 4439: <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
4440: problems. (To force patches to apply
4441: with fuzz you can set <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>).
4442: Furthermore, do not put changes for more than one file into a single
4443: patch file, as this will make future modifications more difficult.</p>
1.75 rillig 4444: <p>Similar, a file should be patched at most once, not several times by
1.87 wiz 4445: several different patches. If a file needs several patches, they should
4446: be combined into one file.</p>
1.75 rillig 4447: <p>One important thing to mention is to pay attention that no RCS IDs
1.87 wiz 4448: get stored in the patch files, as these will cause problems when
4449: later checked into the NetBSD CVS tree. Use the
4450: <span><strong class="command">pkgdiff</strong></span> from the
1.91 ! rillig 4451: <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
1.87 wiz 4452: these problems.</p>
4453: <p>For even more automation, we recommend using
4454: <span><strong class="command">mkpatches</strong></span> from the same package to make a
4455: whole set of patches. You just have to backup files before you
4456: edit them to <code class="filename">filename.orig</code>, e.g. with
4457: <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
4458: using <span><strong class="command">pkgvi</strong></span> again from the same package. If
4459: you upgrade a package this way, you can easily compare the new
4460: set of patches with the previously existing one with
4461: <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
4462: or update from the <code class="filename">work/.newpatches</code>
4463: directory to <code class="filename">patches/</code>.</p>
4464: <p>When you have finished a package, remember to generate
4465: the checksums for the patch files by using the <span><strong class="command">make
1.90 rillig 4466: 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 4467: <p>When adding a patch that corrects a problem in the
4468: distfile (rather than e.g. enforcing pkgsrc's view of where
4469: man pages should go), send the patch as a bug report to the
4470: maintainer. This benefits non-pkgsrc users of the package,
4471: and usually makes it possible to remove the patch in future
4472: version.</p>
4473: <p>If you want to share patches between multiple packages
4474: in pkgsrc, e.g. because they use the same distfiles, set
4475: <code class="varname">PATCHDIR</code> to the path where the patch files
4476: can be found, e.g.:</p>
4477: <pre class="programlisting">
4478: PATCHDIR= ${.CURDIR}/../xemacs/patches
4479: </pre>
1.75 rillig 4480: <p>Patch files that are distributed by the author or other
1.87 wiz 4481: maintainers can be listed in
4482: <code class="varname">PATCHFILES</code>.</p>
4483: <p>If it is desired to store any patches that should not be
4484: committed into pkgsrc, they can be kept outside the pkgsrc
4485: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4486: directory tree there is expected to have the same
4487: “<span class="quote">category/package</span>” structure as pkgsrc, and
4488: patches are expected to be stored inside these dirs (also
4489: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4490: example, if you want to keep a private patch for
4491: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4492: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4493: files in the named directory are expected to be patch files,
4494: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4495: applied</em></span>.</p>
1.85 jmmv 4496: <div class="sect2" lang="en">
4497: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4498: <a name="components.patches.guidelines"></a>10.3.1. Patching guidelines</h3></div></div></div>
1.85 jmmv 4499: <p>When fixing a portability issue in the code do not use
4500: preprocessor magic to check for the current operating system nor
4501: platform. Doing so hurts portability to other platforms because
4502: the OS-specific details are not abstracted appropriately.</p>
4503: <p>The general rule to follow is: instead of checking for the
4504: operating system the application is being built on, check for the
4505: specific <span class="emphasis"><em>features</em></span> you need. For example,
4506: instead of assuming that kqueue is available under NetBSD and
4507: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.89 rillig 4508: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4509: yes, this generally involves patching the
4510: <span><strong class="command">configure</strong></span> script. There is absolutely nothing
4511: that prevents some OSes from adopting interfaces from other OSes
4512: (e.g. Linux implementing kqueue), something that the above checks
4513: cannot take into account.</p>
4514: <p>Of course, checking for features generally involves more
4515: work on the developer's side, but the resulting changes are
1.87 wiz 4516: cleaner and there are chances they will work on many other
1.85 jmmv 4517: platforms. Not to mention that there are higher chances of being
4518: later integrated into the mainstream sources. Remember:
4519: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4520: <p>Some typical examples:</p>
4521: <div class="table">
1.90 rillig 4522: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91 ! rillig 4523: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4524: <colgroup>
4525: <col>
4526: <col>
4527: <col>
4528: </colgroup>
4529: <thead><tr>
4530: <th>Where</th>
4531: <th>Incorrect</th>
4532: <th>Correct</th>
4533: </tr></thead>
4534: <tbody>
4535: <tr>
4536: <td>configure script</td>
4537: <td>
4538: <pre class="programlisting">case ${target_os} in
1.87 wiz 4539: netbsd*) have_kvm=yes ;;
4540: *) have_kvm=no ;;
4541: esac</pre>
1.85 jmmv 4542: </td>
4543: <td>
4544: <pre class="programlisting">AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)</pre>
4545: </td>
4546: </tr>
4547: <tr>
4548: <td>C source file</td>
4549: <td>
4550: <pre class="programlisting">#if defined(__NetBSD__)
1.87 wiz 4551: # include <sys/event.h>
4552: #endif</pre>
1.85 jmmv 4553: </td>
4554: <td>
4555: <pre class="programlisting">#if defined(HAVE_SYS_EVENT_H)
1.87 wiz 4556: # include <sys/event.h>
4557: #endif</pre>
1.85 jmmv 4558: </td>
4559: </tr>
4560: <tr>
4561: <td>C source file</td>
4562: <td>
4563: <pre class="programlisting">int
1.87 wiz 4564: monitor_file(...)
4565: {
4566: #if defined(__NetBSD__)
4567: int fd = kqueue();
4568: ...
4569: #else
4570: ...
4571: #endif
4572: }</pre>
1.85 jmmv 4573: </td>
4574: <td>
4575: <pre class="programlisting">int
1.87 wiz 4576: monitor_file(...)
4577: {
4578: #if defined(HAVE_KQUEUE)
4579: int fd = kqueue();
4580: ...
4581: #else
4582: ...
4583: #endif
4584: }</pre>
1.85 jmmv 4585: </td>
4586: </tr>
4587: </tbody>
1.91 ! rillig 4588: </table></div>
1.85 jmmv 4589: </div>
1.91 ! rillig 4590: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85 jmmv 4591: packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4592: 1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4593: 2</a>). It summarizes multiple details on how to make
4594: software easier to package; all the suggestions in it were
4595: collected from our experience in pkgsrc work, so they are possibly
4596: helpful when creating patches too.</p>
4597: </div>
4598: <div class="sect2" lang="en">
4599: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4600: <a name="components.patches.feedback"></a>10.3.2. Feedback to the author</h3></div></div></div>
1.85 jmmv 4601: <p>Always, always, <span class="strong"><strong>always</strong></span>
4602: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4603: improvements you do to a package to the mainstream developers.
4604: This is the only way to get their attention on portability issues
4605: and to ensure that future versions can be built out-of-the box on
4606: NetBSD. Furthermore, any user that gets newer distfiles will get
4607: the fixes straight from the packaged code.</p>
4608: <p>This generally involves cleaning up the patches as described
4609: in the following section (because sometimes the patches that are
4610: added to pkgsrc are quick hacks), filling bug reports in the
4611: appropriate trackers for the projects and working with the
4612: mainstream authors to accept your changes. It is
4613: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4614: the packages in pkgsrc are kept simple and thus further changes
4615: can be done without much hassle.</p>
4616: <p>Support the idea of free software!</p>
4617: </div>
1.75 rillig 4618: </div>
4619: <div class="sect1" lang="en">
4620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4621: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4622: <div class="variablelist"><dl>
1.76 rillig 4623: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4624: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4625: any credits where they are due. Please bear in mind that others do not
4626: share your sense of humour (or spelling idiosyncrasies), and that others
4627: will read everything that you write here.</p></dd>
1.76 rillig 4628: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4629: <dd><p>This file governs the files that are installed on your
4630: system: all the binaries, manual pages, etc. There are other
4631: directives which may be entered in this file, to control the
4632: creation and deletion of directories, and the location of
1.90 rillig 4633: inserted files. See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87 wiz 4634: information.</p></dd>
1.75 rillig 4635: </dl></div>
4636: </div>
4637: <div class="sect1" lang="en">
4638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4639: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78 rillig 4640: <div class="sect2" lang="en">
4641: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4642: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4643: <div class="variablelist"><dl>
1.76 rillig 4644: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75 rillig 4645: <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 4646: First time after package extraction and before files are
4647: moved in place, the second time after the files to install
4648: are moved in place. This can be used to do any custom
4649: procedures not possible with @exec commands in
4650: <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 4651: <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 4652: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4653: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4654: this script's responsibility to clean up any additional messy details
4655: around the package's installation, since all pkg_delete knows is how to
4656: delete the files created in the original distribution.
4657: 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>
4658: 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 4659: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4660: <dd>
4661: <p>This file is displayed after installation of the package.
1.87 wiz 4662: Useful for things like legal notices on almost-free
4663: software and hints for updating config files after
4664: installing modules for apache, PHP etc.
4665: Please note that you can modify variables in it easily by using
4666: <code class="varname">MESSAGE_SUBST</code> in the package's
4667: <code class="filename">Makefile</code>:</p>
1.75 rillig 4668: <pre class="programlisting">
1.87 wiz 4669: MESSAGE_SUBST+= SOMEVAR="somevalue"
4670: </pre>
1.75 rillig 4671: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4672: <code class="filename">MESSAGE</code>. By default, substitution is
4673: performed for <code class="varname">PKGNAME</code>,
4674: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4675: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4676: <code class="varname">X11BASE</code>,
4677: <code class="varname">PKG_SYSCONFDIR</code>,
4678: <code class="varname">ROOT_GROUP</code>, and
4679: <code class="varname">ROOT_GROUP</code>.</p>
4680: <p>You can display a different or additional files by
4681: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4682: default is <code class="filename">MESSAGE</code>, if the file
4683: exists.</p>
1.75 rillig 4684: </dd>
1.78 rillig 4685: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4686: <dd><p>FIXME: There is no documentation on the
4687: alternatives framework.</p></dd>
4688: </dl></div>
4689: </div>
4690: <div class="sect2" lang="en">
4691: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4692: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4693: <div class="variablelist"><dl>
4694: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4695: <dd><p>This file contains arbitrary things that could
4696: also go into a <code class="filename">Makefile</code>, but its purpose is
4697: to be used by more than one package. This file should only be
4698: used when the packages that will use the file are known in
4699: advance. For other purposes it is often better to write a
4700: <code class="filename">*.mk</code> file and give it a good name that
4701: describes what it does.</p></dd>
4702: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4703: <dd><p>This file contains the dependency information
1.90 rillig 4704: 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 4705: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4706: <dd><p>This file contains workarounds for compiler bugs
4707: and similar things. It is included automatically by the pkgsrc
4708: infrastructure, so you don't need an extra
4709: <code class="literal">.include</code> line for
4710: it.</p></dd>
4711: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4712: <dd><p>This file contains the code for the
1.90 rillig 4713: 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 4714: selected by the user. If a package has only one or two options,
4715: it is equally acceptable to put the code directly into the
4716: <code class="filename">Makefile</code>.</p></dd>
4717: </dl></div>
4718: </div>
4719: <div class="sect2" lang="en">
4720: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4721: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4722: <div class="variablelist"><dl>
4723: <dt><span class="term"><code class="filename">README*</code></span></dt>
4724: <dd><p>These files do not take place in the creation of
4725: a package and thus are purely informative to the package
4726: developer.</p></dd>
4727: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4728: <dd><p>This file contains things that need to be done
4729: to make the package even
4730: better.</p></dd>
1.75 rillig 4731: </dl></div>
4732: </div>
1.78 rillig 4733: </div>
1.75 rillig 4734: <div class="sect1" lang="en">
4735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4736: <a name="work-dir"></a>10.6. <code class="filename">work*</code></h2></div></div></div>
1.75 rillig 4737: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87 wiz 4738: unpacked into the directory denoted by
4739: <code class="varname">WRKDIR</code>. It can be removed by running
4740: <span><strong class="command">make clean</strong></span>. Besides the sources, this
4741: directory is also used to keep various timestamp files.
4742: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4743: The default is <code class="filename">${.CURDIR}/work</code>
4744: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4745: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4746: </div>
4747: <div class="sect1" lang="en">
4748: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4749: <a name="files-dir"></a>10.7. <code class="filename">files/*</code></h2></div></div></div>
1.75 rillig 4750: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4751: to configuration or building, you could place these files here and use
4752: a <span><strong class="command">${CP}</strong></span> command in the
4753: “<span class="quote">pre-configure</span>” target to achieve
4754: this. Alternatively, you could simply diff the file against
4755: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4756: the creation of this file.</p>
4757: <p>If you want to share files in this way with other
4758: packages, set the <code class="varname">FILESDIR</code> variable to point
4759: to the other package's <code class="filename">files</code> directory,
4760: e.g.:</p>
4761: <pre class="programlisting">
4762: FILESDIR=${.CURDIR}/../xemacs/files
4763: </pre>
1.75 rillig 4764: </div>
4765: </div>
4766: <div class="chapter" lang="en">
4767: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4768: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4769: <div class="toc">
4770: <p><b>Table of Contents</b></p>
4771: <dl>
1.90 rillig 4772: <dt><span class="sect1"><a href="#makefile.variables">11.1. <code class="filename">Makefile</code> variables</a></span></dt>
4773: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.1.1. Naming conventions</a></span></dt></dl></dd>
4774: <dt><span class="sect1"><a href="#makefile.code">11.2. Code snippets</a></span></dt>
4775: <dd><dl>
4776: <dt><span class="sect2"><a href="#adding-to-list">11.2.1. Adding things to a list</a></span></dt>
4777: <dt><span class="sect2"><a href="#converting-internal-to-external">11.2.2. Converting an internal list into an external list</a></span></dt>
4778: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.2.3. Passing variables to a shell command</a></span></dt>
4779: <dt><span class="sect2"><a href="#quoting-guideline">11.2.4. Quoting guideline</a></span></dt>
4780: <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 4781: </dl></dd>
4782: </dl>
4783: </div>
1.76 rillig 4784: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4785: each of which forms a well-defined part of the pkgsrc system. Using
4786: 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
4787: like pkgsrc requires some discipline to keep the code correct and
4788: understandable.</p>
1.76 rillig 4789: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4790: programming are variables (which are actually macros) and shell
4791: commands. Among these shell commands may even be more complex ones
4792: 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
4793: as intended it is necessary to quote all variables correctly when they
4794: are used.</p>
4795: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4796: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4797: with them.</p>
4798: <div class="sect1" lang="en">
4799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4800: <a name="makefile.variables"></a>11.1. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4801: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4802: can be processed using the five operators ``='', ``+='', ``?='',
4803: ``:='', 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
4804: page.</p>
4805: <p>When a variable's value is parsed from a
1.76 rillig 4806: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4807: backslash character ``\'' are handled specially. If a backslash is
4808: followed by a newline, any whitespace immediately in front of the
4809: backslash, the backslash, the newline, and any whitespace
4810: immediately behind the newline are replaced with a single space. A
4811: backslash character and an immediately following hash character are
4812: replaced with a single hash character. Otherwise, the backslash is
4813: passed as is. In a variable assignment, any hash character that is
4814: not preceded by a backslash starts a comment that continues upto the
4815: end of the logical line.</p>
4816: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4817: the only way to create a variable consisting of a single backslash
4818: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4819: <p>So far for defining variables. The other thing you can do with
4820: variables is evaluating them. A variable is evaluated when it is
4821: part of the right side of the ``:='' or the ``!='' operator, or
4822: directly before executing a shell command which the variable is part
4823: 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
4824: is, variables are not evaluated until there's no other way. The
4825: ``modifiers'' mentioned in the man page also evaluate the
4826: variable.</p>
4827: <p>Some of the modifiers split the string into words and then
4828: operate on the words, others operate on the string as a whole. When
4829: a string is split into words, it is split as you would expect
4830: 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 4831: <p>No rule without exception—the <span><strong class="command">.for</strong></span>
1.75 rillig 4832: loop does not follow the shell quoting rules but splits at sequences
4833: of whitespace.</p>
4834: <p>There are several types of variables that should be handled
4835: differently. Strings and two types of lists.</p>
4836: <div class="itemizedlist"><ul type="disc">
4837: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4838: characters. Nevertheless, you should restrict yourself to only
4839: using printable characters. Examples are
4840: <code class="varname">PREFIX</code> and
4841: <code class="varname">COMMENT</code>.</p></li>
4842: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4843: are never exported to any shell command. Their elements are
4844: separated by whitespace. Therefore, the elements themselves cannot
4845: have embedded whitespace. Any other characters are allowed.
4846: Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
4847: Examples are <code class="varname">DEPENDS</code> and
4848: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4849: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4850: may be exported to a shell command. Their elements can contain any
4851: characters, including whitespace. That's why they cannot be used
4852: in <span><strong class="command">.for</strong></span> loops. Examples are
4853: <code class="varname">DISTFILES</code> and
4854: <code class="varname">MASTER_SITES</code>.</p></li>
4855: </ul></div>
4856: <div class="sect2" lang="en">
4857: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4858: <a name="makefile.variables.names"></a>11.1.1. Naming conventions</h3></div></div></div>
1.75 rillig 4859: <div class="itemizedlist"><ul type="disc">
4860: <li><p>All variable names starting with an underscore
4861: are reserved for use by the pkgsrc infrastructure. They shall
4862: not be used by package
1.76 rillig 4863: <code class="filename">Makefile</code>s.</p></li>
1.75 rillig 4864: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
4865: lowercase variable names for the iteration
4866: variables.</p></li>
4867: <li><p>All list variables should have a ``plural''
4868: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4869: <code class="varname">DISTFILES</code>.</p></li>
4870: </ul></div>
4871: </div>
4872: </div>
4873: <div class="sect1" lang="en">
4874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4875: <a name="makefile.code"></a>11.2. Code snippets</h2></div></div></div>
1.75 rillig 4876: <p>This section presents you with some code snippets you should
4877: use in your own code. If you don't find anything appropriate here,
4878: you should test your code and add it here.</p>
4879: <div class="sect2" lang="en">
4880: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4881: <a name="adding-to-list"></a>11.2.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4882: <pre class="programlisting">
4883: STRING= foo * bar `date`
4884: INT_LIST= # empty
4885: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4886: EXT_LIST= # empty
4887: ANOTHER_EXT_LIST= a=b c=d
1.1 grant 4888:
1.75 rillig 4889: INT_LIST+= ${STRING} # 1
4890: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4891: EXT_LIST+= ${STRING:Q} # 3
4892: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4893: </pre>
1.75 rillig 4894: <p>When you add a string to an external list (example 3), it
4895: must be quoted. In all other cases, you must not add a quoting
4896: level. You must not merge internal and external lists, unless you
4897: are sure that all entries are correctly interpreted in both
4898: lists.</p>
4899: </div>
4900: <div class="sect2" lang="en">
4901: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4902: <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 4903: <pre class="programlisting">
4904: EXT_LIST= # empty
4905: .for i in ${INT_LIST}
4906: EXT_LIST+= ${i:Q}""
4907: .endfor
1.1 grant 4908: </pre>
1.75 rillig 4909: <p>This code converts the internal list
4910: <code class="varname">INT_LIST</code> into the external list
4911: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4912: are unquoted they must be quoted here. The reason for appending
4913: <code class="varname">""</code> is explained below.</p>
4914: </div>
4915: <div class="sect2" lang="en">
4916: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4917: <a name="passing-variable-to-shell"></a>11.2.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4918: <p>Sometimes you may want to print an arbitrary string. There
4919: are many ways to get it wrong and only few that can handle every
4920: nastiness.</p>
1.75 rillig 4921: <pre class="programlisting">
4922: STRING= foo bar < > * `date` $$HOME ' "
4923: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4924:
1.75 rillig 4925: all:
4926: echo ${STRING} # 1
4927: echo "${STRING}" # 2
4928: echo "${STRING:Q}" # 3
4929: echo ${STRING:Q} # 4
4930: echo x${STRING:Q} | sed 1s,.,, # 5
1.79 rillig 4931: printf "%s\\n" ${STRING:Q}"" # 6
1.75 rillig 4932: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4933: </pre>
1.75 rillig 4934: <p>Example 1 leads to a syntax error in the shell, as the
4935: characters are just copied.</p>
4936: <p>Example 2 leads to a syntax error too, and if you leave out
4937: the last " character from <code class="varname">${STRING}</code>,
4938: <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
4939: variable would be evaluated, too.</p>
4940: <p>Example 3 outputs each space character preceded by a
4941: backslash (or not), depending on the implementation of the
4942: <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>
4943: <p>Example 4 handles correctly every string that does not start
4944: with a dash. In that case, the result depends on the
4945: 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
4946: guarantee that your input does not start with a dash, this form is
4947: appropriate.</p>
4948: <p>Example 5 handles even the case of a leading dash
4949: correctly.</p>
1.79 rillig 4950: <p>Example 6 also works with every string and is the
4951: light-weight solution, since it does not involve a pipe, which has
4952: its own problems.</p>
1.75 rillig 4953: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4954: because the quoting has already been done when adding elements to
4955: the list.</p>
4956: <p>As internal lists shall not be passed to the shell, there is
4957: no example for it.</p>
4958: </div>
4959: <div class="sect2" lang="en">
4960: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4961: <a name="quoting-guideline"></a>11.2.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4962: <p>There are many possible sources of wrongly quoted variables.
4963: This section lists some of the commonly known ones.</p>
4964: <div class="itemizedlist"><ul type="disc">
4965: <li>
4966: <p>Whenever you use the value of a list, think
4967: about what happens to leading or trailing whitespace. If the
4968: list is a well-formed shell expression, you can apply the
4969: <code class="varname">:M*</code> modifier to strip leading and trailing
4970: whitespace from each word. The <code class="varname">:M</code> operator
4971: first splits its argument according to the rules of the shell,
4972: and then creates a new list consisting of all words that match
4973: the shell glob expression <code class="varname">*</code>, that is: all.
4974: One class of situations where this is needed is when adding a
4975: variable like <code class="varname">CPPFLAGS</code> to
4976: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4977: invokes other configure scripts, it strips the leading and
4978: trailing whitespace from the variable and then passes it to the
4979: other configure scripts. But these configure scripts expect the
4980: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4981: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4982: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4983: here is how we do it:</p>
4984: <pre class="programlisting">
4985: CPPFLAGS= # empty
4986: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4987: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 4988:
1.75 rillig 4989: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 4990:
1.75 rillig 4991: all:
4992: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4993: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 4994: </pre>
1.75 rillig 4995: </li>
4996: <li><p>The example above contains one bug: The
4997: <code class="varname">${PREFIX}</code> is a properly quoted shell
4998: expression, but there is the C compiler after it, which also
4999: expects a properly quoted string (this time in C syntax). The
5000: version above is therefore only correct if
5001: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5002: or double quotes. If you want to allow these, you have to add
5003: another layer of quoting to each variable that is used as a C
5004: string literal. You cannot use the <code class="varname">:Q</code>
5005: operator for it, as this operator only works for the
5006: shell.</p></li>
5007: <li>
5008: <p>Whenever a variable can be empty, the
5009: <code class="varname">:Q</code> operator can have surprising results. Here
5010: are two completely different cases which can be solved with the
5011: same trick.</p>
5012: <pre class="programlisting">
5013: EMPTY= # empty
5014: empty_test:
5015: for i in a ${EMPTY:Q} c; do \
5016: echo "$$i"; \
5017: done
1.1 grant 5018:
1.75 rillig 5019: for_test:
5020: .for i in a:\ a:\test.txt
5021: echo ${i:Q}
5022: echo "foo"
5023: .endfor
1.1 grant 5024: </pre>
1.75 rillig 5025: <p>The first example will only print two of the three lines
5026: we might have expected. This is because
5027: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5028: the shell cannot see. The workaround is to write
5029: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5030: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5031: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5032: <p>The second example will only print three lines instead of
5033: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5034: This is because the backslash of the value
5035: <code class="varname">a:\</code> is interpreted as a line-continuation by
5036: <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
5037: <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
5038: <code class="varname">${i:Q}""</code>.</p>
5039: </li>
5040: </ul></div>
5041: </div>
5042: <div class="sect2" lang="en">
5043: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5044: <a name="bsd-make-bug-workaround"></a>11.2.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5045: <p>The pkgsrc bmake program does not handle the following
5046: assignment correctly. In case <code class="varname">_othervar_</code>
5047: contains a ``-'' character, one of the closing braces is included
5048: in <code class="varname">${VAR}</code> after this code executes.</p>
5049: <pre class="programlisting">
5050: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5051: </pre>
1.75 rillig 5052: <p>For a more complex code snippet and a workaround, see the
1.91 ! rillig 5053: 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 5054: <code class="varname">bug1</code>.</p>
5055: </div>
5056: </div>
5057: </div>
5058: <div class="chapter" lang="en">
5059: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5060: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75 rillig 5061: <div class="toc">
5062: <p><b>Table of Contents</b></p>
5063: <dl>
1.90 rillig 5064: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
5065: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5066: <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>
5067: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
5068: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
5069: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5070: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
5071: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5072: </dl>
5073: </div>
1.87 wiz 5074: <p>The <code class="filename">PLIST</code> file contains a package's
5075: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5076: the package (relative to the <code class="filename">${PREFIX}</code>
5077: directory it's been installed in) plus some additional statements
5078: - 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.
5079: This chapter addresses some issues that need attention when
5080: dealing with the <code class="filename">PLIST</code> file (or files, see
5081: below!).</p>
1.75 rillig 5082: <div class="sect1" lang="en">
5083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5084: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87 wiz 5085: <p>Be sure to add a RCS ID line as the first thing in any
5086: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5087: <pre class="programlisting">
1.87 wiz 5088: @comment $NetBSD$
5089: </pre>
1.75 rillig 5090: </div>
5091: <div class="sect1" lang="en">
5092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5093: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75 rillig 5094: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87 wiz 5095: to output a PLIST that matches any new files since the package
1.90 rillig 5096: 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 5097: more information on this target.</p>
1.75 rillig 5098: </div>
5099: <div class="sect1" lang="en">
5100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5101: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></h2></div></div></div>
1.87 wiz 5102: <p>If you have used any of the *-dirs packages, as explained in
1.90 rillig 5103: <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 5104: <span><strong class="command">make print-PLIST</strong></span> outputs a set of
5105: <code class="varname">@comment</code>s instead of real
5106: <code class="varname">@dirrm</code> lines. You can also do this for
5107: specific directories and files, so that the results of that
5108: command are very close to reality. This helps <span class="emphasis"><em>a
5109: lot</em></span> during the update of packages.</p>
5110: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5111: of AWK patterns and actions that are used to filter the output of
5112: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5113: scripting you like to it, but be careful with quoting.</p>
5114: <p>For example, to get all files inside the
5115: <code class="filename">libdata/foo</code> directory removed from the
5116: resulting PLIST:</p>
5117: <pre class="programlisting">
5118: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
5119: </pre>
5120: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5121: to a specific (shared) directory converted to
5122: <code class="varname">@comment</code>s:</p>
1.75 rillig 5123: <pre class="programlisting">
1.87 wiz 5124: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5125: </pre>
1.75 rillig 5126: </div>
5127: <div class="sect1" lang="en">
5128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5129: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5130: <p>A number of variables are substituted automatically in
5131: PLISTs when a package is installed on a system. This includes the
5132: following variables:</p>
1.75 rillig 5133: <div class="variablelist"><dl>
5134: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5135: <dd>
5136: <p>Some packages like emacs and perl embed information
1.87 wiz 5137: about which architecture they were built on into the
5138: pathnames where they install their files. To handle this
5139: case, PLIST will be preprocessed before actually used, and
5140: the symbol
5141: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
5142: replaced by what <span><strong class="command">uname -p</strong></span> gives. The
5143: same is done if the string
5144: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5145: PLIST somewhere - use this on packages that have GNU
5146: autoconf-created configure scripts.</p>
1.75 rillig 5147: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5148: <h3 class="title">Legacy note</h3>
5149: <p>There used to be a symbol
1.87 wiz 5150: “<span class="quote"><code class="varname">$ARCH</code></span>” that
5151: was replaced by the output of <span><strong class="command">uname
5152: -m</strong></span>, but that's no longer supported and has
5153: been removed.</p>
1.75 rillig 5154: </div>
5155: </dd>
5156: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5157: <dd>
5158: <p>Some packages want to embed the OS name and version
1.87 wiz 5159: into some paths. To do this, use these variables in the
5160: <code class="filename">PLIST</code>:
5161: </p>
1.75 rillig 5162: <div class="itemizedlist"><ul type="disc">
5163: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span><strong class="command">uname -s</strong></span></span>”</p></li>
5164: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
5165: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span><strong class="command">uname -r</strong></span></span>”</p></li>
5166: </ul></div>
5167: </dd>
5168: </dl></div>
1.87 wiz 5169: <p>For a complete list of values which are replaced by
5170: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5171: search for <code class="varname">PLIST_SUBST</code>).</p>
5172: <p>If you want to change other variables not listed above, you
5173: can add variables and their expansions to this variable in the
1.90 rillig 5174: 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 5175: <pre class="programlisting">
1.87 wiz 5176: PLIST_SUBST+= SOMEVAR="somevalue"
5177: </pre>
1.75 rillig 5178: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5179: in the <code class="filename">PLIST</code> with
5180: “<span class="quote">somevalue</span>”.</p>
1.75 rillig 5181: </div>
5182: <div class="sect1" lang="en">
5183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5184: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75 rillig 5185: <p>Man pages should be installed in compressed form if
1.87 wiz 5186: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5187: and uncompressed otherwise. To handle this in the
5188: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5189: appended/removed automatically for man pages according to
5190: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5191: or not, see above for details. This modification of the
5192: <code class="filename">PLIST</code> file is done on a copy of it, not
5193: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5194: </div>
5195: <div class="sect1" lang="en">
5196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5197: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></h2></div></div></div>
1.76 rillig 5198: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5199: in generating the binary package, set the variable
5200: <code class="varname">PLIST_SRC</code> to the names of that file(s).
5201: 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
5202: important. The default for <code class="varname">PLIST_SRC</code> is
5203: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5204: </div>
5205: <div class="sect1" lang="en">
5206: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5207: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5208: <p>Some packages decide to install a different set of files based on
1.87 wiz 5209: the operating system being used. These differences can be
5210: automatically handled by using the following files:</p>
1.75 rillig 5211: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5212: <li><p><code class="filename">PLIST.common</code></p></li>
5213: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5214: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5215: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5216: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5217: </ul></div>
5218: </div>
5219: <div class="sect1" lang="en">
5220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5221: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5222: <p>A “<span class="quote">shared directory</span>” is a directory where
5223: multiple (and unrelated) packages install files. These
5224: directories are problematic because you have to add special tricks
5225: in the PLIST to conditionally remove them, or have some
5226: centralized package handle them.</p>
5227: <p>Within pkgsrc, you'll find both approaches. If a directory
5228: is shared by a few unrelated packages, it's often not worth to add
5229: an extra package to remove it. Therefore, one simply does:</p>
5230: <pre class="programlisting">
5231: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
5232: </pre>
5233: <p>in the PLISTs of all affected packages, instead of the
5234: regular "@dirrm" line.</p>
5235: <p>However, if the directory is shared across many packages, two
5236: different solutions are available:</p>
1.75 rillig 5237: <div class="orderedlist"><ol type="1">
1.87 wiz 5238: <li><p>If the packages have a common dependency, the directory
5239: can be removed in that. For example, see
1.91 ! rillig 5240: <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 5241: removes the shared directory
5242: <code class="filename">share/omf</code>.</p></li>
5243: <li><p>If the packages using the directory are not related at
5244: all (they have no common dependencies), a *-dirs package is
5245: used.</p></li>
1.75 rillig 5246: </ol></div>
1.87 wiz 5247: <p>From now on, we'll discuss the second solution. To get an
5248: idea of the *-dirs packages available, issue:</p>
1.75 rillig 5249: <pre class="programlisting">
1.87 wiz 5250: <code class="prompt">%</code> cd .../pkgsrc
5251: <code class="prompt">%</code> ls -d */*-dirs
5252: </pre>
5253: <p>Their use from other packages is very simple. The
5254: <code class="varname">USE_DIRS</code> variable takes a list of package names
5255: (without the “<span class="quote">-dirs</span>” part) together with the required
5256: version number (always pick the latest one when writing new
5257: packages).</p>
5258: <p>For example, if a package installs files under
5259: <code class="filename">share/applications</code>, it should have the
5260: following line in it:</p>
5261: <pre class="programlisting">
5262: USE_DIRS+= xdg-1.1
5263: </pre>
5264: <p>After regenerating the PLIST using <span><strong class="command">make
5265: print-PLIST</strong></span>, you should get the right (commented out)
5266: lines.</p>
5267: <p>Note that even if your package is using
5268: <code class="filename">$X11BASE</code>, it must not depend on the
5269: *-x11-dirs packages. Just specify the name without that part and
5270: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5271: care of it.</p>
1.75 rillig 5272: </div>
5273: </div>
5274: <div class="chapter" lang="en">
5275: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5276: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75 rillig 5277: <div class="toc">
5278: <p><b>Table of Contents</b></p>
5279: <dl>
1.90 rillig 5280: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
5281: <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 5282: <dd><dl>
1.90 rillig 5283: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5284: <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 5285: </dl></dd>
1.90 rillig 5286: <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 5287: <dd><dl>
1.90 rillig 5288: <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>
5289: <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 5290: </dl></dd>
5291: </dl>
5292: </div>
5293: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5294: are seen by a package's configure and build processes. This is implemented
5295: in a two step process:</p>
1.75 rillig 5296: <div class="orderedlist"><ol type="1">
5297: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5298: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5299: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5300: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5301: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5302: <code class="option">-L${LOCALBASE}/lib</code> into references to
5303: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5304: native compiler on some operating systems look like GCC, so that
5305: packages that expect GCC won't require modifications to build with
5306: those native compilers.</p></li>
1.75 rillig 5307: </ol></div>
5308: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5309: package may be built consistently despite what other software may be
5310: installed. Please note that the normal system header and library paths,
5311: e.g. <code class="filename">/usr/include</code>,
5312: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5313: designed to insulate the package build from non-system-supplied
5314: software.</p>
1.75 rillig 5315: <div class="sect1" lang="en">
5316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5317: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5318: <p>The process of converting packages to use the buildlink3
1.87 wiz 5319: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5320: The things to keep in mind are:</p>
1.75 rillig 5321: <div class="orderedlist"><ol type="1">
1.87 wiz 5322: <li><p>Ensure that the build always calls the wrapper scripts
5323: instead of the actual toolchain. Some packages are tricky,
5324: and the only way to know for sure is the check
5325: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5326: wrappers are being invoked.</p></li>
5327: <li><p>Don't override <code class="varname">PREFIX</code> from within
5328: the package Makefile, e.g. Java VMs, standalone shells,
5329: etc., because the code to symlink files into
5330: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5331: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5332: </p></li>
5333: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5334: <code class="filename">buildlink3.mk</code> files that you list in a
5335: package's Makefile are added as dependencies for that package.
5336: </p></li>
1.75 rillig 5337: </ol></div>
1.87 wiz 5338: <p>If a dependency on a particular package is required for its libraries and
5339: headers, then we replace:</p>
1.75 rillig 5340: <pre class="programlisting">
1.87 wiz 5341: DEPENDS+= foo>=1.1.0:../../category/foo
5342: </pre>
1.75 rillig 5343: <p>with</p>
5344: <pre class="programlisting">
1.87 wiz 5345: .include "../../category/foo/buildlink3.mk"
5346: </pre>
1.75 rillig 5347: <p>The buildlink3.mk files usually define the required dependencies.
5348: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5349: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5350: <pre class="programlisting">
1.87 wiz 5351: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5352: .include "../../category/foo/buildlink3.mk"
5353: </pre>
1.76 rillig 5354: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5355: files in <code class="filename">pkgsrc/mk</code>
5356: that handle special package issues:</p>
1.75 rillig 5357: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5358: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5359: the native or a pkgsrc Berkeley DB implementation based on
5360: the values of <code class="varname">BDB_ACCEPTED</code> and
5361: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5362: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5363: comes with neither Curses nor NCurses, this will take care
1.91 ! rillig 5364: 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 5365: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5366: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5367: adding a dependency on Heimdal or MIT-krb5 for packages that
5368: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5369: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5370: system-provided Motif installation or adds a dependency on
1.91 ! rillig 5371: <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 5372: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5373: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5374: which Motif version will be used.</p></li>
1.76 rillig 5375: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5376: variables that may be used by packages that use the
5377: Open Sound System (OSS) API.</p></li>
1.76 rillig 5378: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.91 ! rillig 5379: either Postgres 7.4, 8.0, or 8.1, whichever is found installed. See
1.87 wiz 5380: the file for more information.</p></li>
1.76 rillig 5381: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5382: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 ! rillig 5383: 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 5384: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5385: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5386: library.</p></li>
1.75 rillig 5387: </ul></div>
1.76 rillig 5388: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5389: files provide a more complete
5390: description of how to use them properly.</p>
1.75 rillig 5391: </div>
5392: <div class="sect1" lang="en">
5393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5394: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87 wiz 5395: <p>A package's <code class="filename">buildlink3.mk</code> file is
5396: included by Makefiles to indicate the need to compile and link
5397: against header files and libraries provided by the package. A
5398: <code class="filename">buildlink3.mk</code> file should always provide
5399: enough information to add the correct type of dependency
5400: relationship and include any other
5401: <code class="filename">buildlink3.mk</code> files that it needs to find
5402: headers and libraries that it needs in turn.</p>
5403: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 ! rillig 5404: 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 5405: package is highly recommended. For most packages, the following
5406: command will generate a good starting point for
5407: <code class="filename">buildlink3.mk</code> files:</p>
5408: <pre class="screen">
5409: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5410: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5411: </pre>
1.75 rillig 5412: <div class="sect2" lang="en">
5413: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5414: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5415: <p>The following real-life example
1.87 wiz 5416: <code class="filename">buildlink3.mk</code> is taken
5417: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5418: <pre class="programlisting">
1.87 wiz 5419: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1 grant 5420:
1.87 wiz 5421: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5422: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
1.1 grant 5423:
1.87 wiz 5424: .if !empty(BUILDLINK_DEPTH:M+)
5425: BUILDLINK_DEPENDS+= tiff
5426: .endif
5427:
5428: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5429: BUILDLINK_PACKAGES+= tiff
5430:
5431: .if !empty(TIFF_BUILDLINK3_MK:M+)
5432: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5433: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5434: .endif # TIFF_BUILDLINK3_MK
5435:
5436: .include "../../devel/zlib/buildlink3.mk"
5437: .include "../../graphics/jpeg/buildlink3.mk"
5438:
5439: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5440: </pre>
5441: <p>The header and footer manipulate
5442: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5443: <code class="filename">buildlink3.mk</code> files and is used to track
5444: at what depth we are including
5445: <code class="filename">buildlink3.mk</code> files.</p>
5446: <p>The first section controls if the dependency on
5447: <em class="replaceable"><code>pkg</code></em> is added.
5448: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5449: packages for which dependencies are added by
5450: buildlink3.</p>
5451: <p>The second section advises pkgsrc that the
5452: <code class="filename">buildlink3.mk</code> file for
5453: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5454: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5455: packages for which <code class="filename">buildlink3.mk</code> files
5456: have been included. It must <span class="emphasis"><em>always</em></span> be
5457: appended to within a <code class="filename">buildlink3.mk</code>
5458: file.</p>
5459: <p>The third section is protected from multiple inclusion
5460: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5461: added. Several important variables are set in the section:</p>
5462: <div class="itemizedlist"><ul type="disc">
5463: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5464: is the actual dependency recorded in the installed
5465: package; this should always be set using
5466: <span><strong class="command">+=</strong></span> to ensure that
5467: we're appending to any pre-existing list of values. This
5468: variable should be set to the first version of the
5469: package that had an API change.
5470: </p></li>
5471: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5472: is the location of the <em class="replaceable"><code>pkg</code></em>
5473: pkgsrc directory.</p></li>
5474: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5475: (not shown above) controls whether we use
5476: <code class="varname">BUILD_DEPENDS</code> or
5477: <code class="varname">DEPENDS</code> to add the dependency on
5478: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5479: selected by setting
5480: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5481: to “<span class="quote">build</span>”. By default, the full dependency is
5482: used.</p></li>
5483: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5484: and
5485: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5486: (not shown above) are lists of subdirectories of
1.76 rillig 5487: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5488: to add to the header and library search paths. These
5489: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5490: respectively.</p></li>
5491: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5492: (not shown above) is the list of preprocessor flags to add
5493: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5494: configure and build phases. The “<span class="quote">-I</span>” option
5495: should be avoided and instead be handled using
5496: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5497: above.</p></li>
1.75 rillig 5498: </ul></div>
1.87 wiz 5499: <p>The following variables are all optionally defined within
5500: this second section (protected against multiple inclusion) and
5501: control which package files are symlinked into
5502: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5503: transformed during the symlinking:</p>
1.75 rillig 5504: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5505: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5506: (not shown above) is a shell glob pattern relative to
1.76 rillig 5507: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5508: to be symlinked into
1.76 rillig 5509: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5510: e.g. <code class="filename">include/*.h</code>.</p></li>
5511: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5512: (not shown above) is a shell pipeline that
5513: outputs to stdout a list of files relative to
5514: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5515: The resulting files are to be symlinked
5516: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5517: this takes the <code class="filename">+CONTENTS</code> of a
5518: <em class="replaceable"><code>pkg</code></em> and filters it through
5519: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5520: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5521: (not shown above) is a filter command that filters
1.76 rillig 5522: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5523: relative to
1.76 rillig 5524: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5525: on stdout. By default for overwrite packages,
5526: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5527: outputs the contents of the <code class="filename">include</code>
5528: and <code class="filename">lib</code> directories in the package
5529: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5530: it outputs any libtool archives in
1.87 wiz 5531: <code class="filename">lib</code> directories.</p></li>
5532: <li><p><code class="varname">BUILDLINK_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5533: (not shown above) is a list of sed arguments used to
5534: transform the name of the source filename into a
5535: destination filename, e.g. <span><strong class="command">-e
1.87 wiz 5536: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5537: </ul></div>
1.87 wiz 5538: <p>The last section includes any
5539: <code class="filename">buildlink3.mk</code> needed for
5540: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5541: Including these <code class="filename">buildlink3.mk</code> files
5542: means that the headers and libraries for these
5543: dependencies are also symlinked into
5544: <code class="filename">${BUILDLINK_DIR}</code>
5545: whenever the <em class="replaceable"><code>pkg</code></em>
5546: <code class="filename">buildlink3.mk</code>
5547: file is included.</p>
1.75 rillig 5548: </div>
5549: <div class="sect2" lang="en">
5550: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5551: <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 5552: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5553: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5554: after a package update is when the API or interface to the
1.87 wiz 5555: header files change.</p>
5556: <p>In this case,
5557: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5558: should be adjusted to require at least the new package
5559: version. In some cases, the packages that depend on this new
5560: version may need their <code class="varname">PKGREVISION</code>s
5561: increased and, if they have <code class="filename">buildlink3.mk</code>
5562: files, their
5563: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5564: adjusted, too. This is needed so pkgsrc will require the
5565: correct package dependency and not settle for an older one
5566: when building the source.</p>
5567: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5568: should be increased when the binary interface or sonames
5569: (major number of the library version) of any installed
5570: shared libraries change. This is needed so that binary
5571: packages made using it will require the correct package
5572: dependency and not settle for an older one which will not
1.87 wiz 5573: contain the necessary shared libraries.</p>
1.90 rillig 5574: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, “Handling dependencies”</a> for
1.75 rillig 5575: more information about dependencies on other packages,
5576: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5577: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5578: <p>Please take careful consideration before adjusting
5579: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5580: or
5581: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5582: as we don't want to cause unneeded package deletions and
5583: rebuilds. In many cases, new versions of packages work just
5584: fine with older dependencies.</p>
5585: <p>Also it is not needed to set
1.75 rillig 5586: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5587: when it is identical to
1.87 wiz 5588: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5589: </div>
5590: </div>
5591: <div class="sect1" lang="en">
5592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5593: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5594: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5595: coincide with headers and libraries present in the base system.
1.76 rillig 5596: Aside from a <code class="filename">buildlink3.mk</code> file, these
5597: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5598: file that includes the necessary checks to decide whether using
5599: the built-in software or the pkgsrc software is
1.87 wiz 5600: appropriate.</p>
5601: <p>The only requirements of a builtin.mk file for
5602: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5603: <div class="orderedlist"><ol type="1">
1.87 wiz 5604: <li><p>It should set
5605: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5606: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5607: after it is included.</p></li>
5608: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5609: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5610: which is already set before the
5611: <code class="filename">builtin.mk</code> file is included.</p></li>
5612: <li><p>It should be written to allow multiple inclusion. This
5613: is <span class="emphasis"><em>very</em></span> important and takes careful
5614: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5615: </ol></div>
5616: <div class="sect2" lang="en">
5617: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5618: <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 5619: <p>The following is the recommended template for builtin.mk
1.87 wiz 5620: files:</p>
1.75 rillig 5621: <pre class="programlisting">
1.87 wiz 5622: .if !defined(IS_BUILTIN.foo)
5623: #
5624: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5625: # genuinely exists in the system or not.
5626: #
5627: IS_BUILTIN.foo?= no
5628:
5629: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5630: # version can be determined.
5631: #
5632: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5633: BUILTIN_PKG.foo?= foo-1.0
5634: . endif
5635: .endif # IS_BUILTIN.foo
5636:
5637: .if !defined(USE_BUILTIN.foo)
5638: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5639: . if defined(BUILTIN_PKG.foo)
5640: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5641: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5642: USE_BUILTIN.foo!= \
5643: if ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}; then \
5644: ${ECHO} "yes"; \
5645: else \
5646: ${ECHO} "no"; \
5647: fi
5648: . endif
5649: . endfor
5650: . endif
5651: .endif # USE_BUILTIN.foo
5652:
5653: CHECK_BUILTIN.foo?= no
5654: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5655: #
5656: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5657: # "yes" or "no".
5658: #
5659: .endif # CHECK_BUILTIN.foo
5660: </pre>
5661: <p>The first section sets
5662: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5663: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5664: in the base system. This should not be a base system software
5665: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5666: it should only be “<span class="quote">yes</span>” if the actual package is
5667: included as part of the base system. This variable is only
5668: used internally within the <code class="filename">builtin.mk</code>
5669: file.</p>
5670: <p>The second section sets
5671: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5672: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5673: system if it exists (if
5674: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5675: is “<span class="quote">yes</span>”). This variable is only used internally
5676: within the <code class="filename">builtin.mk</code> file.</p>
5677: <p>The third section sets
5678: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5679: and is <span class="emphasis"><em>required</em></span> in all
5680: <code class="filename">builtin.mk</code> files. The code in this
5681: section must make the determination whether the built-in
5682: software is adequate to satisfy the dependencies listed in
5683: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5684: This is typically done by comparing
5685: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5686: against each of the dependencies in
5687: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5688: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5689: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5690: end of the <code class="filename">builtin.mk</code> file. Note that
5691: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5692: may be “<span class="quote">yes</span>” even if
5693: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5694: is “<span class="quote">no</span>” because we may make the determination
5695: that the built-in version of the software is similar enough to
5696: be used as a replacement.</p>
5697: <p>The last section is guarded by
5698: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5699: and includes code that uses the value of
5700: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5701: set in the previous section. This typically includes, e.g.,
5702: adding additional dependency restrictions and listing additional
5703: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5704: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5705: </div>
5706: <div class="sect2" lang="en">
5707: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5708: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5709: <p>When building packages, it's possible to choose whether to set
5710: a global preference for using either the built-in (native)
5711: version or the pkgsrc version of software to satisfy a
5712: dependency. This is controlled by setting
5713: <code class="varname">PREFER_PKGSRC</code> and
5714: <code class="varname">PREFER_NATIVE</code>. These variables take values
5715: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5716: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5717: use the pkgsrc versions of software, while
5718: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5719: built-in versions. Preferences are determined by the most
5720: specific instance of the package in either
5721: <code class="varname">PREFER_PKGSRC</code> or
5722: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5723: in neither or in both variables, then
5724: <code class="varname">PREFER_PKGSRC</code> has precedence over
5725: <code class="varname">PREFER_NATIVE</code>. For example, to require
5726: using pkgsrc versions of software for all but the most basic
5727: bits on a NetBSD system, you can set:</p>
5728: <pre class="programlisting">
5729: PREFER_PKGSRC= yes
5730: PREFER_NATIVE= getopt skey tcp_wrappers
5731: </pre>
5732: <p>A package <span class="emphasis"><em>must</em></span> have a
5733: <code class="filename">builtin.mk</code>
5734: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5735: otherwise it is simply ignored in that list.</p>
1.75 rillig 5736: </div>
5737: </div>
5738: </div>
5739: <div class="chapter" lang="en">
5740: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5741: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75 rillig 5742: <div class="toc">
5743: <p><b>Table of Contents</b></p>
5744: <dl>
1.90 rillig 5745: <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 5746: <dd><dl>
1.90 rillig 5747: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
5748: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75 rillig 5749: </dl></dd>
1.90 rillig 5750: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75 rillig 5751: <dd><dl>
1.90 rillig 5752: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5753: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
5754: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
5755: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
5756: </dl></dd>
5757: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
5758: <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>
5759: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
5760: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
5761: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
5762: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
5763: <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 5764: </dl>
5765: </div>
5766: <p>This chapter describes the framework known as
5767: <code class="literal">pkginstall</code>, whose key features are:</p>
5768: <div class="itemizedlist"><ul type="disc">
5769: <li><p>Generic installation and manipulation of directories and files
5770: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5771: <li><p>Automatic handling of configuration files during installation,
5772: provided that packages are correctly designed.</p></li>
5773: <li><p>Generation and installation of system startup scripts.</p></li>
5774: <li><p>Registration of system users and groups.</p></li>
5775: <li><p>Registration of system shells.</p></li>
5776: <li><p>Automatic updating of fonts databases.</p></li>
5777: </ul></div>
5778: <p>The following sections inspect each of the above points in detail.</p>
5779: <p>You may be thinking that many of the things described here could be
5780: easily done with simple code in the package's post-installation target
5781: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5782: as the code in them is only executed when building from source. Machines
5783: using binary packages could not benefit from it at all (as the code itself
5784: could be unavailable). Therefore, the only way to achieve any of the items
5785: described above is by means of the installation scripts, which are
5786: automatically generated by pkginstall.</p>
5787: <div class="sect1" lang="en">
5788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5789: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5790: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5791: of files and directories that belong to a package. The names used in it
1.76 rillig 5792: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5793: which means that it cannot register files outside this directory (absolute
5794: path names are not allowed). Despite this restriction, some packages need
5795: to install files outside this location; e.g., under
1.76 rillig 5796: <code class="filename">${VARBASE}</code> or
1.87 wiz 5797: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5798: is to create such files during installation time by using
5799: installation scripts.</p>
5800: <p>The generic installation scripts are shell scripts that can
5801: contain arbitrary code. The list of scripts to execute is taken from
5802: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5803: <code class="filename">INSTALL</code>. A similar variable exists for package
5804: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5805: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5806: commands, so they have the potential to create and manage files
5807: anywhere in the file system.</p>
5808: <p>Using these general installation files is not recommended, but
5809: may be needed in some special cases. One reason for avoiding them is
5810: that the user has to trust the packager that there is no unwanted or
5811: simply erroneous code included in the installation script. Also,
5812: previously there were many similar scripts for the same functionality,
5813: and fixing a common error involved finding and changing all of
5814: them.</p>
5815: <p>The pkginstall framework offers another, standardized way. It
5816: provides generic scripts to abstract the manipulation of such files
5817: and directories based on variables set in the package's
5818: <code class="filename">Makefile</code>. The rest of this section describes
5819: these variables.</p>
1.75 rillig 5820: <div class="sect2" lang="en">
5821: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5822: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5823: <p>The following variables can be set to request the creation of
5824: directories anywhere in the file system:</p>
5825: <div class="itemizedlist"><ul type="disc">
5826: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5827: contain a list of directories that should be created and should attempt
5828: to be destroyed by the installation scripts. The difference between
5829: the two is that the latter prompts the administrator to remove any
5830: directories that may be left after deinstallation (because they were
5831: not empty), while the former does not.</p></li>
5832: <li>
5833: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5834: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5835: which directories should be created and should attempt to be destroyed
5836: by the installation scripts. Each tuple holds the following values,
5837: separated by spaces: the directory name, its owner, its group and its
5838: numerical mode. For example:</p>
5839: <pre class="programlisting">
5840: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5841: </pre>
1.75 rillig 5842: <p>The difference between the two is exactly the same as their
5843: non-<code class="varname">PERMS</code> counterparts.</p>
5844: </li>
5845: </ul></div>
5846: </div>
5847: <div class="sect2" lang="en">
5848: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5849: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5850: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5851: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5852: To overcome this problem, the only solution is to extract the file in the
5853: known place (i.e., inside the installation prefix) and copy it to the
5854: appropriate location during installation (done by the installation scripts
5855: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5856: file</em></span> in the following paragraphs, which describe the variables
5857: that can be used to automatically and consistently handle files outside the
5858: installation prefix:</p>
5859: <div class="itemizedlist"><ul type="disc">
5860: <li>
5861: <p><code class="varname">CONF_FILES</code> and
5862: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5863: During installation time, the master file is copied to the target one
5864: if and only if the latter does not exist. Upon deinstallation, the
5865: target file is removed provided that it was not modified by the
5866: installation.</p>
5867: <p>The difference between the two is that the latter prompts the
5868: administrator to remove any files that may be left after
5869: deinstallation (because they were not empty), while the former does
5870: not.</p>
5871: </li>
5872: <li>
5873: <p><code class="varname">CONF_FILES_PERMS</code> and
5874: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5875: files as well as their target locations. For each of them, it also
5876: specifies their owner, their group and their numeric permissions, in
5877: this order. For example:</p>
5878: <pre class="programlisting">
5879: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5880: </pre>
1.75 rillig 5881: <p>The difference between the two is exactly the same as their
5882: non-<code class="varname">PERMS</code> counterparts.</p>
5883: </li>
5884: </ul></div>
5885: </div>
5886: </div>
5887: <div class="sect1" lang="en">
5888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5889: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75 rillig 5890: <p>Configuration files are special in the sense that they are installed
5891: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5892: need special treatment during installation (most of which is automated by
5893: pkginstall). The main concept you must bear in mind is that files marked
5894: as configuration files are automatically copied to the right place (somewhere
5895: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5896: and only if</em></span> they didn't exist before. Similarly, they will not
5897: be removed if they have local modifications. This ensures that
5898: administrators never lose any custom changes they may have made.</p>
5899: <div class="sect2" lang="en">
5900: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5901: <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 5902: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5903: specifies where configuration files shall be installed. Its contents are
5904: set based upon the following variables:</p>
5905: <div class="itemizedlist"><ul type="disc">
5906: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5907: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5908: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5909: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5910: Packages must not use it directly.</p></li>
5911: <li>
5912: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5913: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5914: for the package being built shall be installed. The definition of this
5915: variable only makes sense in the package's
1.76 rillig 5916: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5917: <p>As an example, consider the Apache package,
1.91 ! rillig 5918: <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 5919: configuration files under the
1.76 rillig 5920: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5921: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5922: Makefile.</p>
5923: </li>
5924: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5925: variable that holds this package's configuration directory (if
5926: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5927: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5928: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5929: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5930: directory where the configuration files for the package identified by
5931: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5932: </ul></div>
5933: <p>Based on the above variables, pkginstall determines the value of
5934: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5935: variable that can be used within a package to refer to its configuration
5936: directory. The algorithm used to set its value is basically the
5937: following:</p>
5938: <div class="orderedlist"><ol type="1">
5939: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
5940: its value is used.</p></li>
5941: <li><p>If the previous variable is not defined but
5942: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5943: <code class="filename">Makefile</code>, the resulting value is
5944: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 5945: <li><p>Otherwise, it is set to
1.76 rillig 5946: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5947: </ol></div>
1.76 rillig 5948: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90 rillig 5949: 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 5950: </div>
5951: <div class="sect2" lang="en">
5952: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5953: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5954: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5955: known place, you need to teach each package where it shall install its
5956: files. In some cases you will have to patch the package Makefiles to
5957: achieve it. If you are lucky, though, it may be as easy as passing an
5958: extra flag to the configuration script; this is the case of GNU Autoconf-
5959: generated files:</p>
5960: <pre class="programlisting">
5961: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5962: </pre>
1.75 rillig 5963: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5964: for</em></span> its configuration files, not where they will be originally
5965: installed (although the difference is never explicit,
5966: unfortunately).</p>
5967: </div>
5968: <div class="sect2" lang="en">
5969: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5970: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5971: <p>As said before, pkginstall automatically handles configuration files.
5972: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5973: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5974: directly</strong></span>. Bad news is that many software installation scripts
5975: will, out of the box, mess with the contents of that directory. So what is
5976: the correct procedure to fix this issue?</p>
5977: <p>You must teach the package (usually by manually patching it) to
5978: install any configuration files under the examples hierarchy,
1.76 rillig 5979: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5980: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5981: has the original copies available.</p>
5982: <p>Once the required configuration files are in place (i.e., under the
5983: examples hierarchy), the pkginstall framework can use them as master copies
5984: during the package installation to update what is in
1.76 rillig 5985: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5986: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90 rillig 5987: 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 5988: about their syntax and their purpose. Here is an example, taken from the
1.91 ! rillig 5989: <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 5990: <pre class="programlisting">
5991: EGDIR= ${PREFIX}/share/doc/mutt/samples
5992: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5993: </pre>
1.75 rillig 5994: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5995: package and has no meaning outside it.</p>
5996: </div>
5997: <div class="sect2" lang="en">
5998: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5999: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6000: <p>The automatic copying of config files can be toggled by setting the
6001: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6002: installation.</p>
6003: </div>
6004: </div>
6005: <div class="sect1" lang="en">
6006: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6007: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75 rillig 6008: <p>System startup scripts are special files because they must be
6009: installed in a place known by the underlying OS, usually outside the
1.90 rillig 6010: 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 6011: can be used. However, pkginstall provides a special mechanism to handle
6012: these files.</p>
6013: <p>In order to provide system startup scripts, the package has
6014: to:</p>
6015: <div class="orderedlist"><ol type="1">
1.76 rillig 6016: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6017: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 ! rillig 6018: <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 6019: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6020: <li>
6021: <p>Tell pkginstall to handle it, appending the name of the script,
6022: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6023: Continuing the previous example:</p>
6024: <pre class="programlisting">
6025: RCD_SCRIPTS+= cupsd
1.1 grant 6026: </pre>
1.75 rillig 6027: </li>
6028: </ol></div>
6029: <p>Once this is done, pkginstall will do the following steps for each
6030: script in an automated fashion:</p>
6031: <div class="orderedlist"><ol type="1">
6032: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6033: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6034: variable.</p></li>
6035: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6036: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6037: that this master file must be explicitly registered in the
1.76 rillig 6038: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6039: <li><p>Add code to the installation scripts to copy the startup script
6040: from the examples hierarchy into the system-wide startup scripts
6041: directory.</p></li>
6042: </ol></div>
6043: <div class="sect2" lang="en">
6044: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6045: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6046: <p>The automatic copying of config files can be toggled by setting the
6047: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6048: installation. Note that the scripts will be always copied inside the
1.76 rillig 6049: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6050: matter what the value of this variable is.</p>
6051: </div>
6052: </div>
6053: <div class="sect1" lang="en">
6054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6055: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75 rillig 6056: <p>If a package needs to create special users and/or groups during
6057: installation, it can do so by using the pkginstall framework.</p>
6058: <p>Users can be created by adding entries to the
6059: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6060: syntax:</p>
6061: <pre class="programlisting">
6062: user:group
1.1 grant 6063: </pre>
1.87 wiz 6064: <p>Further specification of user details may be done by setting
6065: per-user variables.
6066: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6067: numeric UID for the user.
6068: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6069: user's description or comment.
6070: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6071: user's home directory, and defaults to
6072: <code class="filename">/nonexistent</code> if not specified.
6073: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
6074: user's shell, and defaults to <code class="filename">/sbinno/login</code> if
6075: not specified.</p>
1.75 rillig 6076: <p>Similarly, groups can be created by adding entries to the
6077: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6078: <pre class="programlisting">
6079: group
1.1 grant 6080: </pre>
1.75 rillig 6081: <p>The numeric GID of the group may be set by defining
6082: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6083: <p>If a package needs to create the users and groups at an earlier
6084: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6085: either <code class="literal">configure</code> or <code class="literal">build</code> to
6086: indicate the phase before which the users and groups are created. In
6087: this case, the numeric UIDs and GIDs of the created users and groups
6088: are automatically hardcoded into the final installation scripts.</p>
6089: </div>
6090: <div class="sect1" lang="en">
6091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6092: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75 rillig 6093: <p>Packages that install system shells should register them in the shell
1.76 rillig 6094: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6095: administrator. This must be done from the installation scripts to keep
6096: binary packages working on any system. pkginstall provides an easy way to
6097: accomplish this task.</p>
6098: <p>When a package provides a shell interpreter, it has to set the
6099: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6100: add some hooks to the installation scripts to handle it. Consider the
1.91 ! rillig 6101: 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 6102: <pre class="programlisting">
6103: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6104: </pre>
1.75 rillig 6105: <div class="sect2" lang="en">
6106: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6107: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6108: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6109: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6110: environment variable to <code class="literal">NO</code>.</p>
6111: </div>
6112: </div>
6113: <div class="sect1" lang="en">
6114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6115: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75 rillig 6116: <p>Packages that install X11 fonts should update the database files
6117: that index the fonts within each fonts directory. This can easily be
6118: accomplished within the pkginstall framework.</p>
6119: <p>When a package installs X11 fonts, it must list the directories in
6120: which fonts are installed in the
6121: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6122: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6123: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6124: installation scripts to run the appropriate commands to update the fonts
6125: database files within each of those directories. For convenience, if the
6126: directory path is relative, it is taken to be relative to the package's
1.91 ! rillig 6127: 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 6128: <pre class="programlisting">
6129: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6130: </pre>
1.75 rillig 6131: <div class="sect2" lang="en">
6132: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6133: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6134: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6135: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6136: environment variable to <code class="literal">NO</code>.</p>
6137: </div>
6138: </div>
6139: </div>
6140: <div class="chapter" lang="en">
6141: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6142: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75 rillig 6143: <div class="toc">
6144: <p><b>Table of Contents</b></p>
6145: <dl>
1.90 rillig 6146: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
6147: <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>
6148: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75 rillig 6149: </dl>
6150: </div>
6151: <p>Many packages have the ability to be built to support different
1.76 rillig 6152: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6153: in pkgsrc that provides generic handling of those options that
6154: determine different ways in which the packages can be built. It's
6155: possible for the user to specify exactly which sets of options will be
6156: built into a package or to allow a set of global default options
6157: apply.</p>
6158: <div class="sect1" lang="en">
6159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6160: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75 rillig 6161: <p>Global default options are listed in
6162: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6163: that should be built into every package if that option is supported.
1.76 rillig 6164: This variable should be set in <code class="filename">/etc/mk.conf</code>.</p>
1.75 rillig 6165: </div>
6166: <div class="sect1" lang="en">
6167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6168: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code></h2></div></div></div>
1.75 rillig 6169: <p>The following example shows how
1.76 rillig 6170: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6171: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6172: <code class="filename">Makefile</code>, or in a file,
6173: e.g. <code class="filename">options.mk</code>, that is included by the
6174: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6175: <pre class="programlisting">
6176: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6177: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6178: PKG_OPTIONS_OPTIONAL_GROUPS= database
6179: PKG_OPTIONS_GROUP.database= mysql pgsql
6180: PKG_SUGGESTED_OPTIONS= wibble-foo
6181: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6182: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
1.1 grant 6183:
1.75 rillig 6184: .include "../../mk/bsd.prefs.mk"
1.69 rillig 6185:
1.75 rillig 6186: # this package was previously named wibble2
6187: .if defined(PKG_OPTIONS.wibble2)
6188: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6189: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
1.78 rillig 6190: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
1.75 rillig 6191: .endif
1.69 rillig 6192:
1.75 rillig 6193: .include "../../mk/bsd.options.mk"
1.69 rillig 6194:
1.75 rillig 6195: # Package-specific option-handling
1.69 rillig 6196:
1.75 rillig 6197: ###
6198: ### FOO support
6199: ###
6200: .if !empty(PKG_OPTIONS:Mwibble-foo)
6201: CONFIGURE_ARGS+= --enable-foo
6202: .endif
1.69 rillig 6203:
1.75 rillig 6204: ###
6205: ### LDAP support
6206: ###
6207: .if !empty(PKG_OPTIONS:Mldap)
1.77 rillig 6208: . include "../../databases/openldap-client/buildlink3.mk"
6209: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
1.75 rillig 6210: .endif
1.69 rillig 6211:
1.75 rillig 6212: ###
6213: ### database support
6214: ###
6215: .if !empty(PKG_OPTIONS:Mmysql)
6216: . include "../../mk/mysql.buildlink3.mk"
6217: .endif
6218: .if !empty(PKG_OPTIONS:Mpgsql)
6219: . include "../../mk/pgsql.buildlink3.mk"
6220: .endif
6221: </pre>
6222: <p>The first section contains the information about which build
6223: options are supported by the package, and any default options settings
6224: if needed.</p>
6225: <div class="orderedlist"><ol type="1">
6226: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6227: <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
6228: options. It should be set to
1.78 rillig 6229: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6230: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6231: at the point where the options are processed.</p></li>
1.75 rillig 6232: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6233: build options supported by the package.</p></li>
6234: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6235: list of names of groups of mutually exclusive options. The options in
6236: each group are listed in
6237: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6238: The most specific setting of any option from the group takes
6239: precedence over all other options in the group. Options from the
6240: groups will be automatically added to
6241: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6242: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6243: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6244: packages will fail if no option from the group is
6245: selected.</p></li>
6246: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6247: of names of sets of options. At least one option from each set must
6248: be selected. The options in each set are listed in
6249: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6250: Options from the sets will be automatically added to
6251: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6252: fail if no option from the set is selected.</p></li>
6253: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6254: build options which are enabled by default.</p></li>
6255: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6256: of
6257: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.76 rillig 6258: pairs that map legacy <code class="filename">/etc/mk.conf</code> variables to
1.75 rillig 6259: their option counterparts. Pairs should be added with
6260: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6261: warning will be issued if the user uses a legacy
6262: variable.</p></li>
6263: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6264: of
6265: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6266: pairs that map options that have been renamed to their new
6267: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6268: the listing of global legacy options. A warning will be issued if
6269: the user uses a legacy option.</p></li>
6270: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6271: options implied by deprecated variables used. This can be used for
6272: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6273: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6274: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6275: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6276: a list of warnings about deprecated variables or options used, and
6277: what to use instead.</p></li>
6278: </ol></div>
6279: <p>A package should never modify
6280: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6281: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6282: To suggest a default set of options, use
6283: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6284: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6285: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6286: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6287: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6288: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6289: happen with platform-specific options if none of them is supported on
6290: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6291: empty list and the package is otherwise treated as not using the
6292: options framework.</p>
1.76 rillig 6293: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6294: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6295: build options, properly filtered to remove unsupported and duplicate
6296: options.</p>
6297: <p>The remaining sections contain the logic that is specific to
6298: each option. The correct way to check for an option is to check
6299: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6300: <pre class="programlisting">
6301: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6302: </pre>
6303: </div>
6304: <div class="sect1" lang="en">
6305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6306: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75 rillig 6307: <p>Options that enable similar features in different packages (like
6308: optional support for a library) should use a common name in all
6309: packages that support it (like the name of the library). If another
6310: package already has an option with the same meaning, use the same
6311: name.</p>
6312: <p>Options that enable features specific to one package, where it's
6313: unlikely that another (unrelated) package has the same (or a similar)
6314: optional feature, should use a name prefixed with
6315: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6316: <p>If a group of related packages share an optional feature
6317: specific to that group, prefix it with the name of the
6318: “<span class="quote">main</span>” package
6319: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6320: <p>For new options, add a line to
1.76 rillig 6321: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6322: fields, separated by tab. The first field is the option name, the
6323: second its description. The description should be a whole sentence
6324: (starting with an uppercase letter and ending with a period) that
6325: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6326: support.</span>” The file is sorted by option names.</p>
6327: </div>
6328: </div>
6329: <div class="chapter" lang="en">
6330: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6331: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75 rillig 6332: <div class="toc">
6333: <p><b>Table of Contents</b></p>
6334: <dl>
1.90 rillig 6335: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
6336: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
6337: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
6338: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
6339: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6340: <dd><dl>
6341: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
6342: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
6343: </dl></dd>
6344: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6345: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6346: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6347: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6348: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6349: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6350: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6351: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6352: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6353: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6354: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
6355: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75 rillig 6356: </dl>
6357: </div>
6358: <div class="sect1" lang="en">
6359: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6360: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75 rillig 6361: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6362: built. Building a package is separated into different
6363: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6364: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6365: described in the following sections. Each phase is splitted into
6366: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6367: containing phase, prefixed by one of <code class="varname">pre-</code>,
6368: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6369: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6370: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.75 rillig 6371: <p>The basic steps for building a program are always the same. First
1.87 wiz 6372: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6373: the local system and then extracted. After any pkgsrc-specific patches
6374: to compile properly are applied, the software can be configured, then
6375: built (usually by compiling), and finally the generated binaries, etc.
6376: can be put into place on the system.</p>
1.75 rillig 6377: </div>
6378: <div class="sect1" lang="en">
6379: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6380: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75 rillig 6381: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6382: the next section, here's a brief discussion on where programs are
6383: installed, and which variables influence this.</p>
1.75 rillig 6384: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6385: where all files of the final program shall be installed. It is
6386: usually set to <code class="varname">LOCALBASE</code>
6387: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6388: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6389: <code class="varname">PREFIX</code> needs to be put
6390: into the various places in the program's source where paths to
1.90 rillig 6391: 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 6392: <p>When choosing which of these variables to use,
1.87 wiz 6393: follow the following rules:</p>
1.75 rillig 6394: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6395: <li><p><code class="varname">PREFIX</code> always points to the location
6396: where the current pkg will be installed. When referring to a
6397: pkg's own installation path, use
6398: “<span class="quote">${PREFIX}</span>”.</p></li>
6399: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6400: are installed. If you need to construct a -I or -L argument
6401: to the compiler to find includes and libraries installed by
6402: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6403: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6404: installed all packages in <code class="filename">/usr/local</code>. As
6405: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6406: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6407: <li><p><code class="varname">X11BASE</code> is where the actual X11
6408: distribution (from xsrc, etc.) is installed. When looking for
6409: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6410: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6411: <li>
6412: <p>X11-based packages are special in that they may be
6413: installed in either <code class="varname">X11BASE</code> or
6414: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6415: <p>Usually, X11 packages should be installed under
1.88 wiz 6416: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6417: will need to include
6418: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6419: request the presence of X11 and to get the right compilation
6420: flags.</p>
1.75 rillig 6421: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6422: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6423: files. These packages are special and they must be placed under
6424: <code class="varname">X11BASE</code>. To accomplish this, set either
6425: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6426: your package.</p>
1.75 rillig 6427: <p>Some notes: If you need
1.87 wiz 6428: to find includes or libraries installed by a pkg that has
6429: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6430: its pkg <code class="filename">Makefile</code>, you need to look in
6431: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6432: <code class="filename">${LOCALBASE}</code>. To force installation of
6433: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 ! rillig 6434: <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 6435: is enabled by default.</p>
1.75 rillig 6436: </li>
1.88 wiz 6437: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6438: the installed location of an X11
6439: package. <code class="varname">X11PREFIX</code> will be set to
6440: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6441: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6442: installed.</p></li>
6443: <li>
6444: <p>If xpkgwedge is installed, it is possible to have some
6445: packages installed in <code class="varname">X11BASE</code> and some in
6446: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6447: installed package, the <code class="varname">EVAL_PREFIX</code>
6448: definition can be used. It takes pairs in the format
6449: “<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>
6450: variable <code class="varname">DIRNAME</code> will be set to the prefix
6451: of the installed package <package>, or
6452: “<span class="quote">${X11PREFIX}</span>” if the package is not
6453: installed.</p>
1.75 rillig 6454: <p>This is best illustrated by example.</p>
6455: <p>The following lines are taken from
1.87 wiz 6456: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6457: <pre class="programlisting">
1.87 wiz 6458: EVAL_PREFIX+= GTKDIR=gtk+
6459: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6460: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6461: CONFIGURE_ARGS+= --enable-multibyte
6462: </pre>
1.88 wiz 6463: <p>Specific defaults can be defined for the packages
6464: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6465: definition of the form:</p>
1.75 rillig 6466: <pre class="programlisting">
1.87 wiz 6467: GTKDIR_DEFAULT= ${LOCALBASE}
6468: </pre>
1.75 rillig 6469: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6470: to the first definition in
6471: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6472: </li>
1.76 rillig 6473: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87 wiz 6474: 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
6475: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6476: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6477: </ul></div>
6478: </div>
6479: <div class="sect1" lang="en">
6480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6481: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75 rillig 6482: <p>When building a package, a number of directories is used to store
1.87 wiz 6483: source files, temporary files, pkgsrc-internal files, and so on. These
6484: directories are explained here.</p>
1.75 rillig 6485: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6486: are two common base directories for these relative directories:
6487: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6488: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6489: inside the package itself.</p>
1.75 rillig 6490: <div class="variablelist"><dl>
6491: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6492: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6493: root directory. Generally, you don't need
6494: it.</p></dd>
1.75 rillig 6495: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6496: <dd><p>This is a pathname relative to
1.87 wiz 6497: <code class="varname">PKGSRCDIR</code> that points to the current
6498: package.</p></dd>
1.75 rillig 6499: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6500: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6501: where all work takes place. The distfiles are extraced to this
6502: directory. It also contains temporary directories and log files used by
6503: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6504: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6505: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6506: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6507: where the distfiles are extracted. It is usually a direct subdirectory
6508: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6509: that isn't hidden. This variable may be changed by a package
6510: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6511: </dl></div>
6512: </div>
6513: <div class="sect1" lang="en">
6514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6515: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75 rillig 6516: <p>You can run a particular phase by typing <span><strong class="command">make
1.87 wiz 6517: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6518: phase. This will automatically run all phases that are required for this
6519: phase. The default phase is <code class="varname">build</code>, that is, when you
6520: run <span><strong class="command">make</strong></span> without parameters in a package directory,
6521: the package will be built, but not installed.</p>
1.75 rillig 6522: </div>
6523: <div class="sect1" lang="en">
6524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6525: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6526: <p>The first step in building a package is to fetch the
1.88 wiz 6527: distribution files (distfiles) from the sites that are providing
6528: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6529: phase.</p>
1.81 rillig 6530: <div class="sect2" lang="en">
6531: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6532: <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 6533: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6534: defines all URLs from where the distfile, whose name is
6535: derived from the <code class="varname">DISTNAME</code> variable, is
6536: fetched. The more complicated cases are described
6537: below.</p>
6538: <p>The variable <code class="varname">DISTFILES</code> specifies
6539: the list of distfiles that have to be fetched. Its value
6540: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6541: so that most packages don't need to define it at all.
6542: <code class="varname">EXTRACT_SUFX</code> is
6543: <code class="literal">.tar.gz</code> by default, but can be changed
6544: freely. Note that if your package requires additional
6545: distfiles to the default one, you cannot just append the
6546: additional filenames using the <code class="literal">+=</code>
6547: operator, but you have write for example:</p>
1.81 rillig 6548: <pre class="programlisting">
1.88 wiz 6549: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6550: </pre>
6551: <p>Each distfile is fetched from a list of sites, usually
6552: <code class="varname">MASTER_SITES</code>. If the package has multiple
6553: <code class="varname">DISTFILES</code> or multiple
6554: <code class="varname">PATCHFILES</code> from different sites, you can
6555: set
6556: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6557: to the list of URLs where the file
6558: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6559: (including the suffix) can be found.</p>
6560: <pre class="programlisting">
6561: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6562: DISTFILES+= foo-file.tar.gz
6563: SITES.foo-file.tar.gz= \
6564: http://www.somewhere.com/somehow/ \
6565: http://www.somewhereelse.com/mirror/somehow/
6566: </pre>
1.81 rillig 6567: <p>When actually fetching the distfiles, each item from
1.88 wiz 6568: <code class="varname">MASTER_SITES</code> or
6569: <code class="varname">SITES.*</code> gets the name of each distfile
6570: appended to it, without an intermediate slash. Therefore,
6571: all site values have to end with a slash or other separator
6572: character. This allows for example to set
6573: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6574: that gets the name of the distfile as a parameter. In this
6575: case, the definition would look like:</p>
1.81 rillig 6576: <pre class="programlisting">
1.88 wiz 6577: MASTER_SITES= http://www.example.com/download.cgi?file=
6578: </pre>
1.81 rillig 6579: <p>There are some predefined values for
1.88 wiz 6580: <code class="varname">MASTER_SITES</code>, which can be used in
6581: packages. The names of the variables should speak for
6582: themselves.</p>
6583: <pre class="programlisting">
6584: ${MASTER_SITE_APACHE}
6585: ${MASTER_SITE_BACKUP}
6586: ${MASTER_SITE_CYGWIN}
6587: ${MASTER_SITE_DEBIAN}
6588: ${MASTER_SITE_FREEBSD}
6589: ${MASTER_SITE_FREEBSD_LOCAL}
6590: ${MASTER_SITE_GNOME}
6591: ${MASTER_SITE_GNU}
6592: ${MASTER_SITE_GNUSTEP}
6593: ${MASTER_SITE_IFARCHIVE}
6594: ${MASTER_SITE_KDE}
6595: ${MASTER_SITE_MOZILLA}
6596: ${MASTER_SITE_MYSQL}
6597: ${MASTER_SITE_OPENOFFICE}
6598: ${MASTER_SITE_PERL_CPAN}
6599: ${MASTER_SITE_PGSQL}
6600: ${MASTER_SITE_R_CRAN}
6601: ${MASTER_SITE_SOURCEFORGE}
6602: ${MASTER_SITE_SOURCEFORGE_JP}
6603: ${MASTER_SITE_SUNSITE}
6604: ${MASTER_SITE_SUSE}
6605: ${MASTER_SITE_TEX_CTAN}
6606: ${MASTER_SITE_XCONTRIB}
6607: ${MASTER_SITE_XEMACS}
6608: </pre>
6609: <p>Some explanations for the less self-explaining ones:
6610: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
6611: 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
6612: 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>
6613: <p>If you choose one of these predefined sites, you may
6614: want to specify a subdirectory of that site. Since these
6615: macros may expand to more than one actual site, you
6616: <span class="emphasis"><em>must</em></span> use the following construct to
6617: specify a subdirectory:</p>
1.81 rillig 6618: <pre class="programlisting">
1.88 wiz 6619: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6620: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6621: </pre>
1.81 rillig 6622: <p>Note the trailing slash after the subdirectory
1.88 wiz 6623: name.</p>
1.81 rillig 6624: </div>
6625: <div class="sect2" lang="en">
6626: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6627: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6628: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6629: all the distfiles exist in a local directory
6630: (<code class="varname">DISTDIR</code>), which can be set by the pkgsrc
6631: user). If the files do not exist, they are fetched using
6632: commands of the form</p>
1.75 rillig 6633: <pre class="programlisting">
1.88 wiz 6634: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6635: </pre>
6636: <p>where <code class="literal">${site}</code> varies through
6637: several possibilities in turn: first,
6638: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6639: sites specified in either <code class="varname">SITES.file</code> if
6640: defined, else <code class="varname">MASTER_SITES</code> or
6641: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6642: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 ! rillig 6643: all except the first and the last can be optionally sorted
! 6644: by the user, via setting either
! 6645: <code class="varname">MASTER_SORT_RANDOM</code>, and
! 6646: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6647: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.81 rillig 6648: </div>
1.75 rillig 6649: </div>
6650: <div class="sect1" lang="en">
6651: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6652: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6653: <p>After the distfile(s) are fetched, their checksum is
6654: generated and compared with the checksums stored in the
6655: distinfo file. If the checksums don't match, the build is
6656: aborted. This is to ensure the same distfile is used for
6657: building, and that the distfile wasn't changed, e.g. by some
6658: malign force, deliberately changed distfiles on the master
6659: distribution site or network lossage.</p>
1.75 rillig 6660: </div>
6661: <div class="sect1" lang="en">
6662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6663: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6664: <p>When the distfiles are present on the local system, they
1.88 wiz 6665: need to be extracted, as they usually come in the form of some
6666: compressed archive format.</p>
1.75 rillig 6667: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6668: extracted. If you only need some of them, you can set the
6669: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6670: files.</p>
6671: <p>Extracting the files is usually done by a little
6672: program, <code class="filename">mk/scripts/extract</code>, which
6673: already knows how to extract various archive formats, so most
6674: likely you will not need to change anything here. But if you
6675: need, the following variables may help you:</p>
1.75 rillig 6676: <div class="variablelist"><dl>
6677: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6678: <dd><p>Use these variables to override the default
1.88 wiz 6679: options for an extract command, which are defined in
6680: <code class="filename">mk/scripts/extract</code>.</p></dd>
1.75 rillig 6681: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6682: <dd><p>This variable can be set to
1.88 wiz 6683: <code class="literal">pax</code>, <code class="literal">tar</code> or an
6684: absolute pathname pointing to the command with which tar
6685: archives should be
6686: extracted.</p></dd>
1.75 rillig 6687: </dl></div>
1.88 wiz 6688: <p>If the <code class="filename">extract</code> program doesn't
6689: serve your needs, you can also override the
6690: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6691: command used for extracting the files. This command is
6692: executed in the <code class="filename">${WRKSRC}</code>
6693: directory. During execution of this command, the shell
6694: variable <code class="varname">extract_file</code> holds the absolute
6695: pathname of the file that is going to be extracted.</p>
1.75 rillig 6696: <p>And if that still does not suffice, you can override the
1.88 wiz 6697: <code class="varname">do-extract</code> target in the package
6698: Makefile.</p>
1.75 rillig 6699: </div>
6700: <div class="sect1" lang="en">
6701: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6702: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6703: <p>After extraction, all the patches named by the
1.88 wiz 6704: <code class="varname">PATCHFILES</code>, those present in the patches
6705: subdirectory of the package as well as in
6706: $LOCALPATCHES/$PKGPATH (e.g.
6707: <code class="filename">/usr/local/patches/graphics/png</code>) are
6708: applied. Patchfiles ending in <code class="filename">.Z</code> or
6709: <code class="filename">.gz</code> are uncompressed before they are
6710: applied, files ending in <code class="filename">.orig</code> or
6711: <code class="filename">.rej</code> are ignored. Any special options to
6712: <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 6713: <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 6714: <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
6715: it fail if the patches apply with some lines of fuzz. Please
6716: fix (regen) the patches so that they apply cleanly. The
6717: rationale behind this is that patches that don't apply cleanly
6718: may end up being applied in the wrong place, and cause severe
6719: harm there.</p>
1.75 rillig 6720: </div>
6721: <div class="sect1" lang="en">
6722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6723: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6724: <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 6725: </p>
1.75 rillig 6726: </div>
6727: <div class="sect1" lang="en">
6728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6729: <a name="build.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6730: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6731: linkers. The following variables can be used to tweak the
6732: wrappers.</p>
1.75 rillig 6733: <div class="variablelist"><dl>
6734: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6735: <dd><p>The command used to print progress
1.88 wiz 6736: messages. Does nothing by default. Set to
6737: <code class="literal">${ECHO}</code> to see the progress
6738: messages.</p></dd>
1.75 rillig 6739: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6740: <dd><p>This variable can be set to
1.88 wiz 6741: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6742: depending on whether you want additional information in the
6743: wrapper log file.</p></dd>
1.75 rillig 6744: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6745: <dd><p>This variable can be set to
1.88 wiz 6746: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6747: on whether the wrapper should use its cache, which will
6748: improve the speed. The default value is
6749: <code class="literal">yes</code>, but is forced to
6750: <code class="literal">no</code> if the platform does not support
6751: it.</p></dd>
1.75 rillig 6752: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6753: <dd><p>A list of reordering commands. A reordering
6754: command has the form
6755: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6756: It ensures that that
6757: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6758: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6759: </p></dd>
1.75 rillig 6760: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6761: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6762: investigate further]</p></dd>
1.75 rillig 6763: </dl></div>
6764: </div>
6765: <div class="sect1" lang="en">
6766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6767: <a name="build.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6768: <p>Most pieces of software need information on the header
6769: files, system calls, and library routines which are available
6770: on the platform they run on. The process of determining this
6771: information is known as configuration, and is usually
6772: automated. In most cases, a script is supplied with the
6773: distfiles, and its invocation results in generation of header
6774: files, Makefiles, etc.</p>
6775: <p>If the package contains a configure script, this can be
6776: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6777: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6778: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6779: “<span class="quote">yes</span>” instead. What happens in the
6780: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6781: <pre class="programlisting">
6782: .for d in ${CONFIGURE_DIRS}
6783: cd ${WRKSRC} && cd ${d} && env ${CONFIGURE_ENV} \
6784: ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6785: .endfor
6786: </pre>
6787: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6788: “<span class="quote">.</span>”) is a list of pathnames relative to
6789: <code class="varname">WRKSRC</code>. In each of these directories, the
6790: configure script is run with the environment
6791: <code class="varname">CONFIGURE_ENV</code> and arguments
6792: <code class="varname">CONFIGURE_ARGS</code>. The variables
6793: <code class="varname">CONFIGURE_ENV</code>,
6794: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6795: “<span class="quote">./configure</span>”) and
6796: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6797: package.</p>
6798: <p>If the program uses an <code class="filename">Imakefile</code>
6799: for configuration, the appropriate steps can be invoked by
6800: setting <code class="varname">USE_IMAKE</code> to
6801: “<span class="quote">yes</span>”. (If you only want the package installed in
6802: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6803: <code class="varname">USE_X11BASE</code> instead.)</p>
1.75 rillig 6804: </div>
6805: <div class="sect1" lang="en">
6806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6807: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6808: <p>For building a package, a rough equivalent of the
6809: following code is executed.</p>
1.75 rillig 6810: <pre class="programlisting">
1.88 wiz 6811: .for d in ${BUILD_DIRS}
6812: cd ${WRKSRC} && cd ${d} && env ${MAKE_ENV} \
6813: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6814: -f ${MAKE_FILE} ${BUILD_TARGET}
6815: .endfor
6816: </pre>
6817: <p><code class="varname">BUILD_DIRS</code> (default:
6818: “<span class="quote">.</span>”) is a list of pathnames relative to
6819: <code class="varname">WRKSRC</code>. In each of these directories,
6820: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6821: <code class="varname">MAKE_ENV</code> and arguments
6822: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6823: <code class="varname">MAKE_ENV</code>,
6824: <code class="varname">BUILD_MAKE_FLAGS</code>,
6825: <code class="varname">MAKE_FILE</code> and
6826: <code class="varname">BUILD_TARGET</code> may all be changed by the
6827: package.</p>
1.75 rillig 6828: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6829: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6830: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6831: default value of <code class="varname">MAKE_FILE</code> is
6832: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6833: defaults to “<span class="quote">all</span>”.</p>
1.75 rillig 6834: </div>
6835: <div class="sect1" lang="en">
6836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6837: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6838: <p>[TODO]</p>
6839: </div>
6840: <div class="sect1" lang="en">
6841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6842: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6843: <p>Once the build stage has completed, the final step is to
1.88 wiz 6844: install the software in public directories, so users can
6845: access the programs and files.</p>
1.75 rillig 6846: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6847: equivalent of the following code is executed. Additionally,
6848: before and after this code, much magic is performed to do
6849: consistency checks, registering the package, and so on.</p>
6850: <pre class="programlisting">
6851: .for d in ${INSTALL_DIRS}
6852: cd ${WRKSRC} && cd ${d} && env ${MAKE_ENV} \
6853: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6854: -f ${MAKE_FILE} ${BUILD_TARGET}
6855: .endfor
6856: </pre>
1.75 rillig 6857: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6858: <span class="emphasis"><em>build</em></span> phase.
6859: <code class="varname">INSTALL_DIRS</code> defaults to
6860: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
6861: is “<span class="quote">install</span>” by default, plus
6862: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
6863: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6864: defined.</p>
1.75 rillig 6865: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6866: variables are useful. They are all variations of the
6867: <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
6868: permissions preset. <code class="varname">INSTALL</code> is the plain
6869: install command. The specialized variants, together with their
6870: intended use, are:</p>
1.75 rillig 6871: <div class="variablelist"><dl>
6872: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6873: <dd><p>directories that contain
6874: binaries</p></dd>
1.75 rillig 6875: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6876: <dd><p>directories that contain
6877: scripts</p></dd>
1.75 rillig 6878: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6879: <dd><p>directories that contain shared and static
6880: libraries</p></dd>
1.75 rillig 6881: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6882: <dd><p>directories that contain data
6883: files</p></dd>
1.75 rillig 6884: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6885: <dd><p>directories that contain man
6886: pages</p></dd>
1.75 rillig 6887: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6888: <dd><p>binaries that can be stripped from debugging
6889: symbols</p></dd>
1.75 rillig 6890: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6891: <dd><p>binaries that cannot be
6892: stripped</p></dd>
1.75 rillig 6893: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6894: <dd><p>game
6895: binaries</p></dd>
1.75 rillig 6896: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6897: <dd><p>shared and static
6898: libraries</p></dd>
1.75 rillig 6899: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6900: <dd><p>data files</p></dd>
6901: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6902: <dd><p>data files for
6903: games</p></dd>
1.75 rillig 6904: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6905: <dd><p>man pages</p></dd>
6906: </dl></div>
6907: <p>Some other variables are:</p>
6908: <div class="variablelist"><dl>
6909: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6910: <dd><p>A list of directories relative to
1.88 wiz 6911: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6912: beginning of the <span class="emphasis"><em>install</em></span> phase. If
6913: this variable is set,
6914: <code class="varname">NO_MTREE</code>=“<span class="quote">yes</span>” is assumed,
6915: which means that the package claims to create all needed
6916: directories itself before installing files to it. Therefore
6917: this variable should only be set in
6918: <code class="filename">Makefile</code>s that are under control of the
6919: package's author. The directories are created with the
6920: correct ownership, depending on their
6921: name.</p></dd>
1.75 rillig 6922: </dl></div>
6923: </div>
6924: <div class="sect1" lang="en">
6925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6926: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6927: <p>Once the install stage has completed, a binary package of
6928: the installed files can be built. These binary packages can be
6929: used for quick installation without previous compilation, e.g. by
6930: the <span><strong class="command">make bin-install</strong></span> or by using
6931: <span><strong class="command">pkg_add</strong></span>.</p>
6932: <p>By default, the binary packages are created in
6933: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6934: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6935: one for each category in the <code class="varname">CATEGORIES</code>
6936: variable. <code class="varname">PACKAGES</code> defaults to
6937: <code class="filename">pkgsrc/packages</code>.</p>
6938: </div>
6939: <div class="sect1" lang="en">
6940: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6941: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88 wiz 6942: <p>Once you're finished with a package, you can clean the work
6943: directory by running <span><strong class="command">make clean</strong></span>. If you want
6944: to clean the work directories of all dependencies too, use
6945: <span><strong class="command">make clean-depends</strong></span>.</p>
1.75 rillig 6946: </div>
6947: <div class="sect1" lang="en">
6948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6949: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75 rillig 6950: <div class="variablelist"><dl>
6951: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6952: <dd><p>For any of the main targets described in the
6953: previous section, two auxiliary targets exist with
1.87 wiz 6954: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
6955: prefix for the main target's name. These targets are
1.88 wiz 6956: invoked before and after the main target is called,
6957: allowing extra configuration or installation steps be
6958: performed from a package's Makefile, for example, which
6959: a program's configure script or install target
6960: omitted.</p></dd>
1.75 rillig 6961: <dt><span class="term">do-*</span></dt>
1.88 wiz 6962: <dd><p>Should one of the main targets do the wrong thing,
6963: and should there be no variable to fix this, you can
6964: redefine it with the do-* target. (Note that redefining
6965: the target itself instead of the do-* target is a bad
6966: idea, as the pre-* and post-* targets won't be called
6967: anymore, etc.) You will not usually need to do
6968: this.</p></dd>
1.75 rillig 6969: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6970: <dd>
6971: <p>If you did a <span><strong class="command">make install</strong></span> and
6972: you noticed some file was not installed properly, you
6973: can repeat the installation with this target, which will
6974: ignore the “<span class="quote">already installed</span>” flag.</p>
6975: <p>This is the default value of
6976: <code class="varname">DEPENDS_TARGET</code> except in the case of
6977: <span><strong class="command">make update</strong></span> and <span><strong class="command">make
6978: package</strong></span>, where the defaults are
6979: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
6980: respectively.</p>
6981: </dd>
1.75 rillig 6982: <dt><span class="term">deinstall</span></dt>
6983: <dd>
1.88 wiz 6984: <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
6985: current directory, effectively de-installing the
6986: package. The following variables can be used to tune the
6987: behaviour:</p>
1.75 rillig 6988: <div class="variablelist"><dl>
6989: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
6990: <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>
6991: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 6992: <dd><p>Remove all packages that require (depend on)
6993: the given package. This can be used to remove any
6994: packages that may have been pulled in by a given
6995: package, e.g. if <span><strong class="command">make deinstall
1.87 wiz 6996: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 6997: <code class="filename">pkgsrc/x11/kde</code>, this is
6998: likely to remove whole KDE. Works by adding
6999: “<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>
7000: command line.</p></dd>
1.75 rillig 7001: </dl></div>
7002: </dd>
1.88 wiz 7003: <dt><span class="term">bin-install</span></dt>
7004: <dd><p>Install a binary package from local disk and via FTP
7005: from a list of sites (see the
7006: <code class="varname">BINPKG_SITES</code> variable), and do a
7007: <span><strong class="command">make package</strong></span> if no binary package is
7008: available anywhere. The arguments given to
7009: <span><strong class="command">pkg_add</strong></span> can be set via
7010: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7011: operation, etc.</p></dd>
1.75 rillig 7012: <dt><span class="term">update</span></dt>
7013: <dd>
1.88 wiz 7014: <p>This target causes the current package to be
7015: updated to the latest version. The package and all
7016: depending packages first get de-installed, then current
7017: versions of the corresponding packages get compiled and
7018: installed. This is similar to manually noting which
7019: packages are currently installed, then performing a
7020: series of <span><strong class="command">make deinstall</strong></span> and
7021: <span><strong class="command">make install</strong></span> (or whatever
7022: <code class="varname">UPDATE_TARGET</code> is set to) for these
7023: packages.</p>
7024: <p>You can use the “<span class="quote">update</span>” target to
7025: resume package updating in case a previous <span><strong class="command">make
7026: update</strong></span> was interrupted for some reason.
7027: However, in this case, make sure you don't call
7028: <span><strong class="command">make clean</strong></span> or otherwise remove the
7029: list of dependent packages in <code class="varname">WRKDIR</code>.
7030: Otherwise, you lose the ability to automatically update
7031: the current package along with the dependent packages
7032: you have installed.</p>
7033: <p>Resuming an interrupted <span><strong class="command">make
7034: update</strong></span> will only work as long as the package
7035: tree remains unchanged. If the source code for one of
7036: the packages to be updated has been changed, resuming
7037: <span><strong class="command">make update</strong></span> will most certainly
7038: fail!</p>
7039: <p>The following variables can be used either on the
7040: command line or in <code class="filename">/etc/mk.conf</code> to
7041: alter the behaviour of <span><strong class="command">make
7042: update</strong></span>:</p>
1.75 rillig 7043: <div class="variablelist"><dl>
7044: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7045: <dd><p>Install target to recursively use for the
7046: updated package and the dependent packages.
7047: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7048: set, “<span class="quote">install</span>” otherwise for
7049: <span><strong class="command">make update</strong></span>. Other good
7050: targets are “<span class="quote">package</span>” or
7051: “<span class="quote">bin-install</span>”. Do not set this to
7052: “<span class="quote">update</span>” or you will get stuck in an
7053: endless loop!</p></dd>
1.75 rillig 7054: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7055: <dd><p>Don't clean up after updating. Useful if
7056: you want to leave the work sources of the updated
7057: packages around for inspection or other purposes.
7058: Be sure you eventually clean up the source tree
7059: (see the “<span class="quote">clean-update</span>” target below)
7060: or you may run into troubles with old source code
7061: still lying around on your next
7062: <span><strong class="command">make</strong></span> or <span><strong class="command">make
7063: update</strong></span>.</p></dd>
1.75 rillig 7064: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7065: <dd><p>Deinstall each package before installing
7066: (making <code class="varname">DEPENDS_TARGET</code>). This
7067: may be necessary if the
7068: “<span class="quote">clean-update</span>” target (see below) was
7069: called after interrupting a running <span><strong class="command">make
7070: update</strong></span>.</p></dd>
1.75 rillig 7071: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7072: <dd><p>Allows you to disable recursion and hardcode
7073: the target for packages. The default is
7074: “<span class="quote">update</span>” for the update target,
7075: facilitating a recursive update of prerequisite
7076: packages. Only set
7077: <code class="varname">DEPENDS_TARGET</code> if you want to
7078: disable recursive updates. Use
7079: <code class="varname">UPDATE_TARGET</code> instead to just
7080: set a specific target for each package to be
7081: installed during <span><strong class="command">make update</strong></span>
7082: (see above).</p></dd>
1.75 rillig 7083: </dl></div>
7084: </dd>
7085: <dt><span class="term">clean-update</span></dt>
7086: <dd>
1.88 wiz 7087: <p>Clean the source tree for all packages that would
7088: get updated if <span><strong class="command">make update</strong></span> was called
7089: from the current directory. This target should not be
7090: used if the current package (or any of its depending
7091: packages) have already been de-installed (e.g., after
7092: calling <span><strong class="command">make update</strong></span>) or you may lose
7093: some packages you intended to update. As a rule of
7094: thumb: only use this target <span class="emphasis"><em>before</em></span>
7095: the first time you run <span><strong class="command">make update</strong></span>
7096: and only if you have a dirty package tree (e.g., if you
7097: used <code class="varname">NOCLEAN</code>).</p>
7098: <p>If you are unsure about whether your tree is
7099: clean, you can either perform a <span><strong class="command">make
7100: clean</strong></span> at the top of the tree, or use the
7101: following sequence of commands from the directory of the
7102: package you want to update (<span class="emphasis"><em>before</em></span>
7103: running <span><strong class="command">make update</strong></span> for the first
7104: time, otherwise you lose all the packages you wanted to
7105: update!):</p>
1.87 wiz 7106: <pre class="screen">
7107: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7108: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7109: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7110: </pre>
1.88 wiz 7111: <p>The following variables can be used either on the
7112: command line or in <code class="filename">/etc/mk.conf</code> to
7113: alter the behaviour of <span><strong class="command">make
7114: clean-update</strong></span>:</p>
1.75 rillig 7115: <div class="variablelist"><dl>
7116: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.88 wiz 7117: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
7118: reconstruct the list of directories to update for
7119: this package. Only use this if <span><strong class="command">make
7120: update</strong></span> successfully installed all
7121: packages you wanted to update. Normally, this is
7122: done automatically on <span><strong class="command">make
7123: update</strong></span>, but may have been suppressed by
7124: the <code class="varname">NOCLEAN</code> variable (see
7125: above).</p></dd>
1.75 rillig 7126: </dl></div>
7127: </dd>
1.88 wiz 7128: <dt><span class="term">replace</span></dt>
7129: <dd>
7130: <p>Update the installation of the current package. This
7131: differs from update in that it does not replace dependent
1.91 ! rillig 7132: packages. You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgsrc/pkgtools/pkg_tarup</code></a> for this
1.88 wiz 7133: target to work.</p>
7134: <p><span class="emphasis"><em>Be careful when using this
7135: target!</em></span> There are no guarantees that dependent
7136: packages will still work, in particular they will most
7137: certainly break if you <span><strong class="command">make replace</strong></span> a
7138: library package whose shared library major version changed
7139: between your installed version and the new one. For this
7140: reason, this target is not officially supported and only
7141: recommended for advanced users.</p>
7142: </dd>
1.75 rillig 7143: <dt><span class="term">info</span></dt>
7144: <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 7145: package. You can use this to check which version of a
7146: package is installed.</p></dd>
7147: <dt><span class="term">index</span></dt>
7148: <dd>
7149: <p>This is a top-level command, i.e. it should be used in
7150: the <code class="filename">pkgsrc</code> directory. It creates a
7151: database of all packages in the local pkgsrc tree, including
7152: dependencies, comment, maintainer, and some other useful
7153: information. Individual entries are created by running
7154: <span><strong class="command">make describe</strong></span> in the packages'
7155: directories. This index file is saved as
7156: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
7157: verbose format by running <span><strong class="command">make
7158: print-index</strong></span>. You can search in it with
7159: <span><strong class="command">make search
7160: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7161: extract a list of all packages that depend on a particular
7162: one by running <span><strong class="command">make show-deps
7163: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7164: <p>Running this command takes a very long time, some
7165: hours even on fast machines!</p>
7166: </dd>
1.75 rillig 7167: <dt><span class="term">readme</span></dt>
1.88 wiz 7168: <dd>
7169: <p>This target generates a
7170: <code class="filename">README.html</code> file, which can be
1.91 ! rillig 7171: 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 7172: contain references to any packages which are in the
7173: <code class="varname">PACKAGES</code> directory on the local
7174: host. The generated files can be made to refer to URLs
7175: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7176: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7177: wanted to generate <code class="filename">README.html</code>
7178: files which pointed to binary packages on the local
7179: machine, in the directory
7180: <code class="filename">/usr/packages</code>, set
7181: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7182: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7183: <code class="varname">${PACKAGES}</code> directory and its
7184: subdirectories will be searched for all the binary
7185: packages.</p>
7186: <p>The target can be run at the toplevel or in category
7187: directories, in which case it descends recursively.</p>
7188: </dd>
1.75 rillig 7189: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7190: <dd><p>This is a top-level command, run it in
7191: <code class="filename">pkgsrc</code>. Use this target to create a
7192: file <code class="filename">README-all.html</code> which contains a
7193: list of all packages currently available in the NetBSD
7194: Packages Collection, together with the category they belong
7195: to and a short description. This file is compiled from the
7196: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7197: to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
7198: readme</strong></span>.</p></dd>
1.75 rillig 7199: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7200: <dd><p>This is very much the same as the
7201: “<span class="quote">readme</span>” target (see above), but is to be
7202: used when generating a pkgsrc tree to be written to a
7203: CD-ROM. This target also produces
7204: <code class="filename">README.html</code> files, and can be made
7205: to refer to URLs based on
7206: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7207: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7208: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7209: <dd><p>This target shows which distfiles and patchfiles
7210: are needed to build the package
7211: (<code class="varname">ALLFILES</code>, which contains all
7212: <code class="varname">DISTFILES</code> and
1.87 wiz 7213: <code class="varname">PATCHFILES</code>, but not
7214: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7215: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7216: <dd><p>This target shows nothing if the package is not
7217: installed. If a version of this package is installed,
7218: but is not the version provided in this version of
7219: pkgsrc, then a warning message is displayed. This target
7220: can be used to show which of your installed packages are
7221: downlevel, and so the old versions can be deleted, and
7222: the current ones added.</p></dd>
1.75 rillig 7223: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7224: <dd><p>This target shows the directory in the pkgsrc
7225: hierarchy from which the package can be built and
7226: installed. This may not be the same directory as the one
7227: from which the package was installed. This target is
7228: intended to be used by people who may wish to upgrade
7229: many packages on a single host, and can be invoked from
7230: the top-level pkgsrc Makefile by using the
1.87 wiz 7231: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
1.75 rillig 7232: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7233: <dd><p>This target shows which installed packages match
7234: the current package's <code class="varname">DEPENDS</code>. Useful
7235: if out of date dependencies are causing build
7236: problems.</p></dd>
1.75 rillig 7237: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7238: <dd><p>After a package is installed, check all its
7239: binaries and (on ELF platforms) shared libraries to see
7240: if they find the shared libs they need. Run by default
7241: if <code class="varname">PKG_DEVELOPER</code> is set in
1.87 wiz 7242: <code class="filename">/etc/mk.conf</code>.</p></dd>
1.75 rillig 7243: <dt><span class="term">print-PLIST</span></dt>
7244: <dd>
7245: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7246: upgraded pkg, this prints out an attempt to generate a
7247: new <code class="filename">PLIST</code> from a <span><strong class="command">find
7248: -newer work/.extract_done</strong></span>. An attempt is made
7249: to care for shared libs etc., but it is
1.87 wiz 7250: <span class="emphasis"><em>strongly</em></span> recommended to review the
7251: result before putting it into
7252: <code class="filename">PLIST</code>. On upgrades, it's useful to
7253: diff the output of this command against an already
7254: existing <code class="filename">PLIST</code> file.</p>
1.88 wiz 7255: <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
7256: other methods that don't update file access times, be
7257: sure to add these files manually to your
1.87 wiz 7258: <code class="filename">PLIST</code>, as the “<span class="quote">find
7259: -newer</span>” command used by this target won't catch
7260: them!</p>
1.90 rillig 7261: <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 7262: information on this target.</p>
1.75 rillig 7263: </dd>
7264: <dt><span class="term">bulk-package</span></dt>
7265: <dd>
1.88 wiz 7266: <p>Used to do bulk builds. If an appropriate binary
7267: package already exists, no action is taken. If not, this
7268: target will compile, install and package it (and its
7269: depends, if <code class="varname">PKG_DEPENDS</code> is set
7270: properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, “Configuration”</a>).
7271: After creating the binary package, the sources, the
7272: just-installed package and its required packages are
7273: removed, preserving free disk space.</p>
7274: <p><span class="emphasis"><em>Beware that this target may deinstall
7275: all packages installed on a system!</em></span></p>
1.75 rillig 7276: </dd>
7277: <dt><span class="term">bulk-install</span></dt>
7278: <dd>
1.88 wiz 7279: <p>Used during bulk-installs to install required
7280: packages. If an up-to-date binary package is available,
7281: 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,
7282: <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87 wiz 7283: but the installed binary won't be removed.</p>
1.88 wiz 7284: <p>A binary package is considered
7285: “<span class="quote">up-to-date</span>” to be installed via
7286: <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>
7287: <div class="itemizedlist"><ul type="disc">
7288: <li><p>None of the package's files
7289: (<code class="filename">Makefile</code>, ...) were modified
7290: since it was built.</p></li>
7291: <li><p>None of the package's required (binary)
7292: packages were modified since it was built.</p></li>
1.75 rillig 7293: </ul></div>
1.88 wiz 7294: <p><span class="emphasis"><em>Beware that this target may deinstall
7295: all packages installed on a system!</em></span></p>
1.75 rillig 7296: </dd>
7297: </dl></div>
7298: </div>
7299: </div>
7300: <div class="chapter" lang="en">
7301: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7302: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7303: <div class="toc">
7304: <p><b>Table of Contents</b></p>
7305: <dl>
1.90 rillig 7306: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
7307: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
7308: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75 rillig 7309: </dl>
7310: </div>
1.87 wiz 7311: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7312: by pkgsrc and also for individual packages to define what commands
7313: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7314: or for later run-time of an installed packaged (such as
7315: <code class="varname">DEPENDS</code>).
7316: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7317: package will not be used.</p>
7318: <p>When building a package, the replacement tools are
1.75 rillig 7319: made available in a directory (as symlinks or wrapper scripts)
7320: that is early in the executable search path. Just like the buildlink
1.87 wiz 7321: system, this helps with consistent builds.</p>
7322: <p>A tool may be needed to help build a specific package. For example,
7323: perl, GNU make (gmake) or yacc may be needed.</p>
7324: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7325: tool may be inefficient for building a package with pkgsrc.
7326: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7327: yacc) or a better sed.</p>
7328: <p>The tools used by a package can be listed by running
7329: <span><strong class="command">make show-tools</strong></span>.</p>
1.75 rillig 7330: <div class="sect1" lang="en">
7331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7332: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7333: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7334: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75 rillig 7335: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
7336: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
7337: These can be seen by running:
1.87 wiz 7338: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7339: <p>If a package needs a specific program to build
1.75 rillig 7340: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7341: to define the tools needed.</p>
1.75 rillig 7342: </div>
7343: <div class="sect1" lang="en">
7344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7345: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7346: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7347: and not the native version for a build dependency.
7348: And the :run means that it is used for a
7349: run-time dependencies also (and becomes a DEPENDS).
7350: The default is a build dependency which can be set with
7351: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7352: and pkg-config:build.)</p>
1.75 rillig 7353: <pre class="programlisting">
7354: USE_TOOLS+= mktemp:pkgsrc
7355: USE_TOOLS+= gmake perl:run pkg-config
7356: </pre>
1.87 wiz 7357: <p>When using the tools framework, a
1.75 rillig 7358: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7359: which contains the full path to the appropriate tool. For example,
7360: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7361: on Linux systems.</p>
7362: <p>If you always need a pkgsrc version of the
1.75 rillig 7363: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7364: </p>
7365: </div>
7366: <div class="sect1" lang="en">
7367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7368: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7369: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7370: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7371: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7372: the name of the common tools. For example:</p>
7373: <pre class="programlisting">
7374: .if exists(/usr/bin/bzcat)
7375: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7376: .elif exists(/usr/bin/bzip2)
7377: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7378: .endif
1.69 rillig 7379:
1.75 rillig 7380: TOOLS_PLATFORM.true?= true # shell builtin
7381: </pre>
7382: </div>
7383: </div>
7384: <div class="chapter" lang="en">
7385: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7386: <a name="fixes"></a>Chapter 18. Making your package work</h2></div></div></div>
1.75 rillig 7387: <div class="toc">
7388: <p><b>Table of Contents</b></p>
7389: <dl>
1.90 rillig 7390: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75 rillig 7391: <dd><dl>
1.90 rillig 7392: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
7393: <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>
7394: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
7395: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
7396: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
7397: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
7398: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
7399: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
7400: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
7401: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
7402: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7403: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7404: </dl></dd>
7405: <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>
7406: <dd><dl>
7407: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7408: <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>
7409: </dl></dd>
7410: <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>
7411: <dd><dl>
7412: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
7413: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7414: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
7415: </dl></dd>
7416: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
7417: <dd><dl>
7418: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
7419: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
7420: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
7421: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
7422: </dl></dd>
7423: <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>
7424: <dd><dl>
7425: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
7426: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
7427: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7428: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
7429: </dl></dd>
7430: <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>
7431: <dd><dl>
7432: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
7433: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
7434: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing score files</a></span></dt>
7435: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
7436: <dt><span class="sect2"><a href="#perl-modules">18.6.5. Packages installing perl modules</a></span></dt>
7437: <dt><span class="sect2"><a href="#faq.info-files">18.6.6. Packages installing info files</a></span></dt>
7438: <dt><span class="sect2"><a href="#manpages">18.6.7. Packages installing man pages</a></span></dt>
7439: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.8. Packages installing GConf2 data files</a></span></dt>
7440: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.9. Packages installing scrollkeeper data files</a></span></dt>
7441: <dt><span class="sect2"><a href="#x11-fonts">18.6.10. Packages installing X11 fonts</a></span></dt>
7442: <dt><span class="sect2"><a href="#gtk2-modules">18.6.11. Packages installing GTK2 modules</a></span></dt>
7443: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.12. Packages installing SGML or XML data</a></span></dt>
7444: <dt><span class="sect2"><a href="#mime-database">18.6.13. Packages installing extensions to the MIME database</a></span></dt>
7445: <dt><span class="sect2"><a href="#intltool">18.6.14. Packages using intltool</a></span></dt>
7446: <dt><span class="sect2"><a href="#startup-scripts">18.6.15. Packages installing startup scripts</a></span></dt>
7447: <dt><span class="sect2"><a href="#tex-packages">18.6.16. Packages installing TeX modules</a></span></dt>
7448: <dt><span class="sect2"><a href="#emulation-packages">18.6.17. Packages supporting running binaries in
1.87 wiz 7449: emulation</a></span></dt>
1.90 rillig 7450: <dt><span class="sect2"><a href="#hicolor-theme">18.6.18. Packages installing hicolor theme icons</a></span></dt>
7451: <dt><span class="sect2"><a href="#desktop-files">18.6.19. Packages installing desktop files</a></span></dt>
1.75 rillig 7452: </dl></dd>
1.90 rillig 7453: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7454: </dl>
7455: </div>
7456: <div class="sect1" lang="en">
7457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7458: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75 rillig 7459: <div class="sect2" lang="en">
7460: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7461: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7462: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7463: different platforms. As a result, it is important to ensure,
7464: where possible, that packages in pkgsrc are portable. This
7465: chapter mentions some particular details you should pay
7466: attention to while working on pkgsrc.</p>
1.78 rillig 7467: </div>
7468: <div class="sect2" lang="en">
7469: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7470: <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></h3></div></div></div>
1.78 rillig 7471: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7472: variables in the file pointed to by <code class="varname">MAKECONF</code>,
7473: which is <code class="filename">/etc/mk.conf</code> by default. When you
7474: want to use those variables in the preprocessor directives of
7475: <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
7476: <code class="literal">.for</code>), you need to include the file
7477: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7478: loads the user preferences.</p>
1.78 rillig 7479: <p>But note that some variables may not be completely defined
1.87 wiz 7480: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7481: included, as they may contain references to variables that are
7482: not yet defined. In shell commands this is no problem, since
7483: variables are actually macros, which are only expanded when they
7484: are used. But in the preprocessor directives mentioned above and
7485: in dependency lines (of the form <code class="literal">target:
7486: dependencies</code>) the variables are expanded at load
7487: time.</p>
1.78 rillig 7488: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7489: <h3 class="title">Note</h3>
7490: <p>Currently there is no exhaustive list of all
1.87 wiz 7491: variables that tells you whether they can be used at load time
7492: or only at run time, but it is in preparation.</p>
1.78 rillig 7493: </div>
7494: </div>
7495: <div class="sect2" lang="en">
7496: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7497: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88 wiz 7498: <p>Occasionally, packages require interaction from the user,
7499: and this can be in a number of ways:</p>
1.78 rillig 7500: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7501: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7502: interaction such as entering username/password or accepting a
7503: license on a web page.</p></li>
1.88 wiz 7504: <li><p>When extracting the distfiles, some packages may ask for
7505: passwords.</p></li>
1.78 rillig 7506: <li><p>help to configure the package before it is built</p></li>
7507: <li><p>help during the build process</p></li>
7508: <li><p>help during the installation of a package</p></li>
7509: </ul></div>
1.88 wiz 7510: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7511: provided to notify the pkgsrc mechanism of an interactive stage
7512: which will be needed, and this should be set in the package's
7513: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7514: <pre class="programlisting">
1.87 wiz 7515: INTERACTIVE_STAGE= build
7516: </pre>
1.78 rillig 7517: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7518: <pre class="programlisting">
1.87 wiz 7519: INTERACTIVE_STAGE= configure install
7520: </pre>
1.88 wiz 7521: <p>The user can then decide to skip this package by setting the
7522: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7523: </div>
7524: <div class="sect2" lang="en">
7525: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7526: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.78 rillig 7527: <p>A package may be covered by a license which the user has
1.87 wiz 7528: or has not agreed to accept. For these cases, pkgsrc contains
7529: a mechanism to note that a package is covered by a particular
7530: license, and the package cannot be built unless the user has
7531: accepted the license. (Installation of binary packages are
7532: not currently subject to this mechanism.) Packages with
7533: licenses that are either Open Source according to the Open
7534: Source Initiative or Free according to the Free Software
7535: Foundation will not be marked with a license tag. Packages
7536: with licenses that have not been determined to meet either
7537: definition will be marked with a license tag referring to the
7538: license. This will prevent building unless pkgsrc is informed
7539: that the license is acceptable, and enables displaying the
7540: license.</p>
1.78 rillig 7541: <p>The license tag mechanism is intended to address
1.87 wiz 7542: copyright-related issues surrounding building, installing and
7543: using a package, and not to address redistribution issues (see
7544: <code class="varname">RESTRICTED</code> and
7545: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7546: definition of licenses for which tags are not needed implies
7547: that packages with redistribution restrictions should have
7548: tags.</p>
7549: <p>Denoting that a package is covered by a particular license
7550: is done by placing the license in
7551: <code class="filename">pkgsrc/licenses</code> and setting the
7552: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 ! rillig 7553: 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 7554: <pre class="programlisting">
7555: LICENSE= xv-license
7556: </pre>
7557: <p>When trying to build, the user will get a notice that the
7558: package is covered by a license which has not been
7559: accepted:</p>
7560: <pre class="programlisting">
7561: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7562: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7563: ===> To view the license, enter "/usr/bin/make show-license".
7564: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7565: ===> ACCEPTABLE_LICENSES+=xv-license
7566: *** Error code 1
7567: </pre>
1.78 rillig 7568: <p>The license can be viewed with <span><strong class="command">make
1.87 wiz 7569: show-license</strong></span>, and if it is considered appropriate,
7570: the line printed above can be added to
7571: <code class="filename">/etc/mk.conf</code> to indicate acceptance of
7572: the particular license:</p>
1.78 rillig 7573: <pre class="programlisting">
1.87 wiz 7574: ACCEPTABLE_LICENSES+=xv-license
7575: </pre>
1.78 rillig 7576: <p>When adding a package with a new license, the license
1.87 wiz 7577: text should be added to <code class="filename">pkgsrc/licenses</code>
7578: for displaying. A list of known licenses can be seen in this
1.91 ! rillig 7579: directory.</p>
1.78 rillig 7580: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.87 wiz 7581: <code class="varname">LICENSE=no-commercial-use</code>, and similar
7582: language is deprecated because it does not crisply refer to
7583: a particular license text. Another problem with such usage
7584: is that it does not enable a user to denote acceptance of
7585: the license for a single package without accepting the same
7586: license text for another package. In particular, this can
7587: be inappropriate when e.g. one accepts a particular license to
7588: indicate to pkgsrc that a fee has been paid.</p>
1.75 rillig 7589: </div>
7590: <div class="sect2" lang="en">
7591: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7592: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7593: <p>Some licenses restrict how software may be re-distributed.
1.87 wiz 7594: In order to satisfy these restrictions, the package system
7595: defines five make variables that can be set to note these
7596: restrictions:</p>
1.75 rillig 7597: <div class="itemizedlist"><ul type="disc">
7598: <li>
7599: <p><code class="varname">RESTRICTED</code></p>
7600: <p>This variable should be set whenever a restriction
1.87 wiz 7601: exists (regardless of its kind). Set this variable to a
7602: string containing the reason for the restriction.</p>
1.75 rillig 7603: </li>
7604: <li>
7605: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7606: <p>Binaries may not be placed on CD-ROM. Set this
1.87 wiz 7607: variable to <code class="varname">${RESTRICTED}</code> whenever a
7608: binary package may not be included on a CD-ROM.</p>
1.75 rillig 7609: </li>
7610: <li>
7611: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7612: <p>Binaries may not be placed on an FTP server. Set
1.87 wiz 7613: this variable to <code class="varname">${RESTRICTED}</code>
7614: whenever a binary package may not not be made available
7615: on the Internet.</p>
1.75 rillig 7616: </li>
7617: <li>
7618: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7619: <p>Distfiles may not be placed on CD-ROM. Set this
1.87 wiz 7620: variable to <code class="varname">${RESTRICTED}</code> if
7621: re-distribution of the source code or other distfile(s) is
7622: not allowed on CD-ROMs.</p>
1.75 rillig 7623: </li>
7624: <li>
7625: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7626: <p>Distfiles may not be placed on FTP. Set this variable
1.87 wiz 7627: to <code class="varname">${RESTRICTED}</code> if re-distribution of
7628: the source code or other distfile(s) via the Internet is not
7629: allowed. If this variable is not set, the distfile(s) will
7630: be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7631: </li>
7632: </ul></div>
7633: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87 wiz 7634: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7635: generic make variables to denote restrictions is deprecated,
7636: because they unconditionally prevent users from generating
7637: binary packages!</p>
1.75 rillig 7638: </div>
7639: <div class="sect2" lang="en">
7640: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7641: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7642: <p>Your package may depend on some other package being present
1.88 wiz 7643: - and there are various ways of expressing this dependency.
7644: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7645: <code class="varname">DEPENDS</code> definitions, the
7646: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7647: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7648: to handle dependencies, and which uses the variables named above.
1.90 rillig 7649: See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7650: <p>The basic difference between the two variables is as
1.87 wiz 7651: follows: The <code class="varname">DEPENDS</code> definition registers
7652: that pre-requisite in the binary package so it will be pulled in
7653: when the binary package is later installed, whilst the
7654: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7655: dependency that is only needed for building the package.</p>
1.75 rillig 7656: <p>This means that if you only need a package present whilst
1.87 wiz 7657: you are building, it should be noted as a
7658: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7659: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7660: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7661: <pre class="programlisting">
1.87 wiz 7662: <pre-req-package-name>:../../<category>/<pre-req-package>
7663: </pre>
1.75 rillig 7664: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7665: may include any of the wildcard version numbers recognized by
7666: <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 7667: <div class="orderedlist"><ol type="1">
7668: <li>
7669: <p>If your package needs another package's binaries or
1.87 wiz 7670: libraries to build or run, and if that package has a
7671: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7672: <pre class="programlisting">
1.87 wiz 7673: .include "../../graphics/jpeg/buildlink3.mk"
7674: </pre>
1.75 rillig 7675: </li>
7676: <li>
7677: <p>If your package needs to use another package to build
1.87 wiz 7678: itself and there is no <code class="filename">buildlink3.mk</code>
7679: file available, use the <code class="varname">BUILD_DEPENDS</code>
7680: definition:</p>
1.75 rillig 7681: <pre class="programlisting">
1.87 wiz 7682: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
7683: </pre>
1.75 rillig 7684: </li>
7685: <li>
7686: <p>If your package needs a library with which to link and
1.76 rillig 7687: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7688: available, this is specified using the
7689: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7690: <pre class="programlisting">
1.87 wiz 7691: DEPENDS+= xpm-3.4j:../../graphics/xpm
7692: </pre>
1.75 rillig 7693: <p>You can also use wildcards in package dependences:</p>
7694: <pre class="programlisting">
1.87 wiz 7695: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
7696: </pre>
1.75 rillig 7697: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7698: creating binary packages. The dependency is checked when
7699: installing the binary package and any package which matches
7700: the pattern will be used. Wildcard dependencies should be
7701: used with care.</p>
1.75 rillig 7702: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7703: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7704: such as “<span class="quote">tk-postgresql</span>” matching a
7705: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7706: <p>Wildcards can also be used to specify that a package
1.87 wiz 7707: will only build against a certain minimum version of a
7708: pre-requisite:</p>
1.75 rillig 7709: <pre class="programlisting">
1.87 wiz 7710: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
7711: </pre>
1.75 rillig 7712: <p>This means that the package will build against version
1.87 wiz 7713: 3.5.4 of the tiff library or newer. Such a dependency may
7714: be warranted if, for example, the API of the library has
7715: changed with version 3.5.4 and a package would not compile
7716: against an earlier version of tiff.</p>
1.75 rillig 7717: <p>Please note that such dependencies should only be
1.87 wiz 7718: updated if a package requires a newer pre-requisite, but
7719: not to denote recommendations such as
7720: ABI changes that do not prevent a package from building
7721: correctly. Such recommendations can be expressed using
7722: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7723: <pre class="programlisting">
1.87 wiz 7724: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
7725: </pre>
1.75 rillig 7726: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7727: line, this denotes that while a package will build against
7728: tiff>=3.5.4, at least version 3.6.1 is recommended.
7729: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7730: dependencies unless explicitly ignored (in which case a
7731: warning will be printed).</p>
1.75 rillig 7732: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7733: use the required <code class="varname">DEPENDS</code>, set
7734: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7735: it easier and faster to update packages built using pkgsrc,
7736: since older compatible dependencies can continue to be
7737: used. This is useful for people who watch their rebuilds
7738: very carefully; it is not very good as a general-purpose
7739: hammer. If you use it, you need to be mindful of possible
7740: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7741: <p>Packages that are built with recommendations ignored
1.87 wiz 7742: may not be uploaded to ftp.NetBSD.org by developers and
7743: should not be used across different systems that may have
7744: different versions of binary packages installed.</p>
1.75 rillig 7745: <p>For security fixes, please update the package
1.90 rillig 7746: 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 7747: information.</p>
1.75 rillig 7748: </li>
7749: <li>
7750: <p>If your package needs some executable to be able to run
1.87 wiz 7751: correctly and if there's no
7752: <code class="filename">buildlink3.mk</code> file, this is specified
7753: using the <code class="varname">DEPENDS</code> variable. The
1.91 ! rillig 7754: <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 7755: be able to execute the latex binary from the teTeX package
7756: when it runs, and that is specified:</p>
1.75 rillig 7757: <pre class="programlisting">
1.87 wiz 7758: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
7759: </pre>
1.75 rillig 7760: <p>The comment about wildcard dependencies from previous
1.87 wiz 7761: paragraph applies here, too.</p>
1.75 rillig 7762: </li>
7763: </ol></div>
7764: <p>If your package needs files from another package to build,
1.87 wiz 7765: add the relevant distribution files to
7766: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 ! rillig 7767: 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 7768: (It relies on the jpeg sources being present in source form
7769: during the build.)</p>
1.88 wiz 7770: <p>Please also note the
7771: <code class="varname">BUILD_USES_GETTEXT_M4</code> definition, which is
7772: provided as convenience definition. It adds a build dependency on
7773: either an installed version of an older gettext package, or if it
1.91 ! rillig 7774: 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 7775: </div>
7776: <div class="sect2" lang="en">
7777: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7778: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7779: <p>Your package may conflict with other packages a user might
1.87 wiz 7780: already have installed on his system, e.g. if your package
1.88 wiz 7781: installs the same set of files as another package in the pkgsrc
7782: tree.</p>
1.75 rillig 7783: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7784: space-separated list of packages (including version string) your
7785: package conflicts with.</p>
1.91 ! rillig 7786: <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>
! 7787: 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 7788: install the same shared library, thus you set in
7789: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7790: <pre class="programlisting">
7791: CONFLICTS= Xaw-Xpm-[0-9]*
7792: </pre>
7793: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 7794: <pre class="programlisting">
1.87 wiz 7795: CONFLICTS= Xaw3d-[0-9]*
7796: </pre>
1.75 rillig 7797: <p>Packages will automatically conflict with other packages
1.87 wiz 7798: with the name prefix and a different version
7799: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
7800: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 7801: </div>
7802: <div class="sect2" lang="en">
7803: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7804: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7805: <p>There are several reasons why a package might be
1.88 wiz 7806: instructed to not build under certain circumstances. If the
1.87 wiz 7807: package builds and runs on most platforms, the exceptions
7808: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7809: the package builds and runs on a small handful of platforms,
7810: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
7811: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7812: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7813: (OS-version-platform) that can use glob-style
7814: wildcards.</p>
1.88 wiz 7815: <p>Some packages are tightly bound to a specific version of an
1.91 ! rillig 7816: 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 7817: backwards compatible with other versions of the OS, and should be
7818: uploaded to a version specific directory on the FTP server. Mark
7819: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
7820: “<span class="quote">yes</span>”. This variable is not currently used by any of
7821: the package system internals, but may be used in the
7822: future.</p>
1.75 rillig 7823: <p>If the package should be skipped (for example, because it
1.87 wiz 7824: provides functionality already provided by the system), set
1.88 wiz 7825: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7826: the package should fail because some preconditions are not met,
7827: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7828: message.</p>
1.75 rillig 7829: </div>
7830: <div class="sect2" lang="en">
7831: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7832: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7833: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7834: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7835: be set in the package Makefile. This will be carried into any
7836: binary package that is made from this pkgsrc entry. A
7837: “<span class="quote">preserved</span>” package will
7838: 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
7839: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 7840: </div>
7841: <div class="sect2" lang="en">
7842: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7843: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7844: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7845: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
7846: and after committing that file, use <span><strong class="command">make upload</strong></span>
7847: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 7848: <p>After fixing the vulnerability by a patch, its
1.87 wiz 7849: <code class="varname">PKGREVISION</code> should be increased (this
7850: is of course not necessary if the problem is fixed by using
7851: a newer release of the software).</p>
1.75 rillig 7852: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7853: branch, be sure to submit a pullup request!</p>
1.75 rillig 7854: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7855: semi-automatically by a weekly cron job.</p>
1.75 rillig 7856: </div>
7857: <div class="sect2" lang="en">
7858: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7859: <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 7860: <p>When making fixes to an existing package it can be useful
1.87 wiz 7861: to change the version number in <code class="varname">PKGNAME</code>. To
7862: avoid conflicting with future versions by the original author, a
7863: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
7864: on package versions by setting <code class="varname">PKGREVISION=1</code>
7865: (2, ...). The “<span class="quote">nb</span>” is treated like a
7866: “<span class="quote">.</span>” by the package tools. e.g.</p>
7867: <pre class="programlisting">
7868: DISTNAME= foo-17.42
7869: PKGREVISION= 9
7870: </pre>
1.75 rillig 7871: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 7872: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
7873: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
7874: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7875: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7876: <p>When a new release of the package is released, the
1.87 wiz 7877: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7878: minor release of the above package, things should be like:</p>
1.75 rillig 7879: <pre class="programlisting">
1.87 wiz 7880: DISTNAME= foo-17.43
7881: </pre>
7882: <p><code class="varname">PKGREVISION</code> should be incremented for any
7883: non-trivial change in the resulting binary package. Without a
7884: <code class="varname">PKGREVISION</code> bump, someone with the previous
7885: version installed has no way of knowing that their package is out
7886: of date. Thus, changes without increasing
7887: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7888: trivial that no reasonable person would want to upgrade", and this
7889: is the rough test for when increasing
7890: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7891: changes that do not merit increasing
7892: <code class="varname">PKGREVISION</code> are:</p>
7893: <pre class="programlisting">
7894: Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
7895: or comments in Makefile.
7896: Changing build variables if the resulting binary package is the same.
7897: Changing <code class="filename">DESCR</code>.
7898: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.
7899: </pre>
7900: <p>Examples of changes that do merit an increase to
7901: <code class="varname">PKGREVISION</code> include:</p>
7902: <pre class="programlisting">
7903: Security fixes
7904: Changes or additions to a patch file
7905: Changes to the <code class="filename">PLIST</code>
7906: </pre>
1.78 rillig 7907: <p>PKGREVISION must also be incremented when dependencies have ABI
7908: changes.</p>
1.75 rillig 7909: </div>
1.79 rillig 7910: <div class="sect2" lang="en">
7911: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7912: <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 7913: <p>When you want to replace the same text in multiple files
1.87 wiz 7914: or when the replacement text varies, patches alone cannot help.
7915: This is where the SUBST framework comes in. It provides an
7916: easy-to-use interface for replacing text in files.
7917: Example:</p>
7918: <pre class="programlisting">
7919: SUBST_CLASSES+= fix-paths
7920: SUBST_STAGE.fix-paths= pre-configure
7921: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7922: SUBST_FILES.fix-paths= src/*.c
7923: SUBST_FILES.fix-paths+= scripts/*.sh
7924: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7925: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7926: </pre>
1.79 rillig 7927: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 7928: that are used to identify the different SUBST blocks that are
7929: defined. The SUBST framework is heavily used by pkgsrc, so it is
7930: important to always use the <code class="literal">+=</code> operator with
7931: this variable. Otherwise some substitutions may be
7932: skipped.</p>
1.79 rillig 7933: <p>The remaining variables of each SUBST block are
1.87 wiz 7934: parameterized with the identifier from the first line
7935: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7936: parameters to a function call.</p>
1.79 rillig 7937: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 7938: which the replacement will take place. All combinations of
7939: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7940: <code class="literal">post-</code> together with a phase name are
7941: possible, though only few are actually used. Most commonly used
7942: are <code class="literal">post-patch</code> and
7943: <code class="literal">pre-configure</code>. Of these two,
7944: <code class="literal">pre-configure</code> should be preferred because
7945: then it is possible to run <span><strong class="command">bmake patch</strong></span> and
7946: have the state after applying the patches but before making any
7947: other changes. This is especially useful when you are debugging
7948: a package in order to create new patches for it. Similarly,
7949: <code class="literal">post-build</code> is preferred over
7950: <code class="literal">pre-install</code>, because the install phase should
7951: generally be kept as simple as possible. When you use
7952: <code class="literal">post-build</code>, you have the same files in the
7953: working directory that will be installed later, so you can check
7954: if the substitution has succeeded.</p>
1.79 rillig 7955: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 7956: that is printed just before the substitution is done.</p>
1.79 rillig 7957: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 7958: globbing patterns that specifies the files in which the
7959: substitution will take place. The patterns are interpreted
7960: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 7961: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87 wiz 7962: <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
7963: command should be prefixed with <code class="literal">-e</code>, so that
7964: all SUBST blocks look uniform.</p>
1.79 rillig 7965: <p>There are some more variables, but they are so seldomly
1.87 wiz 7966: used that they are only documented in the
7967: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 7968: </div>
1.75 rillig 7969: </div>
7970: <div class="sect1" lang="en">
7971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7972: <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 7973: <div class="sect2" lang="en">
7974: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7975: <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 7976: <p>If you need to download from a dynamic URL you can set
1.87 wiz 7977: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
7978: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7979: with the name of each file to download as an argument, expecting
7980: it to output the URL of the directory from which to download
1.91 ! rillig 7981: 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 7982: example of this usage.</p>
1.75 rillig 7983: <p>If the download can't be automated, because the user must
1.87 wiz 7984: submit personal information to apply for a password, or must pay
7985: for the source, or whatever, you can set
7986: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7987: displayed to the user before aborting the build. Example:</p>
7988: <pre class="programlisting">
7989: FETCH_MESSAGE= "Please download the files"
7990: FETCH_MESSAGE+= " "${DISTFILES:Q}
7991: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
7992: </pre>
1.75 rillig 7993: </div>
7994: <div class="sect2" lang="en">
7995: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7996: <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 7997: <p>Sometimes authors of a software package make some
1.87 wiz 7998: modifications after the software was released, and they put up a
7999: new distfile without changing the package's version number. If a
8000: package is already in pkgsrc at that time, the checksum will
8001: no longer match. The contents of the new distfile should be
8002: compared against the old one before changing anything, to make
8003: sure the distfile was really updated on purpose, and that
8004: no trojan horse or so crept in.
8005: Then, the correct way to work around this is to
8006: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8007: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8008: <code class="varname">DISTFILES</code> and
8009: <code class="varname">PATCHFILES</code> for this package will be put in that
8010: subdirectory of the local distfiles directory. In case this
8011: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8012: including the <code class="filename">nbX</code> suffix) or a date stamp
8013: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8014: Do not forget regenerating the <code class="filename">distinfo</code> file
8015: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8016: path in the filenames.
8017: Furthermore, a mail to the package's authors seems appropriate
8018: telling them that changing distfiles after releases without
8019: changing the file names is not good practice.</p>
1.75 rillig 8020: </div>
8021: </div>
8022: <div class="sect1" lang="en">
8023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8024: <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 8025: <div class="sect2" lang="en">
8026: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8027: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8028: <p>pkgsrc supports many different machines, with different
1.87 wiz 8029: object formats like a.out and ELF, and varying abilities to do
8030: shared library and dynamic loading at all. To accompany this,
8031: varying commands and options have to be passed to the
8032: compiler, linker, etc. to get the Right Thing, which can be
8033: pretty annoying especially if you don't have all the machines
8034: at your hand to test things. The
1.91 ! rillig 8035: <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 8036: can help here, as it just “<span class="quote">knows</span>” how to build
8037: both static and dynamic libraries from a set of source files,
8038: thus being platform-independent.</p>
8039: <p>Here's how to use libtool in a package in seven simple
8040: steps:</p>
1.75 rillig 8041: <div class="orderedlist"><ol type="1">
8042: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8043: Makefile.</p></li>
1.75 rillig 8044: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8045: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8046: add it to the definition of <code class="varname">CC</code>, if only
8047: libraries are being built in a given Makefile. This one command
8048: will build both PIC and non-PIC library objects, so you need not
8049: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8050: <li>
8051: <p>For the linking of the library, remove any
1.87 wiz 8052: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8053: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8054: <pre class="programlisting">
1.87 wiz 8055: ${LIBTOOL} --mode=link ${CC} -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} \
8056: -rpath ${PREFIX}/lib -version-info major:minor
8057: </pre>
1.75 rillig 8058: <p>Note that the library is changed to have a
1.87 wiz 8059: <code class="filename">.la</code> extension, and the objects are
8060: changed to have a <code class="filename">.lo</code>
8061: extension. Change <code class="varname">OBJS</code> as
8062: necessary. This automatically creates all of the
8063: <code class="filename">.a</code>,
8064: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8065: necessary) in the build directory. Be sure to include
8066: “<span class="quote">-version-info</span>”, especially when major and
8067: minor are zero, as libtool will otherwise strip off the
8068: shared library version.</p>
1.75 rillig 8069: <p>From the libtool manual:</p>
8070: <pre class="programlisting">
1.87 wiz 8071: So, libtool library versions are described by three integers:
1.69 rillig 8072:
1.87 wiz 8073: CURRENT
8074: The most recent interface number that this library implements.
1.69 rillig 8075:
1.87 wiz 8076: REVISION
8077: The implementation number of the CURRENT interface.
1.69 rillig 8078:
1.87 wiz 8079: AGE
8080: The difference between the newest and oldest interfaces that
8081: this library implements. In other words, the library implements
8082: all the interface numbers in the range from number `CURRENT -
8083: AGE' to `CURRENT'.
1.1 grant 8084:
1.87 wiz 8085: If two libraries have identical CURRENT and AGE numbers, then the
8086: dynamic linker chooses the library with the greater REVISION number.
8087: </pre>
1.75 rillig 8088: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8089: different results for a.out and ELF (excluding symlinks)
8090: in only one case. An ELF library of the form
8091: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8092: will have a symlink of
8093: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8094: on an a.out platform. This is handled
8095: automatically.</p>
1.75 rillig 8096: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8097: directory of the library being built.</p>
1.76 rillig 8098: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8099: <code class="filename">.la</code> file, the other files will be
8100: added automatically.</p>
1.75 rillig 8101: </li>
8102: <li>
1.76 rillig 8103: <p>When linking shared object (<code class="filename">.so</code>)
1.87 wiz 8104: 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
8105: shared libraries, use “<span class="quote">-module
8106: -avoid-version</span>” to prevent them getting version
8107: tacked on.</p>
1.76 rillig 8108: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8109: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8110: </li>
8111: <li>
8112: <p>When linking programs that depend on these libraries
1.87 wiz 8113: <span class="emphasis"><em>before</em></span> they are installed, preface
8114: 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}
8115: --mode=link</span>”, and it will find the correct
8116: libraries (static or shared), but please be aware that
8117: libtool will not allow you to specify a relative path in
8118: -L (such as “<span class="quote">-L../somelib</span>”), because it
8119: expects you to change that argument to be the
8120: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8121: <pre class="programlisting">
1.87 wiz 8122: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8123: </pre>
1.75 rillig 8124: <p>should be changed to:</p>
8125: <pre class="programlisting">
1.87 wiz 8126: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8127: </pre>
1.75 rillig 8128: <p>and it will do the right thing with the libraries.</p>
8129: </li>
8130: <li>
8131: <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 8132: 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}
8133: --mode=install</span>”, and change the library name to
8134: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8135: <pre class="programlisting">
1.87 wiz 8136: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
8137: </pre>
1.76 rillig 8138: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8139: shared library, any needed symlinks, and run
8140: <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 8141: </li>
1.76 rillig 8142: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8143: the <code class="filename">.la</code>
8144: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8145: </ol></div>
8146: </div>
8147: <div class="sect2" lang="en">
8148: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8149: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8150: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8151: package Makefile. This will override the package's own libtool
8152: in most cases. For older libtool using packages, libtool is
8153: made by ltconfig script during the do-configure step; you can
8154: check the libtool script location by doing <span><strong class="command">make
8155: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8156: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8157: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8158: default, it is set to “<span class="quote">libtool */libtool
8159: */*/libtool</span>”. If this does not match the location of the
8160: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8161: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8162: libraries built and installed, then use
8163: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8164: <p>If your package makes use of the platform-independent library
1.87 wiz 8165: for loading dynamic shared objects, that comes with libtool
8166: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8167: <p>Some packages use libtool incorrectly so that the package
8168: may not work or build in some circumstances. Some of the more
8169: common errors are:</p>
1.75 rillig 8170: <div class="itemizedlist"><ul type="disc">
8171: <li>
8172: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8173: executable or library. This in itself isn't a problem if one of two things
8174: has been done:</p>
1.75 rillig 8175: <div class="orderedlist"><ol type="1">
8176: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8177: <code class="filename">libfoo.la</code>, not
8178: <code class="filename">foo.la</code></p></li>
1.75 rillig 8179: <li><p>The -dlopen option is used when linking an executable.</p></li>
8180: </ol></div>
8181: </li>
8182: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8183: The function lt_dlinit() should be called and the macro
8184: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8185: executables.</p></li>
1.75 rillig 8186: </ul></div>
8187: </div>
8188: <div class="sect2" lang="en">
8189: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8190: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8191: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8192: to regenerate the configure script and Makefile.in makefile
8193: templates, then they should be executed in a pre-configure
8194: target.</p>
1.75 rillig 8195: <p>For packages that need only autoconf:</p>
8196: <pre class="programlisting">
1.87 wiz 8197: AUTOCONF_REQD= 2.50 # if default version is not good enough
8198: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8199: ...
1.1 grant 8200:
1.87 wiz 8201: pre-configure:
8202: cd ${WRKSRC}; autoconf
1.1 grant 8203:
1.87 wiz 8204: ...
8205: </pre>
1.75 rillig 8206: <p>and for packages that need automake and autoconf:</p>
8207: <pre class="programlisting">
1.87 wiz 8208: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8209: USE_TOOLS+= automake # use "automake14" for automake-1.4
8210: ...
8211:
8212: pre-configure:
8213: cd ${WRKSRC}; \
8214: aclocal; autoheader; \
8215: automake -a --foreign -i; autoconf
1.1 grant 8216:
1.87 wiz 8217: ...
8218: </pre>
1.75 rillig 8219: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8220: require GNU Make.</p>
1.75 rillig 8221: <p>There are times when the configure process makes
1.87 wiz 8222: additional changes to the generated files, which then causes
8223: the build process to try to re-execute the automake sequence.
8224: This is prevented by touching various files in the configure
8225: stage. If this causes problems with your package you can set
8226: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8227: Makefile.</p>
1.75 rillig 8228: </div>
8229: </div>
8230: <div class="sect1" lang="en">
8231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8232: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87 wiz 8233: <div class="sect2" lang="en">
8234: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8235: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8236: <p>Compilers for the C, C++, and Fortran languages comes with
8237: the NetBSD base system. By default, pkgsrc assumes that a package
8238: is written in C and will hide all other compilers (via the wrapper
1.90 rillig 8239: framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8240: <p>To declare which language's compiler a package needs, set
8241: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8242: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8243: “<span class="quote">fortran</span>” (and any combination). The default is
8244: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8245: written in C++, usually need a C compiler for the configure
8246: phase.</p>
8247: </div>
8248: <div class="sect2" lang="en">
8249: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8250: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87 wiz 8251: <p>If a program is written in Java, use the Java framework in
8252: pkgsrc. The package must include
8253: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8254: provides the following variables:</p>
8255: <div class="itemizedlist"><ul type="disc">
8256: <li><p><code class="varname">USE_JAVA</code> defines if a build
8257: dependency on the JDK is added. If
8258: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8259: there is only a runtime dependency on the JDK. The default is
8260: “<span class="quote">yes</span>”, which also adds a build dependency on the
8261: JDK.</p></li>
8262: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8263: a package needs a Java2 implementation. The supported values
8264: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8265: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8266: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8267: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8268: above. This variable is not set by default.</p></li>
8269: </ul></div>
8270: </div>
8271: <div class="sect2" lang="en">
8272: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8273: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8274: <p>If your package contains interpreted perl scripts, add
8275: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8276: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8277: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8278: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8279: that you want adjusted. Every occurrence of
8280: <code class="filename">*/bin/perl</code> will be replaced with the full
8281: path to the perl executable.</p>
8282: <p>If a particular version of perl is needed, set the
8283: <code class="varname">PERL5_REQD</code> variable to the version number. The
8284: default is “<span class="quote">5.0</span>”.</p>
1.90 rillig 8285: <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 8286: about handling perl modules.</p>
8287: </div>
8288: <div class="sect2" lang="en">
8289: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8290: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8291: <p>Currently, there is no special handling for other languages
8292: in pkgsrc. If a compiler package provides a
8293: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8294: just add a (build) dependency on the appropriate compiler
8295: package.</p>
8296: </div>
8297: </div>
8298: <div class="sect1" lang="en">
8299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8300: <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 8301: <p>The most common failures when building a package are that
8302: some platforms do not provide certain header files, functions or
8303: libraries, or they provide the functions in a library that the
8304: original package author didn't know. To work around this, you
8305: can rewrite the source code in most cases so that it does not
8306: use the missing functions or provides a replacement function.</p>
8307: <div class="sect2" lang="en">
8308: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8309: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8310: <p>If a package already comes with a GNU configure script, the
8311: preferred way to fix the build failure is to change the
8312: configure script, not the code. In the other cases, you can
8313: utilize the C preprocessor, which defines certain macros
8314: depending on the operating system and hardware architecture it
8315: compiles for. These macros can be queried using for example
8316: <code class="varname">#if defined(__i386)</code>. Almost every operating
8317: system, hardware architecture and compiler has its own macro.
8318: For example, if the macros <code class="varname">__GNUC__</code>,
8319: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8320: are all defined, you know that you are using NetBSD on an i386
8321: compatible CPU, and your compiler is GCC.</p>
8322: <p>The list of the following macros for hardware and
8323: operating system depends on the compiler that is used. For
8324: example, if you want to conditionally compile code on Solaris,
8325: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8326: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8327: <div class="sect3" lang="en">
8328: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8329: <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 8330: <p>To distinguish between 4.4 BSD-derived systems and the
8331: rest of the world, you should use the following code.</p>
8332: <pre class="programlisting">
8333: #include <sys/param.h>
8334: #if (defined(BSD) && BSD >= 199306)
8335: /* BSD-specific code goes here */
8336: #else
8337: /* non-BSD-specific code goes here */
8338: #endif
8339: </pre>
1.77 rillig 8340: <p>If this distinction is not fine enough, you can also test
8341: for the following macros.</p>
1.75 rillig 8342: <pre class="programlisting">
8343: FreeBSD __FreeBSD__
8344: DragonFly __DragonFly__
8345: Interix __INTERIX
8346: Linux linux, __linux, __linux__
8347: NetBSD __NetBSD__
8348: OpenBSD __OpenBSD__
8349: Solaris sun, __sun
8350: </pre>
8351: </div>
8352: <div class="sect3" lang="en">
8353: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8354: <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 8355: <pre class="programlisting">
8356: i386 i386, __i386, __i386__
8357: MIPS __mips
8358: SPARC sparc, __sparc
8359: </pre>
8360: </div>
8361: <div class="sect3" lang="en">
8362: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8363: <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 8364: <pre class="programlisting">
8365: GCC __GNUC__ (major version), __GNUC_MINOR__
8366: SunPro __SUNPRO_C (0x570 for version 5.7)
1.81 rillig 8367: SunPro C++ __SUNPRO_CC (0x580 for version 5.8)
1.75 rillig 8368: </pre>
8369: </div>
8370: </div>
1.78 rillig 8371: <div class="sect2" lang="en">
8372: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8373: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8374: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8375: combinations of compiler version and architecture and almost
8376: always relation to optimisation being enabled. Common symptoms
8377: are gcc internal errors or never finishing compiling a
1.78 rillig 8378: file.</p>
8379: <p>Typically, a workaround involves testing the
8380: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8381: optimisation for that combination of file,
8382: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8383: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8384: number of examples.</p>
8385: </div>
8386: <div class="sect2" lang="en">
8387: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8388: <a name="undefined-reference"></a>18.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.78 rillig 8389: <p>This compiler error often means that a package did not
8390: link to a shared library it needs. The following functions are
8391: known to cause this error message over and over.</p>
8392: <div class="informaltable">
8393: <a name="undefined-reference-functions"></a><table border="1">
8394: <colgroup>
8395: <col>
8396: <col>
8397: <col>
8398: </colgroup>
8399: <thead><tr>
8400: <th>Function</th>
8401: <th>Library</th>
8402: <th>Affected platforms</th>
8403: </tr></thead>
8404: <tbody>
8405: <tr>
8406: <td>accept, bind, connect</td>
8407: <td>-lsocket</td>
8408: <td>Solaris</td>
8409: </tr>
8410: <tr>
8411: <td>crypt</td>
8412: <td>-lcrypt</td>
8413: <td>DragonFly, NetBSD</td>
8414: </tr>
8415: <tr>
8416: <td>dlopen, dlsym</td>
8417: <td>-ldl</td>
8418: <td>Linux</td>
8419: </tr>
8420: <tr>
8421: <td>gethost*</td>
8422: <td>-lnsl</td>
8423: <td>Solaris</td>
8424: </tr>
8425: <tr>
8426: <td>inet_aton</td>
8427: <td>-lresolv</td>
8428: <td>Solaris</td>
8429: </tr>
8430: <tr>
8431: <td>nanosleep, sem_*, timer_*</td>
8432: <td>-lrt</td>
8433: <td>Solaris</td>
8434: </tr>
8435: <tr>
8436: <td>openpty</td>
8437: <td>-lutil</td>
8438: <td>Linux</td>
8439: </tr>
8440: </tbody>
8441: </table>
8442: </div>
8443: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8444: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8445: -l<em class="replaceable"><code>foo</code></em></code> to the package
8446: <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
8447: bmake</strong></span>.</p>
8448: </div>
8449: <div class="sect2" lang="en">
8450: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8451: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8452: <p>Sometimes packages fail to build because the compiler runs
8453: into an operating system specific soft limit. With the
8454: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8455: to unlimit the resources. Currently, the allowed values are
8456: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8457: Setting this variable is similar to running the shell builtin
8458: <span><strong class="command">ulimit</strong></span> command to raise the maximum data
8459: segment size or maximum stack size of a process, respectively, to
8460: their hard limits.</p>
1.78 rillig 8461: </div>
1.75 rillig 8462: </div>
8463: <div class="sect1" lang="en">
8464: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8465: <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 8466: <div class="sect2" lang="en">
8467: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8468: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78 rillig 8469: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87 wiz 8470: with some operating systems cannot create more than one
8471: directory at a time. As such, you should call
8472: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8473: <pre class="programlisting">
8474: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8475: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8476: </pre>
1.78 rillig 8477: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8478: dir2</code></span>” to the
8479: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8480: automatically do the right thing.</p>
1.75 rillig 8481: </div>
8482: <div class="sect2" lang="en">
8483: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8484: <a name="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8485: <p>In general, documentation should be installed into
1.87 wiz 8486: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8487: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8488: includes the version number of the package).</p>
1.84 wiz 8489: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8490: directory where HTML documentation is installed with the
8491: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8492: is needed because otherwise the documentation ends up in
8493: <code class="filename">${PREFIX}/share/doc/html</code> or other
8494: places.</p>
8495: <p>An exception to the above is that library API documentation
1.91 ! rillig 8496: 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 8497: browsers (devhelp) should be left at their default location, which
8498: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8499: documentation can be recognized from files ending in
8500: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8501: (It is also acceptable to install such files in
8502: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8503: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8504: <code class="filename">.devhelp*</code> file must be directly in that
8505: directory then, no additional subdirectory level is allowed in
8506: this case. This is usually achieved by using
8507: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8508: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8509: though.)</p>
1.75 rillig 8510: </div>
8511: <div class="sect2" lang="en">
8512: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8513: <a name="installing-score-files"></a>18.6.3. Installing score files</h3></div></div></div>
1.75 rillig 8514: <p>Certain packages, most of them in the games category, install
1.87 wiz 8515: a score file that allows all users on the system to record their
8516: highscores. In order for this to work, the binaries need to be
8517: installed setgid and the score files owned by the appropriate
8518: group and/or owner (traditionally the "games" user/group). The
8519: following variables, documented in more detail in
8520: <code class="filename">mk/defaults/mk.conf</code>, control this
8521: behaviour: <code class="varname">SETGIDGAME</code>,
8522: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8523: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8524: <p>Note that per default, setgid installation of games is
1.87 wiz 8525: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8526: the other variables accordingly.</p>
1.75 rillig 8527: <p>A package should therefor never hard code file ownership or
1.87 wiz 8528: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8529: <code class="varname">INSTALL_GAME_DATA</code> to set these
8530: correctly.</p>
1.75 rillig 8531: </div>
8532: <div class="sect2" lang="en">
8533: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8534: <a name="hardcoded-paths"></a>18.6.4. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8535: <p>Your package may also contain scripts with hardcoded paths to
8536: other interpreters besides (or as well as) perl. To correct the
8537: full pathname to the script interpreter, you need to set the
8538: following definitions in your <code class="filename">Makefile</code> (we
8539: shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
8540: <pre class="programlisting">
8541: REPLACE_INTERPRETER+= tcl
8542: REPLACE.tcl.old= .*/bin/tclsh
8543: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8544: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8545: # relative to ${WRKSRC}, just as in REPLACE_PERL
8546: </pre>
1.75 rillig 8547: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8548: <h3 class="title">Note</h3>
8549: <p>Before March 2006, these variables were called
1.87 wiz 8550: <code class="varname">_REPLACE.*</code> and
8551: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8552: </div>
8553: </div>
8554: <div class="sect2" lang="en">
8555: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8556: <a name="perl-modules"></a>18.6.5. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8557: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8558: the Makefile fragment
8559: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
8560: <span><strong class="command">do-configure</strong></span> target for the standard perl
8561: configuration for such modules as well as various hooks to tune
8562: this configuration. See comments in this file for
8563: details.</p>
1.75 rillig 8564: <p>Perl5 modules will install into different places depending
1.87 wiz 8565: on the version of perl used during the build process. To
8566: address this, pkgsrc will append lines to the
8567: <code class="filename">PLIST</code> corresponding to the files listed in
8568: the installed <code class="filename">.packlist</code> file generated by
8569: most perl5 modules. This is invoked by defining
8570: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8571: paths to packlist files, e.g.:</p>
1.75 rillig 8572: <pre class="programlisting">
1.87 wiz 8573: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8574: </pre>
1.75 rillig 8575: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8576: <code class="varname">PERL5_SITEARCH</code>, and
8577: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8578: in which perl5 modules may be installed, and may be used by
8579: perl5 packages that don't have a packlist. These three
8580: variables are also substituted for in the
8581: <code class="filename">PLIST</code>.</p>
1.75 rillig 8582: </div>
8583: <div class="sect2" lang="en">
8584: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8585: <a name="faq.info-files"></a>18.6.6. Packages installing info files</h3></div></div></div>
1.75 rillig 8586: <p>Some packages install info files or use the
1.87 wiz 8587: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8588: commands. <code class="varname">INFO_FILES</code> should be defined in
8589: the package Makefile so that <code class="filename">INSTALL</code> and
8590: <code class="filename">DEINSTALL</code> scripts will be generated to
8591: handle registration of the info files in the Info directory
8592: file. The “<span class="quote">install-info</span>” command used for the info
8593: files registration is either provided by the system, or by a
8594: special purpose package automatically added as dependency if
8595: needed.</p>
1.75 rillig 8596: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8597: <code class="filename">${PREFIX}</code> where info files are primarily
8598: located. <code class="varname">PKGINFODIR</code> defaults to
8599: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8600: <p>The info files for the package should be listed in the
1.87 wiz 8601: package <code class="filename">PLIST</code>; however any split info files
8602: need not be listed.</p>
1.75 rillig 8603: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8604: at build time must add “<span class="quote">makeinfo</span>” to
8605: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8606: version of the “<span class="quote">makeinfo</span>” command is needed it
8607: should be noted with the <code class="varname">TEXINFO_REQD</code>
8608: variable in the package <code class="filename">Makefile</code>. By
8609: default, a minimum version of 3.12 is required. If the system
8610: does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
8611: does not match the required minimum, a build dependency on the
1.91 ! rillig 8612: <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 8613: be added automatically.</p>
1.75 rillig 8614: <p>The build and installation process of the software provided
1.87 wiz 8615: by the package should not use the
8616: <span><strong class="command">install-info</strong></span> command as the registration of
8617: info files is the task of the package
8618: <code class="filename">INSTALL</code> script, and it must use the
8619: appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75 rillig 8620: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87 wiz 8621: overriding scripts for the <span><strong class="command">install-info</strong></span> and
8622: <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
8623: in <code class="varname">PATH</code>.</p>
1.75 rillig 8624: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87 wiz 8625: no effect except the logging of a message. The script overriding
8626: <span><strong class="command">makeinfo</strong></span> logs a message and according to the
8627: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
8628: <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8629: </div>
8630: <div class="sect2" lang="en">
8631: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8632: <a name="manpages"></a>18.6.7. Packages installing man pages</h3></div></div></div>
1.81 rillig 8633: <p>All packages that install manual pages should install them
1.87 wiz 8634: into the same directory, so that there is one common place to look
8635: for them. In pkgsrc, this place is
8636: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8637: should be used in packages. The default for
8638: <code class="varname">PKGMANDIR</code> is
8639: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8640: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8641: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8642: <h3 class="title">Note</h3>
1.87 wiz 8643: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8644: is far from complete.</p>
1.75 rillig 8645: </div>
1.81 rillig 8646: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8647: <code class="filename">man/</code> as the top level directory for the man
8648: page file entries, and the pkgsrc framework will convert as
8649: needed. In all other places, the correct
8650: <code class="varname">PKGMANDIR</code> must be used.</p>
8651: <p>Packages that are
8652: configured with <code class="varname">GNU_CONFIGURE</code> set as
8653: “<span class="quote">yes</span>”, by default will use the
8654: <code class="filename">./configure</code>
8655: --mandir switch to set where the man pages should be installed.
8656: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8657: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8658: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8659: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8660: to “<span class="quote">no</span>”.
8661: Or if the <code class="filename">./configure</code> script uses
8662: a non-standard use of --mandir, you can set
8663: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90 rillig 8664: <p>See <a href="#manpage-compression" title="12.5. Man page compression">Section 12.5, “Man page compression”</a> for
1.87 wiz 8665: information on installation of compressed manual pages.</p>
1.75 rillig 8666: </div>
8667: <div class="sect2" lang="en">
8668: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8669: <a name="gconf2-data-files"></a>18.6.8. Packages installing GConf2 data files</h3></div></div></div>
1.87 wiz 8670: <p>If a package installs <code class="filename">.schemas</code> or
8671: <code class="filename">.entries</code> files, used by GConf2,
8672: you need to take some extra steps to make sure they get registered
8673: in the database:</p>
1.75 rillig 8674: <div class="orderedlist"><ol type="1">
1.76 rillig 8675: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87 wiz 8676: instead of its <code class="filename">buildlink3.mk</code> file. This
8677: takes care of rebuilding the GConf2 database at installation and
8678: deinstallation time, and tells the package where to install
8679: GConf2 data files using some standard configure arguments. It
8680: also disallows any access to the database directly from the
8681: package.</p></li>
1.75 rillig 8682: <li><p>Ensure that the package installs its
1.87 wiz 8683: <code class="filename">.schemas</code> files under
8684: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8685: installed under <code class="filename">${PREFIX}/etc</code>, you will
8686: need to manually patch the package.</p></li>
1.75 rillig 8687: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8688: directory, as they will be handled automatically. See
1.90 rillig 8689: <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 8690: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87 wiz 8691: your <code class="filename">Makefile</code> with a list of all
8692: <code class="filename">.schemas</code> files installed by the package, if
8693: any. Names must not contain any directories in them.</p></li>
1.75 rillig 8694: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87 wiz 8695: your <code class="filename">Makefile</code> with a
8696: list of all <code class="filename">.entries</code> files installed by the
8697: package, if any. Names must not contain any directories in
8698: them.</p></li>
1.75 rillig 8699: </ol></div>
8700: </div>
8701: <div class="sect2" lang="en">
8702: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8703: <a name="scrollkeeper-data-files"></a>18.6.9. Packages installing scrollkeeper data files</h3></div></div></div>
1.87 wiz 8704: <p>If a package installs <code class="filename">.omf</code> files, used by
8705: scrollkeeper, you need to take some extra steps to make sure they
8706: get registered in the database:</p>
1.75 rillig 8707: <div class="orderedlist"><ol type="1">
8708: <li><p>Include
1.87 wiz 8709: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
8710: instead of its <code class="filename">buildlink3.mk</code> file. This
8711: takes care of rebuilding the scrollkeeper database at
8712: installation and deinstallation time, and disallows any access
8713: to it directly from the package.</p></li>
1.75 rillig 8714: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 8715: <code class="filename">libdata/scrollkeeper</code> directory, as they
8716: will be handled automatically.</p></li>
1.76 rillig 8717: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87 wiz 8718: the PLIST. It will be handled by scrollkeeper.</p></li>
1.75 rillig 8719: </ol></div>
8720: </div>
8721: <div class="sect2" lang="en">
8722: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8723: <a name="x11-fonts"></a>18.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8724: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8725: the fonts database in the directory where they get installed at
8726: installation and deinstallation time. This can be automatically
8727: done by using the pkginstall framework.</p>
1.75 rillig 8728: <p>You can list the directories where fonts are installed in the
1.87 wiz 8729: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8730: variables, where <em class="replaceable"><code>type</code></em> can be one of
8731: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
8732: Also make sure that the database file
8733: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8734: <p>Note that you should not create new directories for fonts;
1.87 wiz 8735: instead use the standard ones to avoid that the user needs to
8736: manually configure his X server to find them.</p>
1.75 rillig 8737: </div>
8738: <div class="sect2" lang="en">
8739: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8740: <a name="gtk2-modules"></a>18.6.11. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8741: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8742: take some extra steps to get them registered in the GTK2 database
8743: properly:</p>
1.75 rillig 8744: <div class="orderedlist"><ol type="1">
8745: <li><p>Include
1.87 wiz 8746: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8747: <code class="filename">buildlink3.mk</code> file. This takes care of
8748: rebuilding the database at installation and deinstallation time.</p></li>
8749: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
8750: your package installs GTK2 immodules.</p></li>
8751: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
8752: GTK2 loaders.</p></li>
1.75 rillig 8753: <li>
1.87 wiz 8754: <p>Patch the package to not touch any of the GTK2
8755: databases directly. These are:</p>
1.75 rillig 8756: <div class="itemizedlist"><ul type="disc">
1.76 rillig 8757: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8758: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8759: </ul></div>
8760: </li>
1.87 wiz 8761: <li><p>Check the <code class="filename">PLIST</code> and remove
8762: any entries under the <code class="filename">libdata/gtk-2.0</code>
8763: directory, as they will be handled automatically.</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="sgml-xml-data"></a>18.6.12. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8769: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8770: registered in system-wide catalogs (like DTDs, sub-catalogs,
8771: etc.), you need to take some extra steps:</p>
1.75 rillig 8772: <div class="orderedlist"><ol type="1">
8773: <li><p>Include
1.87 wiz 8774: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8775: your <code class="filename">Makefile</code>, which takes care of
8776: registering those files in system-wide catalogs at
8777: installation and deinstallation time.</p></li>
1.75 rillig 8778: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 8779: any SGML catalogs installed by the package.</p></li>
1.75 rillig 8780: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 8781: any XML catalogs installed by the package.</p></li>
1.75 rillig 8782: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 8783: to be added to the SGML catalog. These come in groups of
8784: three strings; see xmlcatmgr(1) for more information
8785: (specifically, arguments recognized by the 'add' action).
8786: Note that you will normally not use this variable.</p></li>
1.75 rillig 8787: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 8788: to be added to the XML catalog. These come in groups of three
8789: strings; see xmlcatmgr(1) for more information (specifically,
8790: arguments recognized by the 'add' action). Note that you will
8791: normally not use this variable.</p></li>
1.75 rillig 8792: </ol></div>
8793: </div>
8794: <div class="sect2" lang="en">
8795: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8796: <a name="mime-database"></a>18.6.13. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 8797: <p>If a package provides extensions to the MIME database by
1.87 wiz 8798: installing <code class="filename">.xml</code> files inside
8799: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8800: need to take some extra steps to ensure that the database is kept
8801: consistent with respect to these new files:</p>
1.75 rillig 8802: <div class="orderedlist"><ol type="1">
8803: <li><p>Include
1.87 wiz 8804: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8805: (avoid using the <code class="filename">buildlink3.mk</code> file from
8806: this same directory, which is reserved for inclusion from
8807: other <code class="filename">buildlink3.mk</code> files). It takes
8808: care of rebuilding the MIME database at installation and
8809: deinstallation time, and disallows any access to it directly
8810: from the package.</p></li>
1.75 rillig 8811: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 8812: <code class="filename">share/mime</code> directory,
8813: <span class="emphasis"><em>except</em></span> for files saved under
8814: <code class="filename">share/mime/packages</code>. The former are
8815: handled automatically by
8816: the update-mime-database program, but the latter are
8817: package-dependent and must be removed by the package that
8818: installed them in the first place.</p></li>
1.76 rillig 8819: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 8820: from the PLIST. They will be handled by the shared-mime-info
8821: package.</p></li>
1.75 rillig 8822: </ol></div>
8823: </div>
8824: <div class="sect2" lang="en">
8825: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8826: <a name="intltool"></a>18.6.14. Packages using intltool</h3></div></div></div>
1.75 rillig 8827: <p>If a package uses intltool during its build, include the
1.87 wiz 8828: <code class="filename">../../textproc/intltool/buildlink3.mk</code> file,
8829: which forces it to use the intltool package provided by pkgsrc,
8830: instead of the one bundled with the distribution file.</p>
1.75 rillig 8831: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 8832: latest available version; this way, the package benefits of any
8833: bug fixes that may have appeared since it was released.</p>
1.75 rillig 8834: </div>
8835: <div class="sect2" lang="en">
8836: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8837: <a name="startup-scripts"></a>18.6.15. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 8838: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 8839: the startup directory by default, but you can enable it, by adding
8840: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
8841: <code class="filename">/etc/mk.conf</code>. This option will copy the scripts
8842: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8843: it will automatically remove the scripts when the package is
8844: deinstalled.</p>
1.75 rillig 8845: </div>
8846: <div class="sect2" lang="en">
8847: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8848: <a name="tex-packages"></a>18.6.16. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 8849: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 8850: the <code class="filename">ls-R</code> database of the tree needs to be
8851: updated.</p>
1.75 rillig 8852: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8853: <h3 class="title">Note</h3>
8854: <p>Except the main TeX packages such as teTeX-texmf,
1.87 wiz 8855: packages should install files
8856: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
8857: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75 rillig 8858: </div>
8859: <div class="orderedlist"><ol type="1">
8860: <li><p>Include
1.87 wiz 8861: <code class="filename">../../print/teTeX/module.mk</code> instead
8862: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
8863: takes care of rebuilding the <code class="filename">ls-R</code>
8864: database at installation and deinstallation time.</p></li>
1.75 rillig 8865: <li>
8866: <p>If your package installs files into a texmf
1.87 wiz 8867: tree other than the one
8868: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
8869: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
8870: trees that need database update.</p>
1.75 rillig 8871: <p>If your package also installs font map files that need
1.87 wiz 8872: to be registered using <span><strong class="command">updmap</strong></span>,
8873: set <code class="varname">TEX_FONTMAPS</code> to the list of all
8874: such font map files. Then <span><strong class="command">updmap</strong></span> will
8875: be run automatically at installation/deinstallation to
8876: enable/disable font map files for TeX output
8877: drivers.</p>
1.75 rillig 8878: </li>
1.76 rillig 8879: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 8880: databases are included in <code class="filename">PLIST</code>, as
8881: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 8882: </ol></div>
8883: </div>
1.85 jmmv 8884: <div class="sect2" lang="en">
8885: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8886: <a name="emulation-packages"></a>18.6.17. Packages supporting running binaries in
1.87 wiz 8887: emulation</h3></div></div></div>
8888: <p>There are some packages that provide libraries and
8889: executables for running binaries from a one operating system
8890: on a different one (if the latter supports it). One example
8891: is running Linux binaries on NetBSD.</p>
1.91 ! rillig 8892: <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 8893: helps in extracting and packaging Linux rpm packages.</p>
8894: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
8895: avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
8896: if all libraries for each installed executable can be found by
8897: the dynamic linker. Since the standard dynamic linker is run,
8898: this fails for emulation packages, because the libraries used
8899: by the emulation are not in the standard directories.</p>
8900: </div>
8901: <div class="sect2" lang="en">
8902: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8903: <a name="hicolor-theme"></a>18.6.18. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 8904: <p>If a package installs images under the
1.87 wiz 8905: <code class="filename">share/icons/hicolor</code> and/or updates the
8906: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8907: database, you need to take some extra steps to make sure that the
8908: shared theme directory is handled appropriately and that the cache
8909: database is rebuilt:</p>
1.85 jmmv 8910: <div class="orderedlist"><ol type="1">
8911: <li><p>Include
1.87 wiz 8912: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
8913: <li><p>Check the <code class="filename">PLIST</code> and remove the
8914: entry that refers to the theme cache.</p></li>
1.85 jmmv 8915: <li><p>Ensure that the PLIST does not remove the shared icon
8916: directories from the <code class="filename">share/icons/hicolor</code>
8917: hierarchy because they will be handled automatically.</p></li>
8918: </ol></div>
8919: <p>The best way to verify that the PLIST is correct with
8920: respect to the last two points is to regenerate it using
8921: <span><strong class="command">make print-PLIST</strong></span>.</p>
8922: </div>
8923: <div class="sect2" lang="en">
8924: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8925: <a name="desktop-files"></a>18.6.19. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 8926: <p>If a package installs <code class="filename">.desktop</code> files
8927: under <code class="filename">share/applications</code> and these include
8928: MIME information, you need to take extra steps to ensure that they
8929: are registered into the MIME database:</p>
8930: <div class="orderedlist"><ol type="1">
8931: <li><p>Include
8932: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
8933: <li><p>Check the PLIST and remove the entry that refers to the
8934: <code class="filename">share/applications/mimeinfo.cache</code> file.
8935: It will be handled automatically.</p></li>
8936: </ol></div>
8937: <p>The best way to verify that the PLIST is correct with
8938: respect to the last point is to regenerate it using <span><strong class="command">make
8939: print-PLIST</strong></span>.</p>
1.75 rillig 8940: </div>
8941: </div>
1.87 wiz 8942: <div class="sect1" lang="en">
8943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8944: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 8945: <p>In some cases one does not have the time to solve a problem
8946: immediately. There are currently two ways to declare that one knows
8947: that a package has problems.</p>
8948: <div class="itemizedlist"><ul type="disc">
8949: <li><p>The first way is to plainly mark it as broken. For
8950: this, one just sets the variable <code class="varname">BROKEN</code> to the
8951: reason why the package is broken (similar to the
8952: <code class="varname">RESTRICTED</code> variable). A user trying to build
8953: the package will immediately be shown this message, and the build
8954: will not be even tried.</p></li>
8955: <li><p>After each pkgsrc freeze period (a time when the
8956: tree is stabilized and a new pkgsrc branch is cut), the packages
8957: that were not building in the official branch build on the latest
8958: NetBSD release will be marked as broken on that branch. This is
8959: done by setting the <code class="varname">BROKEN_IN</code> variable to the
8960: branch name (or appending the branch name to it). If a user tries
8961: to build such a package and the build fails, the user gets a
8962: message that says that the package was broken on the respective
8963: branch(es).</p></li>
8964: </ul></div>
8965: <p>Both types of packages are removed from pkgsrc in irregular
8966: intervals.</p>
8967: </div>
1.75 rillig 8968: </div>
8969: <div class="chapter" lang="en">
8970: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 8971: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88 wiz 8972: <p>To check out all the gotchas when building a package, here are
8973: the steps that I do in order to get a package working. Please note
8974: this is basically the same as what was explained in the previous
8975: sections, only with some debugging aids.</p>
1.75 rillig 8976: <div class="itemizedlist"><ul type="disc">
1.88 wiz 8977: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=1</code> in
8978: <code class="filename">/etc/mk.conf</code></p></li>
1.75 rillig 8979: <li>
1.91 ! rillig 8980: <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 8981: create a directory for a new package, change into it, then run
8982: <span><strong class="command">url2pkg</strong></span>:</p>
1.75 rillig 8983: <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>
8984: <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>
8985: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8986: </li>
1.76 rillig 8987: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8988: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87 wiz 8989: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75 rillig 8990: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 8991: configure step to the package's
8992: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 8993: <li>
8994: <p>Make the package compile, doing multiple rounds of</p>
8995: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8996: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8997: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8998: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8999: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9000: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9001: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9002: <p>Doing this step as non-root user will ensure that no files
9003: are modified that shouldn't be, especially during the build
9004: phase. <span><strong class="command">mkpatches</strong></span>,
9005: <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91 ! rillig 9006: 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 9007: package.</p>
1.75 rillig 9008: </li>
1.88 wiz 9009: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90 rillig 9010: necessary; see <a href="#components.Makefile" title="10.1. Makefile">Section 10.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.75 rillig 9011: <li>
1.76 rillig 9012: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9013: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9014: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9015: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9016: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9017: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9018: <p>You usually need to be <code class="username">root</code> to do
9019: this. Look if there are any files left:</p>
1.75 rillig 9020: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9021: <p>If this reveals any files that are missing in
1.88 wiz 9022: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9023: </li>
9024: <li>
1.88 wiz 9025: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9026: package again and make a binary package:</p>
1.75 rillig 9027: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9028: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9029: </li>
9030: <li>
9031: <p>Delete the installed package:</p>
1.88 wiz 9032: <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 9033: </li>
9034: <li>
1.88 wiz 9035: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
9036: command, which shouldn't find anything now:</p>
1.75 rillig 9037: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9038: </li>
9039: <li>
9040: <p>Reinstall the binary package:</p>
1.88 wiz 9041: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkgadd .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75 rillig 9042: </li>
1.88 wiz 9043: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9044: <li>
1.91 ! rillig 9045: <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 9046: reports:</p>
1.75 rillig 9047: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9048: </li>
1.90 rillig 9049: <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 9050: </ul></div>
9051: </div>
9052: <div class="chapter" lang="en">
9053: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9054: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75 rillig 9055: <div class="toc">
9056: <p><b>Table of Contents</b></p>
9057: <dl>
1.90 rillig 9058: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
9059: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9060: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
9061: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
9062: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
9063: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9064: </dl>
9065: </div>
9066: <div class="sect1" lang="en">
9067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9068: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9069: <p>Our policy is that we accept binaries only from pkgsrc
9070: developers to guarantee that the packages don't contain any
9071: trojan horses etc. This is not to annoy anyone but rather to
9072: protect our users! You're still free to put up your home-made
9073: binary packages and tell the world where to get them. NetBSD
9074: developers doing bulk builds and wanting to upload them please
9075: 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>
9076: </div>
9077: <div class="sect1" lang="en">
9078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9079: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9080: <p>First, check that your package is complete, compiles and
1.90 rillig 9081: runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75 rillig 9082: 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 9083: archive that contains all files that make up the package.
1.87 wiz 9084: Finally, send this package to the pkgsrc bug tracking system,
9085: 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
9086: that, go to the web page
9087: <a href="http://www.NetBSD.org/Misc/send-pr.html" target="_top">http://www.NetBSD.org/Misc/send-pr.html</a>,
9088: which contains some instructions and a link to a form, where you
9089: can submit packages.</p>
9090: <p>In the form of the problem report, the category should be
9091: “<span class="quote">pkg</span>”, the synopsis should include the package name
9092: and version number, and the description field should contain a
9093: short description of your package (contents of the COMMENT
9094: variable or DESCR file are OK). The uuencoded package data should
9095: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9096: <p>If you want to submit several packages, please send a
9097: separate PR for each one, it's easier for us to track things
9098: that way.</p>
9099: <p>Alternatively, you can also import new packages into
9100: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
9101: homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9102: for details.</p>
9103: </div>
9104: <div class="sect1" lang="en">
9105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9106: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9107: <p>Please note all package additions, updates, moves, and
1.76 rillig 9108: removals in <code class="filename">pkgsrc/doc/CHANGES</code>. It's very
1.75 rillig 9109: important to keep this file up to date and conforming to the
9110: existing format, because it will be used by scripts to
9111: automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9112: sites. Additionally, check the
1.76 rillig 9113: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9114: for the package you updated or removed, in case it was mentioned
9115: there.</p>
9116: <p>When the <code class="varname">PKGREVISION</code> of a package is
9117: bumped, the change should appear in
1.76 rillig 9118: <code class="filename">pkgsrc/doc/CHANGES</code> if it is security
1.75 rillig 9119: related or otherwise relevant. Mass bumps that result from a
9120: dependency being updated should not be mentioned. In all other
9121: cases it's the developer's decision.</p>
9122: <p>There is a make target that helps in creating proper
1.76 rillig 9123: <code class="filename">CHANGES</code> entries: <span><strong class="command">make
1.75 rillig 9124: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9125: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.76 rillig 9126: usage is to first make sure that your <code class="filename">CHANGES</code>
1.75 rillig 9127: file is up-to-date (to avoid having to resolve conflicts later-on)
9128: and then to <span><strong class="command">cd</strong></span> to the package directory. For
9129: package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
9130: For new packages, or package moves or removals, set the
9131: <code class="varname">CTYPE</code> variable on the command line to "Added",
9132: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.76 rillig 9133: in <code class="filename">/etc/mk.conf</code> if your local login name is
1.75 rillig 9134: not the same as your NetBSD login name. Don't forget to commit
1.76 rillig 9135: the changes to <code class="filename">pkgsrc/doc/CHANGES</code>!</p>
1.75 rillig 9136: </div>
9137: <div class="sect1" lang="en">
9138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9139: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9140: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9141: access to the pkgsrc repository. Please remember that cvs
9142: imports files relative to the current working directory, and that
9143: the pathname that you
9144: give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
9145: to place the files in the repository. Newly created packages should be
9146: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9147: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9148: <pre class="programlisting">
9149: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9150: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
9151: </pre>
1.87 wiz 9152: <p>Remember to move the directory from which you imported out of
1.75 rillig 9153: the way, or cvs will complain the next time you “<span class="quote">cvs
9154: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9155: package to the category's <code class="filename">Makefile</code>.</p>
9156: <p>The commit message of the initial import should include part of the
1.76 rillig 9157: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9158: what the package is/does.</p>
9159: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9160: add</span>” because the former gets everything with a single command,
1.87 wiz 9161: and provides a consistent tag.</p>
1.75 rillig 9162: </div>
9163: <div class="sect1" lang="en">
9164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9165: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9166: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9167: changes between old and new versions into the commit log when updating
1.87 wiz 9168: a package. There are various reasons for this:</p>
1.75 rillig 9169: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9170: <li><p>A URL is volatile, and can change over time. It may go away completely
9171: or its information may be overwritten by newer information.</p></li>
9172: <li><p>Having the change information between old and new versions in our CVS
9173: repository is very useful for people who use either cvs or anoncvs.</p></li>
9174: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9175: repository is very useful for people who read the pkgsrc-changes mailing
9176: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9177: the package.</p></li>
1.75 rillig 9178: </ul></div>
1.87 wiz 9179: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9180: has been released, it should not automatically be upgraded in the CVS
9181: repository. We prefer to be conservative in the packages that are
9182: included in pkgsrc - development or beta packages are not really the
9183: best thing for most places in which pkgsrc is used. Please use your
9184: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9185: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9186: </div>
9187: <div class="sect1" lang="en">
9188: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9189: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75 rillig 9190: <div class="orderedlist"><ol type="1">
9191: <li><p>Make a copy of the directory somewhere else.</p></li>
9192: <li>
9193: <p>Remove all CVS dirs.</p>
1.87 wiz 9194: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9195: <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 9196: <p>and use that for further work.</p>
1.75 rillig 9197: </li>
9198: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9199: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9200: instead of “<span class="quote">../../category/package</span>”.</p></li>
9201: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
9202: place.</p></li>
9203: <li>
9204: <p>Check if any package depends on it:
9205: </p>
9206: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9207: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9208: </li>
9209: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
9210: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9211: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9212: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9213: <li>
9214: <p>Commit the changed and removed files:</p>
9215: <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 9216: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9217: </li>
9218: </ol></div>
9219: </div>
9220: </div>
9221: <div class="chapter" lang="en">
9222: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9223: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9224: <p>This section contains the answers to questions that may
9225: arise when you are writing a package. If you don't find your
9226: question answered here, first have a look in the other chapters,
9227: and if you still don't have the answer, ask on the
9228: <code class="literal">pkgsrc-users</code> mailing list.</p>
9229: <div class="qandaset">
9230: <dl>
1.91 ! rillig 9231: <dt>21.1. <a href="#id2685573">What is the difference between
1.75 rillig 9232: MAKEFLAGS, .MAKEFLAGS and
9233: MAKE_FLAGS?</a>
9234: </dt>
1.91 ! rillig 9235: <dt>21.2. <a href="#id2685609">What is the difference between
1.75 rillig 9236: MAKE, GMAKE and
9237: MAKE_PROGRAM?</a>
9238: </dt>
1.91 ! rillig 9239: <dt>21.3. <a href="#id2685648">What is the difference between
1.75 rillig 9240: CC, PKG_CC and
9241: PKGSRC_COMPILER?</a>
9242: </dt>
1.91 ! rillig 9243: <dt>21.4. <a href="#id2685685">What is the difference between
1.75 rillig 9244: BUILDLINK_LDFLAGS,
9245: BUILDLINK_LDADD and
9246: BUILDLINK_LIBS?</a>
9247: </dt>
1.91 ! rillig 9248: <dt>21.5. <a href="#id2685703">Why does make show-var
1.75 rillig 9249: VARNAME=BUILDLINK_PREFIX.foo
9250: say it's empty?</a>
9251: </dt>
1.91 ! rillig 9252: <dt>21.6. <a href="#id2685731">What does
1.78 rillig 9253: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9254: don't understand the := inside
9255: it.</a>
9256: </dt>
1.91 ! rillig 9257: <dt>21.7. <a href="#id2685805">Which mailing lists are there for package
1.78 rillig 9258: developers?</a>
9259: </dt>
1.91 ! rillig 9260: <dt>21.8. <a href="#id2685842">Where is the pkgsrc
1.80 rillig 9261: documentation?</a>
9262: </dt>
1.75 rillig 9263: </dl>
9264: <table border="0" summary="Q and A Set">
9265: <col align="left" width="1%">
9266: <tbody>
9267: <tr class="question">
9268: <td align="left" valign="top">
1.91 ! rillig 9269: <a name="id2685573"></a><a name="id2685574"></a><b>21.1.</b>
1.75 rillig 9270: </td>
9271: <td align="left" valign="top"><p>What is the difference between
9272: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9273: <code class="varname">MAKE_FLAGS</code>?</p></td>
9274: </tr>
9275: <tr class="answer">
1.91 ! rillig 9276: <td align="left" valign="top"></td>
1.75 rillig 9277: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9278: 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
9279: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9280: the <code class="varname">MAKE_PROGRAM</code> when building the
9281: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9282: </tr>
9283: <tr class="question">
9284: <td align="left" valign="top">
1.91 ! rillig 9285: <a name="id2685609"></a><a name="id2685610"></a><b>21.2.</b>
1.75 rillig 9286: </td>
9287: <td align="left" valign="top"><p>What is the difference between
9288: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9289: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9290: </tr>
9291: <tr class="answer">
1.91 ! rillig 9292: <td align="left" valign="top"></td>
1.75 rillig 9293: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9294: <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
9295: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9296: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9297: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9298: Make program that is used for building the
9299: package.</p></td>
9300: </tr>
9301: <tr class="question">
9302: <td align="left" valign="top">
1.91 ! rillig 9303: <a name="id2685648"></a><a name="id2685649"></a><b>21.3.</b>
1.75 rillig 9304: </td>
9305: <td align="left" valign="top"><p>What is the difference between
9306: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9307: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9308: </tr>
9309: <tr class="answer">
1.91 ! rillig 9310: <td align="left" valign="top"></td>
1.75 rillig 9311: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9312: compiler, which can be configured by the pkgsrc user.
9313: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9314: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9315: path to a compiler, but the type of compiler that should be
1.76 rillig 9316: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9317: information about the latter variable.</p></td>
9318: </tr>
9319: <tr class="question">
9320: <td align="left" valign="top">
1.91 ! rillig 9321: <a name="id2685685"></a><a name="id2685686"></a><b>21.4.</b>
1.75 rillig 9322: </td>
9323: <td align="left" valign="top"><p>What is the difference between
9324: <code class="varname">BUILDLINK_LDFLAGS</code>,
9325: <code class="varname">BUILDLINK_LDADD</code> and
9326: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9327: </tr>
9328: <tr class="answer">
1.91 ! rillig 9329: <td align="left" valign="top"></td>
1.75 rillig 9330: <td align="left" valign="top"><p>[FIXME]</p></td>
9331: </tr>
9332: <tr class="question">
9333: <td align="left" valign="top">
1.91 ! rillig 9334: <a name="id2685703"></a><a name="id2685704"></a><b>21.5.</b>
1.75 rillig 9335: </td>
9336: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
9337: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9338: say it's empty?</p></td>
9339: </tr>
9340: <tr class="answer">
1.91 ! rillig 9341: <td align="left" valign="top"></td>
1.75 rillig 9342: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9343: available in the “<span class="quote">wrapper</span>” phase and later. To
9344: “<span class="quote">simulate</span>” the wrapper phase, append
9345: <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
9346: command.</p></td>
9347: </tr>
1.78 rillig 9348: <tr class="question">
9349: <td align="left" valign="top">
1.91 ! rillig 9350: <a name="id2685731"></a><a name="id2685732"></a><b>21.6.</b>
1.78 rillig 9351: </td>
9352: <td align="left" valign="top"><p>What does
9353: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9354: don't understand the <code class="literal">:=</code> inside
9355: it.</p></td>
9356: </tr>
9357: <tr class="answer">
1.91 ! rillig 9358: <td align="left" valign="top"></td>
1.78 rillig 9359: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9360: assignment operator, like you might expect at first sight.
9361: Instead, it is a degenerate form of
9362: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9363: 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
9364: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9365: case of <code class="varname">MASTER_SITE_*</code>,
9366: <em class="replaceable"><code>old_string</code></em> is the empty string and
9367: <em class="replaceable"><code>new_string</code></em> is
9368: <code class="literal">package/</code>. That's where the
9369: <code class="literal">:</code> and the <code class="literal">=</code> fall
9370: together.</p></td>
9371: </tr>
9372: <tr class="question">
9373: <td align="left" valign="top">
1.91 ! rillig 9374: <a name="id2685805"></a><a name="id2685806"></a><b>21.7.</b>
1.78 rillig 9375: </td>
9376: <td align="left" valign="top"><p>Which mailing lists are there for package
9377: developers?</p></td>
9378: </tr>
9379: <tr class="answer">
1.91 ! rillig 9380: <td align="left" valign="top"></td>
1.78 rillig 9381: <td align="left" valign="top"><div class="variablelist"><dl>
9382: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
9383: <dd><p>This is a list for technical discussions related
9384: to pkgsrc development, e.g. soliciting feedback for changes to
9385: pkgsrc infrastructure, proposed new features, questions related
9386: to porting pkgsrc to a new platform, advice for maintaining a
9387: package, patches that affect many packages, help requests moved
9388: from pkgsrc-users when an infrastructure bug is found,
9389: etc.</p></dd>
9390: <dt><span class="term"><a href="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
9391: <dd><p>All bug reports in category "pkg" sent with
9392: <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
9393: directly; use one of the other mailing
9394: lists.</p></dd>
9395: </dl></div></td>
9396: </tr>
1.80 rillig 9397: <tr class="question">
9398: <td align="left" valign="top">
1.91 ! rillig 9399: <a name="id2685842"></a><a name="id2685843"></a><b>21.8.</b>
1.80 rillig 9400: </td>
9401: <td align="left" valign="top"><p>Where is the pkgsrc
9402: documentation?</p></td>
9403: </tr>
9404: <tr class="answer">
1.91 ! rillig 9405: <td align="left" valign="top"></td>
1.80 rillig 9406: <td align="left" valign="top">
9407: <p>There are many places where you can find
9408: documentation about pkgsrc:</p>
9409: <div class="itemizedlist"><ul type="disc">
9410: <li><p>The pkgsrc guide (this document) is a collection
9411: of chapters that explain large parts of pkgsrc, but some
9412: chapters tend to be outdated. Which ones they are is hard to
9413: say.</p></li>
9414: <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
9415: about certain features, announcements of new parts of the pkgsrc
9416: infrastructure and sometimes even announcements that a certain
9417: feature has been marked as obsolete. The benefit here is that
9418: each message has a date appended to it.</p></li>
9419: <li><p>Many of the files in the
9420: <code class="filename">mk/</code> directory start with a comment that
9421: describes the purpose of the file and how it can be used by the
9422: pkgsrc user and package authors.</p></li>
9423: <li><p>The CVS log messages are a rich source of
9424: information, but they tend to be highly abbreviated, especially
9425: for actions that occur often. Some contain a detailed
9426: description of what has changed, but they are geared towards the
9427: other pkgsrc developers, not towards an average pkgsrc user.
9428: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9429: don't know what has been before, these messages may not be worth
9430: too much to you.</p></li>
9431: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9432: documented</span>”, that is the documentation exists only in the
9433: mind of the developer who wrote the code. To get this
9434: information, use the the <span><strong class="command">cvs annotate</strong></span> command
9435: to see who has written it and ask on the
9436: <code class="literal">tech-pkg</code> mailing list, so that others can
9437: find your questions later (see above). To be sure that the
9438: developer in charge reads the mail, you may CC him or
9439: her.</p></li>
9440: </ul></div>
9441: </td>
9442: </tr>
1.75 rillig 9443: </tbody>
9444: </table>
9445: </div>
9446: </div>
1.85 jmmv 9447: <div class="chapter" lang="en">
9448: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9449: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9450: <div class="toc">
9451: <p><b>Table of Contents</b></p>
9452: <dl>
1.90 rillig 9453: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9454: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9455: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9456: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 9457: </dl>
9458: </div>
9459: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
9460: site</a>:</p>
9461: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9462: environment, an intuitive and attractive desktop for users, and the
9463: GNOME development platform, an extensive framework for building
9464: applications that integrate into the rest of the desktop.</p></blockquote></div>
9465: <p>pkgsrc provides a seamless way to automatically build and install
9466: a complete GNOME environment <span class="emphasis"><em>under many different
9467: platforms</em></span>. We can say with confidence that pkgsrc is one of
9468: the most advanced build and packaging systems for GNOME due to its
9469: included technologies buildlink3, the wrappers and tools framework and
9470: automatic configuration file management. Lots of efforts are put into
9471: achieving a completely clean deinstallation of installed software
9472: components.</p>
9473: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9474: the above also means that great efforts are put into making GNOME work
9475: under this operating system. Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9476: pkgsrc as its preferred packaging system, contributing lots of
9477: portability fixes to make GNOME build and install under it.</p>
9478: <p>This chapter is aimed at pkgsrc developers and other people
9479: interested in helping our GNOME porting and packaging efforts. It
9480: provides instructions on how to manage the existing packages and some
9481: important information regarding their internals.</p>
9482: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9483: <h3 class="title">We need your help!</h3>
9484: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9485: and GNOME and are willing to learn new exciting stuff, please jump
9486: straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9487: work</a> list! There is still a long way to go to get a
9488: fully-functional GNOME desktop under NetBSD and we need your help to
9489: achieve it!</p>
9490: </div>
9491: <div class="sect1" lang="en">
9492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9493: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85 jmmv 9494: <p>pkgsrc includes three GNOME-related meta packages:</p>
9495: <div class="itemizedlist"><ul type="disc">
1.91 ! rillig 9496: <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 9497: the core GNOME desktop environment. It only includes the necessary
9498: bits to get it to boot correctly, although it may lack important
9499: functionality for daily operation. The idea behind this package is
9500: to let end users build their own configurations on top of this one,
9501: first installing this meta package to achieve a functional setup and
9502: then adding individual applications.</p></li>
1.91 ! rillig 9503: <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 9504: complete installation of the GNOME platform and desktop as defined
9505: by the GNOME project; this is based on the components distributed in
9506: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9507: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9508: official FTP server. Developer-only tools found in those
9509: directories are not installed unless required by some other
9510: component to work properly. Similarly, packages from the bindings
9511: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9512: in unless required as a dependency for an end-user component. This
1.91 ! rillig 9513: 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>
! 9514: <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 9515: Installs all the tools required to build a GNOME component when
9516: fetched from the CVS repository. These are required to let the
9517: <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
9518: </ul></div>
9519: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9520: sorted in a way that eases updates: a package may depend on other
9521: packages listed before it but not on any listed after it. It is very
9522: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9523: change it to alphabetical sorting!</em></span></p>
9524: </div>
9525: <div class="sect1" lang="en">
9526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9527: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9528: <p>Almost all GNOME applications are written in C and use a common
9529: set of tools as their build system. Things get different with the new
9530: bindings to other languages (such as Python), but the following will
9531: give you a general idea on the minimum required tools:</p>
9532: <div class="itemizedlist"><ul type="disc">
9533: <li>
9534: <p>Almost all GNOME applications use the GNU Autotools as their
9535: build system. As a general rule you will need to tell this to your
9536: package:</p>
9537: <pre class="programlisting">GNU_CONFIGURE=yes
9538: USE_LIBTOOL=yes
9539: USE_TOOLS+=gmake</pre>
9540: </li>
9541: <li>
9542: <p>If the package uses pkg-config to detect dependencies, add this
9543: tool to the list of required utilities:</p>
9544: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 ! rillig 9545: <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 9546: the end of the build process to ensure that you did not miss to
9547: specify any dependency in your package and that the version
9548: requirements are all correct.</p>
9549: </li>
9550: <li><p>If the package uses intltool, be sure to include the <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/textproc/intltool/buildlink3.mk?rev=HEAD&content-type=text/x-cvsweb-markup" target="_top"><code class="filename">pkgsrc/textproc/intltool/buildlink3.mk</code></a> file
9551: to handle dependencies and to force the package to use the latest
9552: available version.</p></li>
9553: <li>
9554: <p>If the package uses gtk-doc (a documentation generation
9555: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9556: tool is rather big and the distfile should come with pregenerated
9557: documentation anyway; if it does not, it is a bug that you ought to
9558: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9559: the default):</p>
9560: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9561: <p>The default location of installed HTML files
9562: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9563: and should not be changed unless the package insists on installing
9564: them somewhere else. Otherwise programs as
9565: <span><strong class="command">devhelp</strong></span> will not be able to open them. You can
9566: do that with an entry similar to:</p>
9567: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9568: </li>
9569: </ul></div>
9570: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9571: files under the installation prefix to maintain databases. In this
9572: context, shared means that those exact same directories and files are
9573: used among several different packages, leading to conflicts in the
9574: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9575: handle the most common cases, so you have to forget about using
9576: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9577: omitting shared files from them. If you find yourself doing those,
9578: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9579: <p>The following table lists the common situations that result in
9580: using shared directories or files. For each of them, the appropriate
9581: solution is given. After applying the solution be sure to
9582: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9583: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
9584: <div class="table">
1.90 rillig 9585: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91 ! rillig 9586: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9587: <colgroup>
9588: <col>
9589: <col>
9590: </colgroup>
9591: <thead><tr>
9592: <th>If the package...</th>
9593: <th>Then...</th>
9594: </tr></thead>
9595: <tbody>
9596: <tr>
9597: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.90 rillig 9598: <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 9599: </tr>
9600: <tr>
9601: <td>Installs icons under the
9602: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9603: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.90 rillig 9604: <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 9605: </tr>
9606: <tr>
9607: <td>Installs files under
9608: <code class="filename">share/mime/packages</code>.</td>
1.90 rillig 9609: <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 9610: </tr>
9611: <tr>
9612: <td>Installs <code class="filename">.desktop</code> files under
9613: <code class="filename">share/applications</code> and these include MIME
9614: information.</td>
1.90 rillig 9615: <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 9616: </tr>
9617: </tbody>
1.91 ! rillig 9618: </table></div>
1.85 jmmv 9619: </div>
1.91 ! rillig 9620: <br class="table-break">
1.85 jmmv 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="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9625: <p>When seeing GNOME as a whole, there are two kinds of
9626: updates:</p>
9627: <div class="variablelist"><dl>
9628: <dt><span class="term">Major update</span></dt>
9629: <dd>
9630: <p>Given that there is still a very long way for GNOME 3 (if it
9631: ever appears), we consider a major update one that goes from a
9632: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9633: where <code class="literal">Y</code> is even and greater than
9634: <code class="literal">X</code>. These are hard to achieve because they
9635: introduce lots of changes in the components' code and almost all
9636: GNOME distfiles are updated to newer versions. Some of them can
9637: even break API and ABI compatibility with the previous major
9638: version series. As a result, the update needs to be done all at
9639: once to minimize breakage.</p>
9640: <p>A major update typically consists of around 80 package
9641: updates and the addition of some new ones.</p>
9642: </dd>
9643: <dt><span class="term">Minor update</span></dt>
9644: <dd>
9645: <p>We consider a minor update one that goes from a
9646: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9647: one where <code class="literal">Y</code> is greater than
9648: <code class="literal">X</code>. These are easy to achieve because they do
9649: not update all GNOME components, can be done in an incremental way
9650: and do not break API nor ABI compatibility.</p>
9651: <p>A minor update typically consists of around 50 package
9652: updates, although the numbers here may vary a lot.</p>
9653: </dd>
9654: </dl></div>
9655: <p>In order to update the GNOME components in pkgsrc to a new stable
9656: release (either major or minor), the following steps should be
9657: followed:</p>
9658: <div class="orderedlist"><ol type="1">
9659: <li>
9660: <p>Get a list of all the tarballs that form the new release by
9661: using the following commands. These will leave the full list of the
9662: components's distfiles into the <code class="filename">list.txt</code>
9663: file:</p>
1.88 wiz 9664: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9665: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9666: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9667: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9668: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9669: awk '{ print $9 }' >>list.txt</code></strong></pre>
9670: </li>
9671: <li><p>Open each meta package's <code class="filename">Makefile</code> and
9672: bump their version to the release you are updating them to. The
9673: three meta packages should be always consistent with versioning.
9674: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9675: in them.</p></li>
9676: <li>
9677: <p>For each meta package, update all its
9678: <code class="varname">DEPENDS</code> lines to match the latest versions as
9679: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9680: newer version (even if found in the FTP) because the meta packages
9681: are supposed to list the exact versions that form a specific GNOME
9682: release. Exceptions are permitted here if a newer version solves a
9683: serious issue in the overall desktop experience; these typically
9684: come in the form of a revision bump in pkgsrc, not in newer versions
9685: from the developers.</p>
9686: <p>Packages not listed in the <code class="filename">list.txt</code> file
9687: should be updated to the latest version available (if found in
9688: pkgsrc). This is the case, for example, of the dependencies on the
1.91 ! rillig 9689: 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 9690: </li>
9691: <li>
9692: <p>Generate a patch from the modified meta packages and extract the
9693: list of "new" lines. This will provide you an outline on what
9694: packages need to be updated in pkgsrc and in what order:</p>
1.88 wiz 9695: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.85 jmmv 9696: </li>
9697: <li><p>For major desktop updates it is recommended to zap all your
9698: installed packages and start over from scratch at this point.</p></li>
9699: <li><p>Now comes the longest step by far: iterate over the contents
9700: of <code class="filename">todo.txt</code> and update the packages listed in
9701: it in order. For major desktop updates none of these should be
9702: commited until the entire set is completed because there are chances
9703: of breaking not-yet-updated packages.</p></li>
9704: <li><p>Once the packages are up to date and working, commit them to
9705: the tree one by one with appropriate log messages. At the end,
9706: commit the three meta package updates and all the corresponding
9707: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9708: <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>
9709: </ol></div>
9710: </div>
9711: <div class="sect1" lang="en">
9712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9713: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 9714: <p>GNOME is a very big component in pkgsrc which approaches 100
9715: packages. Please, it is very important that you always, always,
9716: <span class="strong"><strong>always</strong></span> feed back any portability
1.90 rillig 9717: fixes you do to a GNOME package to the mainstream developers (see <a href="#components.patches.feedback" title="10.3.2. Feedback to the author">Section 10.3.2, “Feedback to the author”</a>). This is the only way to get
1.85 jmmv 9718: their attention on portability issues and to ensure that future versions
9719: can be built out-of-the box on NetBSD. The less custom patches in
9720: pkgsrc, the easier further updates are. Those developers in charge of
9721: issuing major GNOME updates will be grateful if you do that.</p>
9722: <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
9723: Bugzilla</a>. Not all components use these to track bugs, but most
9724: of them do. Do not be short on your reports: always provide detailed
9725: explanations of the current failure, how it can be improved to achieve
9726: maximum portability and, if at all possible, provide a patch against CVS
9727: head. The more verbose you are, the higher chances of your patch being
9728: accepted.</p>
9729: <p>Also, please avoid using preprocessor magic to fix portability
9730: issues. While the FreeBSD GNOME people are doing a great job in porting
9731: GNOME to their operating system, the official GNOME sources are now
9732: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9733: and similar macros. This hurts portability. Please see our patching
1.90 rillig 9734: guidelines (<a href="#components.patches.guidelines" title="10.3.1. Patching guidelines">Section 10.3.1, “Patching guidelines”</a>) for more
1.85 jmmv 9735: details.</p>
9736: </div>
9737: </div>
1.75 rillig 9738: </div>
9739: <div class="part" lang="en">
9740: <div class="titlepage"><div><div><h1 class="title">
9741: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
9742: <div class="partintro" lang="en">
9743: <div></div>
9744: <p>This part of the guide deals with everything
9745: from the infrastructure that is behind the interfaces described
9746: in the developer's guide. A casual package maintainer should not
9747: need anything from this part.</p>
9748: <div class="toc">
9749: <p><b>Table of Contents</b></p>
9750: <dl>
1.90 rillig 9751: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 9752: <dd><dl>
1.90 rillig 9753: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
9754: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
9755: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75 rillig 9756: <dd><dl>
1.90 rillig 9757: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
9758: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75 rillig 9759: </dl></dd>
1.90 rillig 9760: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
9761: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 9762: <dd><dl>
1.90 rillig 9763: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
9764: <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 9765: </dl></dd>
1.90 rillig 9766: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81 rillig 9767: <dd><dl>
1.90 rillig 9768: <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>
9769: <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 9770: </dl></dd>
9771: </dl></dd>
1.90 rillig 9772: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 9773: <dd><dl>
1.90 rillig 9774: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
9775: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
9776: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 9777: <dd><dl>
1.90 rillig 9778: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
9779: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 9780: </dl></dd>
9781: </dl></dd>
1.90 rillig 9782: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 9783: <dd><dl>
1.90 rillig 9784: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
9785: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 9786: </dl></dd>
9787: </dl>
9788: </div>
9789: </div>
9790: <div class="chapter" lang="en">
9791: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9792: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 9793: <div class="toc">
9794: <p><b>Table of Contents</b></p>
9795: <dl>
1.90 rillig 9796: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
9797: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
9798: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 9799: <dd><dl>
1.90 rillig 9800: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
9801: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 9802: </dl></dd>
1.90 rillig 9803: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
9804: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 9805: <dd><dl>
1.90 rillig 9806: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
9807: <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 9808: </dl></dd>
1.90 rillig 9809: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 9810: <dd><dl>
1.90 rillig 9811: <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>
9812: <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 9813: </dl></dd>
9814: </dl>
9815: </div>
9816: <p>The pkgsrc infrastructure consists of many small Makefile
9817: fragments. Each such fragment needs a properly specified
9818: interface. This chapter explains how such an interface looks
9819: like.</p>
9820: <div class="sect1" lang="en">
9821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9822: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 9823: <p>Whenever a variable is defined in the pkgsrc
9824: infrastructure, the location and the way of definition provide
9825: much information about the intended use of that variable.
9826: Additionally, more documentation may be found in a header
9827: comment or in this pkgsrc guide.</p>
9828: <p>A special file is
9829: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9830: variables that are intended to be user-defined. They are either
9831: defined using the <code class="literal">?=</code> operator or they are
9832: left undefined because defining them to anything would
9833: effectively mean “<span class="quote">yes</span>”. All these variables may be
9834: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9835: file.</p>
9836: <p>Outside this file, the following conventions apply:
9837: Variables that are defined using the <code class="literal">?=</code>
9838: operator may be overridden by a package.</p>
9839: <p>Variables that are defined using the <code class="literal">=</code>
9840: operator may be used read-only at run-time.</p>
9841: <p>Variables whose name starts with an underscore must not be
9842: accessed outside the pkgsrc infrastructure at all. They may
9843: change without further notice.</p>
9844: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9845: <h3 class="title">Note</h3>
9846: <p>These conventions are currently not applied
9847: consistently to the complete pkgsrc
9848: infrastructure.</p>
9849: </div>
9850: </div>
9851: <div class="sect1" lang="en">
9852: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9853: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 9854: <p>All variables that contain lists of things should default
9855: to being empty. Two examples that do not follow this rule are
9856: <code class="varname">USE_LANGUAGES</code> and
9857: <code class="varname">DISTFILES</code>. These variables cannot simply be
9858: modified using the <code class="literal">+=</code> operator in package
9859: <code class="filename">Makefile</code>s (or other files included by
9860: them), since there is no guarantee whether the variable is
9861: already set or not, and what its value is. In the case of
9862: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
9863: the default value and just define it as in the following
9864: example.</p>
9865: <pre class="programlisting">
9866: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9867: </pre>
9868: <p>Because of the selection of this default value, the same
9869: value appears in many package Makefiles. Similarly for
9870: <code class="varname">USE_LANGUAGES</code>, but in this case the default
9871: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
9872: doesn't stand out. Nevertheless it is mentioned in many
9873: files.</p>
9874: </div>
9875: <div class="sect1" lang="en">
9876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9877: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75 rillig 9878: <div class="sect2" lang="en">
9879: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9880: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75 rillig 9881: <p>Variable evaluation takes place either at load time or at
9882: runtime, depending on the context in which they occur. The
9883: contexts where variables are evaluated at load time are:</p>
9884: <div class="itemizedlist"><ul type="disc">
9885: <li><p>The right hand side of the <code class="literal">:=</code>
9886: and <code class="literal">!=</code> operators,</p></li>
9887: <li><p>Make directives like <code class="literal">.if</code> or
9888: <code class="literal">.for</code>,</p></li>
9889: <li><p>Dependency lines.</p></li>
9890: </ul></div>
9891: <p>A special exception are references to the iteration
9892: variables of <code class="literal">.for</code> loops, which are expanded
9893: inline, no matter in which context they appear.</p>
9894: <p>As the values of variables may change during load time,
9895: care must be taken not to evaluate them by accident. Typical
9896: examples for variables that should not be evaluated at load time
9897: are <code class="varname">DEPENDS</code> and
9898: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9899: clear, here is an example:</p>
9900: <pre class="programlisting">
9901: CONFIGURE_ARGS= # none
9902: CFLAGS= -O
9903: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 9904:
1.75 rillig 9905: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 9906:
1.75 rillig 9907: CFLAGS+= -Wall
9908: </pre>
9909: <p>This code shows how the use of the <code class="literal">:=</code>
9910: operator can quickly lead to unexpected results. The first
9911: paragraph is fairly common code. The second paragraph evaluates
9912: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9913: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9914: <code class="literal">-Wall</code> is appended to the
9915: <code class="varname">CFLAGS</code>, but this addition will not appear in
9916: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9917: paragraphs from above typically occur in completely unrelated
9918: files.</p>
9919: </div>
9920: <div class="sect2" lang="en">
9921: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9922: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75 rillig 9923: <p>After all the files have been loaded, the values of the
9924: variables cannot be changed anymore. Variables that are used in
9925: the shell commands are expanded at this point.</p>
9926: </div>
9927: </div>
9928: <div class="sect1" lang="en">
9929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9930: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 9931: <p>There are many ways in which the definition and use of a
9932: variable can be restricted in order to detect bugs and
9933: violations of the (mostly unwritten) policies. See the
9934: <code class="literal">pkglint</code> developer's documentation for further
9935: details.</p>
9936: </div>
9937: <div class="sect1" lang="en">
9938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9939: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 9940: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 9941: of the following classes. Cases where a file falls into more
9942: than one class should be avoided as it often leads to subtle
9943: bugs.</p>
9944: <div class="sect2" lang="en">
9945: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9946: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 9947: <p>In a traditional imperative programming language some of
1.76 rillig 9948: the <code class="filename">.mk</code> files could be described as
1.89 rillig 9949: procedures. They take some input parameters and—after
9950: inclusion—provide a result in output parameters. Since all
1.76 rillig 9951: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 9952: care must be taken not to use parameter names that have already
9953: another meaning. For example, <code class="varname">PKGNAME</code> is a
9954: bad choice for a parameter name.</p>
9955: <p>Procedures are completely evaluated at preprocessing time.
9956: That is, when calling a procedure all input parameters must be
9957: completely resolvable. For example,
9958: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9959: parameter since it is very likely that further text will be
9960: added after calling the procedure, which would effectively apply
9961: the procedure to only a part of the variable. Also, references
9962: to other variables wit will be modified after calling the
9963: procedure.</p>
9964: <p>A procedure can declare its output parameters either as
9965: suitable for use in preprocessing directives or as only
9966: available at runtime. The latter alternative is for variables
9967: that contain references to other runtime variables.</p>
9968: <p>Procedures shall be written such that it is possible to
9969: call the procedure more than once. That is, the file must not
9970: contain multiple-inclusion guards.</p>
9971: <p>Examples for procedures are
1.76 rillig 9972: <code class="filename">mk/bsd.options.mk</code> and
9973: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 9974: that the parameters are evaluated at load time, they should be
9975: assigned using the <code class="literal">:=</code> operator, which should
9976: be used only for this purpose.</p>
9977: </div>
9978: <div class="sect2" lang="en">
9979: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 9980: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 9981: <p>Action files take some input parameters and may define
9982: runtime variables. They shall not define loadtime variables.
9983: There are action files that are included implicitly by the
9984: pkgsrc infrastructure, while other must be included
9985: explicitly.</p>
9986: <p>An example for action files is
1.76 rillig 9987: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 9988: </div>
9989: </div>
1.81 rillig 9990: <div class="sect1" lang="en">
9991: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9992: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 9993: <p>Package <code class="filename">Makefile</code>s usually consist of
9994: a set of variable definitions, and include the file
9995: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9996: Before that, they may also include various other
9997: <code class="filename">*.mk</code> files if they need to query the
9998: availability of certain features like the type of compiler or
9999: the X11 implementation. Due to the heavy use of preprocessor
10000: directives like <code class="literal">.if</code> and
10001: <code class="literal">.for</code>, the order in which the files are loaded
10002: matters.</p>
10003: <p>This section describes at which point the various files
10004: are loaded and gives reasons for that order.</p>
10005: <div class="sect2" lang="en">
10006: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10007: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code></h3></div></div></div>
1.81 rillig 10008: <p>The very first action in <code class="filename">bsd.pkg.mk</code>
10009: is to define some essential variables like
10010: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10011: <code class="varname">MACHINE_ARCH</code>.</p>
10012: <p>Then, the user settings are loaded from the file specified
10013: in <code class="varname">MAKECONF</code>. If the bmake command from pkgsrc
10014: is used, <code class="varname">MAKECONF</code> defaults to
10015: <code class="filename"><em class="replaceable"><code>${prefix}</code></em>/etc/mk.conf</code>.
10016: 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
10017: <code class="filename">/etc/mk.conf</code>. After that, those variables
10018: that have not been overridden by the user are loaded from
10019: <code class="filename">mk/defaults/mk.conf</code>.</p>
10020: <p>After the user settings, the system settings and platform
10021: settings are loaded, which may override the user
10022: settings.</p>
10023: <p>Then, the tool definitions are loaded. The tool wrappers
10024: are not yet in effect. This only happens when building a
10025: package, so the proper variables must be used instead of the
10026: direct tool names.</p>
10027: <p>As the last steps, some essential variables from the
10028: wrapper and the package system flavor are loaded, as well as the
10029: variables that have been cached in earlier phases of a package
10030: build.</p>
10031: </div>
10032: <div class="sect2" lang="en">
10033: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10034: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code></h3></div></div></div>
1.81 rillig 10035: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10036: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10037: loaded, which fill default values for those variables that have
10038: not been defined by the the package. These variables may later
10039: be used even in unrelated files.</p>
10040: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10041: provides the target <code class="literal">error-check</code> that is added
10042: as a special dependency to all other targets that use
10043: <code class="varname">DELAYED_ERROR_MSG</code> or
10044: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10045: <p>Then, the package-specific hacks from
10046: <code class="filename">hacks.mk</code> are included.</p>
10047: <p>Then, various other files follow. Most of them don't have
10048: any dependencies on what they need to have included before or
10049: after them, though some do.</p>
10050: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10051: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10052: restricts the use of these variables to all the files that have
10053: been included before. Appearances in later files will be
10054: silently ignored.</p>
10055: <p>Then, the files for the main targets are included, in the
10056: order of later execution, though the actual order should not
10057: matter.</p>
10058: <p>At last, some more files are included that don't set any
10059: interesting variables but rather just define make targets to be
10060: executed.</p>
10061: </div>
10062: </div>
1.75 rillig 10063: </div>
10064: <div class="chapter" lang="en">
10065: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10066: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75 rillig 10067: <div class="toc">
10068: <p><b>Table of Contents</b></p>
10069: <dl>
1.90 rillig 10070: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10071: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10072: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10073: <dd><dl>
1.90 rillig 10074: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10075: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10076: </dl></dd>
10077: </dl>
10078: </div>
10079: <p>The pkgsrc infrastructure consists of a large codebase,
10080: and there are many corners where every little bit of a file is
10081: well thought out, making pkgsrc likely to fail as soon as
10082: anything is changed near those parts. To prevent most changes
10083: from breaking anything, a suite of regression tests should go
10084: along with every important part of the pkgsrc infrastructure.
10085: This chapter describes how regression tests work in pkgsrc and
10086: how you can add new tests.</p>
10087: <div class="sect1" lang="en">
10088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10089: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10090: <p></p>
10091: </div>
10092: <div class="sect1" lang="en">
10093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10094: <a name="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91 ! rillig 10095: <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 10096: provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
10097: can simply run that command, which will run all tests in the
1.76 rillig 10098: <code class="filename">regress</code> category.</p>
1.75 rillig 10099: </div>
10100: <div class="sect1" lang="en">
10101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10102: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10103: <p>Every directory in the <code class="filename">regress</code>
10104: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10105: is considered a regression test. This file is a shell program
10106: that is included by the <span><strong class="command">pkg_regress</strong></span> command.
10107: The following functions can be overridden to suit your
10108: needs.</p>
10109: <div class="sect2" lang="en">
10110: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10111: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10112: <p>These functions do not take any parameters. They are all
10113: called in “<span class="quote">set -e</span>” mode, so you should be careful
10114: to check the exitcodes of any commands you run in the
10115: test.</p>
10116: <div class="variablelist"><dl>
10117: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10118: <dd><p>This function prepares the environment for the
10119: test. By default it does nothing.</p></dd>
10120: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10121: <dd><p>This function runs the actual test. By default,
10122: it calls <code class="varname">TEST_MAKE</code> with the arguments
10123: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10124: error messages into the file
10125: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10126: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10127: <dd><p>This function is run after the test and is
10128: typically used to compare the actual output from the one that is
10129: expected. It can make use of the various helper functions from
10130: the next section.</p></dd>
10131: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10132: <dd><p>This function cleans everything up after the
10133: test has been run. By default it does nothing.</p></dd>
10134: </dl></div>
10135: </div>
10136: <div class="sect2" lang="en">
10137: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10138: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10139: <div class="variablelist"><dl>
10140: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10141: <dd><p>This function compares the exitcode of the
10142: <span><strong class="command">do_test()</strong></span> function with its first parameter.
10143: If they differ, the test will fail.</p></dd>
10144: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10145: <dd><p>This function checks for each of its parameters
10146: if the output from <span><strong class="command">do_test()</strong></span> matches the
10147: extended regular expression. If it does not, the test will
10148: fail.</p></dd>
10149: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10150: <dd><p>This function checks for each of its parameters
10151: if the output from <span><strong class="command">do_test()</strong></span> does
10152: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10153: If any of the regular expressions matches, the test will
10154: fail.</p></dd>
10155: </dl></div>
10156: </div>
10157: </div>
10158: </div>
10159: <div class="chapter" lang="en">
10160: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10161: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10162: <div class="toc">
10163: <p><b>Table of Contents</b></p>
10164: <dl>
1.90 rillig 10165: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10166: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10167: </dl>
10168: </div>
10169: <p>The pkgsrc system has already been ported to many
10170: operating systems, hardware architectures and compilers. This
10171: chapter explains the necessary steps to make pkgsrc even more
10172: portable.</p>
10173: <div class="sect1" lang="en">
10174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10175: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10176: <p>To port pkgsrc to a new operating system (called
10177: <code class="literal">MyOS</code> in this example), you need to touch the
10178: following files:</p>
10179: <div class="variablelist"><dl>
1.76 rillig 10180: <dt><span class="term"><code class="filename">bootstrap/mods/mk/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75 rillig 10181: <dd><p>This file contains some basic definitions, for
10182: example the name of the C
10183: compiler.</p></dd>
1.76 rillig 10184: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10185: <dd><p>Insert code that defines the variables
10186: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10187: <code class="varname">LOWER_OS_VERSION</code>,
10188: <code class="varname">LOWER_VENDOR</code>,
10189: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10190: <code class="varname">APPEND_ELF</code>, and the other variables that
10191: appear in this file.</p></dd>
1.76 rillig 10192: <dt><span class="term"><code class="filename">mk/platform/MyOS.mk</code></span></dt>
1.75 rillig 10193: <dd><p>This file contains the platform-specific
10194: definitions that are used by pkgsrc. Start by copying one of the
10195: other files and edit it to your
10196: needs.</p></dd>
1.76 rillig 10197: <dt><span class="term"><code class="filename">mk/platform/MyOS.pkg.dist</code></span></dt>
1.75 rillig 10198: <dd><p>This file contains a list of directories,
10199: together with their permission bits and ownership. These
10200: directories will be created automatically with every package
10201: that does not explicitly set <code class="varname">NO_MTREE</code>. There
10202: have been some discussions about whether this file is needed at
10203: all, but with no result.</p></dd>
1.76 rillig 10204: <dt><span class="term"><code class="filename">mk/platform/MyOS.x11.dist</code></span></dt>
1.75 rillig 10205: <dd><p>Just copy one of the pre-existing x11.dist files
10206: to your
1.76 rillig 10207: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10208: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10209: <dd><p>On some operating systems, the tools that are
10210: provided with the base system are not good enough for pkgsrc.
10211: 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
10212: narrow limit on the line length they can process. Therefore
10213: pkgsrc brings its own tools, which can be enabled
10214: here.</p></dd>
1.76 rillig 10215: <dt><span class="term"><code class="filename">mk/tools/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10216: <dd><p>This file defines the paths to all the tools
10217: that are needed by one or the other package in pkgsrc, as well
10218: as by pkgsrc itself. Find out where these tools are on your
10219: platform and add them.</p></dd>
10220: </dl></div>
10221: <p>Now, you should be able to build some basic packages, like
1.91 ! rillig 10222: <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 10223: </div>
10224: <div class="sect1" lang="en">
10225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10226: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10227: <p>TODO</p>
10228: </div>
10229: </div>
10230: </div>
10231: <div class="appendix" lang="en">
10232: <div class="titlepage"><div><div><h2 class="title">
10233: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10234: <div class="toc">
10235: <p><b>Table of Contents</b></p>
10236: <dl>
10237: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10238: <dd><dl>
10239: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10240: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10241: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10242: <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>
10243: </dl></dd>
10244: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10245: </dl>
10246: </div>
10247: <p>We checked to find a piece of software that wasn't in the packages
10248: collection, and picked GNU bison. Quite why someone would want to have
10249: <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
10250: present in the tree is beyond us, but it's useful for the purposes of
10251: this exercise.</p>
10252: <div class="sect1" lang="en">
10253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10254: <a name="example-files"></a>A.1. files</h2></div></div></div>
10255: <div class="sect2" lang="en">
10256: <div class="titlepage"><div><div><h3 class="title">
10257: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10258: <pre class="programlisting">
1.51 rillig 10259: # $NetBSD$
10260: #
1.1 grant 10261:
1.51 rillig 10262: DISTNAME= bison-1.25
10263: CATEGORIES= devel
10264: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10265:
1.51 rillig 10266: MAINTAINER= thorpej@NetBSD.org
10267: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10268: COMMENT= GNU yacc clone
1.1 grant 10269:
1.51 rillig 10270: GNU_CONFIGURE= yes
10271: INFO_FILES= bison.info
1.1 grant 10272:
1.51 rillig 10273: .include "../../mk/bsd.pkg.mk"
1.1 grant 10274: </pre>
1.75 rillig 10275: </div>
10276: <div class="sect2" lang="en">
10277: <div class="titlepage"><div><div><h3 class="title">
10278: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10279: <pre class="programlisting">
1.51 rillig 10280: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.75 rillig 10281: 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 10282: of the NetBSD source tree is beyond me.
1.1 grant 10283: </pre>
1.75 rillig 10284: </div>
10285: <div class="sect2" lang="en">
10286: <div class="titlepage"><div><div><h3 class="title">
10287: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10288: <pre class="programlisting">
1.51 rillig 10289: @comment $NetBSD$
10290: bin/bison
10291: man/man1/bison.1.gz
10292: share/bison.simple
10293: share/bison.hairy
1.1 grant 10294: </pre>
1.75 rillig 10295: </div>
10296: <div class="sect2" lang="en">
10297: <div class="titlepage"><div><div><h3 class="title">
10298: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></h3></div></div></div>
10299: <p>The NetBSD package system comes with
1.91 ! rillig 10300: <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 10301: which helps to check the contents of these
10302: files. After installation it is quite easy to use, just change to the
10303: directory of the package you wish to examine and execute
10304: <span><strong class="command">pkglint</strong></span>:</p>
10305: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10306: looks fine.</pre>
10307: <p>Depending on the supplied command line arguments (see pkglint(1)),
10308: more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
10309: -Wall</strong></span> for a very thorough check.</p>
10310: </div>
10311: </div>
10312: <div class="sect1" lang="en">
10313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10314: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10315: <p>Create the directory where the package lives,
10316: plus any auxiliary directories:</p>
10317: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10318: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10319: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10320: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10321: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90 rillig 10322: <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 10323: then continue with fetching the distfile:</p>
10324: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10325: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10326: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10327: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10328: ftp: Error retrieving file: 500 Internal error
10329:
10330: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10331: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10332: ftp: Error retrieving file: 500 Internal error
10333:
10334: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10335: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10336: Successfully retrieved file.</pre>
10337: <p>Generate the checksum of the distfile into
1.76 rillig 10338: <code class="filename">distinfo</code>:</p>
1.88 wiz 10339: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10340: <p>Now compile:</p>
10341: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10342: >> Checksum OK for bison-1.25.tar.gz.
10343: ===> Extracting for bison-1.25
10344: ===> Patching for bison-1.25
10345: ===> Ignoring empty patch directory
10346: ===> Configuring for bison-1.25
10347: creating cache ./config.cache
10348: checking for gcc... cc
10349: checking whether we are using GNU C... yes
10350: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10351: checking how to run the C preprocessor... cc -E
10352: checking for minix/config.h... no
10353: checking for POSIXized ISC... no
10354: checking whether cross-compiling... no
10355: checking for ANSI C header files... yes
10356: checking for string.h... yes
10357: checking for stdlib.h... yes
10358: checking for memory.h... yes
10359: checking for working const... yes
10360: checking for working alloca.h... no
10361: checking for alloca... yes
10362: checking for strerror... yes
10363: updating cache ./config.cache
10364: creating ./config.status
10365: creating Makefile
10366: ===> Building for bison-1.25
10367: 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
10368: 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
10369: 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
10370: 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
10371: 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 10372: 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 10373: 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
10374: 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
10375: 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
10376: 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
10377: 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
10378: 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
10379: 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
10380: 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
10381: 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
10382: 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
10383: 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
10384: 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
10385: 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
10386: 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
10387: 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
10388: 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
10389: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10390: rm -f bison.s1
1.75 rillig 10391: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10392: <p>Everything seems OK, so install the files:</p>
10393: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10394: >> Checksum OK for bison-1.25.tar.gz.
10395: ===> Installing for bison-1.25
10396: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10397: rm -f /usr/pkg/bin/bison
10398: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10399: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10400: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10401: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10402: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10403: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10404: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10405: ===> Registering installation for bison-1.25</pre>
10406: <p>You can now use bison, and also - if you decide so - remove it with
10407: <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
10408: binary package, do this now:</p>
10409: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10410: >> Checksum OK for bison-1.25.tar.gz.
10411: ===> Building package for bison-1.25
10412: Creating package bison-1.25.tgz
10413: Registering depends:.
1.75 rillig 10414: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10415: <p>Now that you don't need the source and object files
10416: any more, clean up:</p>
10417: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10418: ===> Cleaning for bison-1.25</pre>
10419: </div>
10420: </div>
10421: <div class="appendix" lang="en">
10422: <div class="titlepage"><div><div><h2 class="title">
10423: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10424: <div class="toc">
10425: <p><b>Table of Contents</b></p>
10426: <dl>
10427: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10428: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10429: </dl>
10430: </div>
10431: <div class="sect1" lang="en">
10432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10433: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10434: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10435: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10436: => figlet221.tar.gz doesn't seem to exist on this system.
10437: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10438: => [172219 bytes]
10439: Connected to ftp.plig.net.
10440: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10441: 331 Guest login ok, send your complete e-mail address as password.
10442: 230-You are user #5 of 500 simultaneous users allowed.
10443: 230-
1.68 rillig 10444: 230- ___ _ _ _
10445: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10446: 230- | _| _| . |_| . | | | . |_| . | _| . |
10447: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10448: 230- |_| |_| |___| |___|
10449: 230-
10450: 230-** Welcome to ftp.plig.org **
10451: 230-
10452: 230-Please note that all transfers from this FTP site are logged. If you
10453: 230-do not like this, please disconnect now.
10454: 230-
10455: 230-This arhive is available via
10456: 230-
10457: 230-HTTP: http://ftp.plig.org/
10458: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10459: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10460: 230-
10461: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10462: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10463: 230-
10464: 230-
10465: 230 Logged in anonymously.
10466: Remote system type is UNIX.
10467: Using binary mode to transfer files.
10468: 200 Type okay.
10469: 250 "/pub" is new cwd.
10470: 250-"/pub/figlet" is new cwd.
10471: 250-
10472: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10473: 250-
1.75 rillig 10474: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10475: 250-
10476: 250-The official FIGlet web page is:
1.75 rillig 10477: 250- http://www.figlet.org/
1.1 grant 10478: 250-
10479: 250-If you have questions, please mailto:info@figlet.org. If you want to
10480: 250-contribute a font or something else, you can email us.
1.68 rillig 10481: 250
1.1 grant 10482: 250 "/pub/figlet/program" is new cwd.
10483: 250 "/pub/figlet/program/unix" is new cwd.
10484: local: figlet221.tar.gz remote: figlet221.tar.gz
10485: 502 Unimplemented command.
10486: 227 Entering Passive Mode (195,40,6,41,246,104)
10487: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10488: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10489: 226 Transfer completed.
10490: 172219 bytes received in 00:02 (75.99 KB/s)
10491: 221 Goodbye.
10492: => Checksum OK for figlet221.tar.gz.
10493: ===> Extracting for figlet-2.2.1nb2
10494: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10495: ===> Patching for figlet-2.2.1nb2
10496: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10497: ===> Overriding tools for figlet-2.2.1nb2
10498: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10499: ===> Configuring for figlet-2.2.1nb2
10500: ===> Building for figlet-2.2.1nb2
10501: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10502: chmod a+x figlet
10503: gcc -O2 -o chkfont chkfont.c
10504: => Unwrapping files-to-be-installed.
1.14 xtraeme 10505: <code class="prompt">#</code>
1.75 rillig 10506: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10507: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10508: ===> Installing for figlet-2.2.1nb2
10509: install -d -o root -g wheel -m 755 /usr/pkg/bin
10510: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10511: mkdir -p /usr/pkg/share/figlet
10512: cp figlet /usr/pkg/bin
10513: cp chkfont /usr/pkg/bin
10514: chmod 555 figlist showfigfonts
10515: cp figlist /usr/pkg/bin
10516: cp showfigfonts /usr/pkg/bin
10517: cp fonts/*.flf /usr/pkg/share/figlet
10518: cp fonts/*.flc /usr/pkg/share/figlet
10519: cp figlet.6 /usr/pkg/man/man6
10520: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10521: <code class="prompt">#</code></pre>
10522: </div>
10523: <div class="sect1" lang="en">
10524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10525: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10526: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10527: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10528: ===> Packaging figlet-2.2.1nb2
10529: ===> Building binary package for figlet-2.2.1nb2
10530: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10531: Using SrcDir value of /usr/pkg
1.68 rillig 10532: Registering depends:.
1.75 rillig 10533: <code class="prompt">#</code></pre>
10534: </div>
10535: </div>
10536: <div class="appendix" lang="en">
10537: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10538: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10539: <div class="toc">
10540: <p><b>Table of Contents</b></p>
10541: <dl>
10542: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10543: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10544: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10545: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10546: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
10547: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
10548: <code class="filename">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
10549: source packages</a></span></dt>
10550: </dl>
10551: </div>
10552: <p>As in other big projects, the directory layout of pkgsrc
10553: is quite complex for newbies. This chapter explains where you
10554: find things on the FTP server. The base directory on
1.89 rillig 10555: <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>.
10556: On other servers it may be different, but inside this directory,
10557: everything should look the same, no matter on which server you
10558: are. This directory contains some subdirectories, which are
10559: explained below.</p>
1.76 rillig 10560: <div class="sect1" lang="en">
10561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10562: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
10563: <p>For those who only want to manage binary packages on
10564: systems other than NetBSD, we provide the package management
10565: tools in a separate, small tar file.</p>
10566: </div>
10567: <div class="sect1" lang="en">
10568: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10569: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10570: <p>The directory <code class="filename">distfiles</code> contains lots
10571: of archive files from all pkgsrc packages, which are mirrored
10572: here. The subdirectories are called after their package names
10573: and are used when the distributed files have names that don't
10574: explicitly contain a version number or are otherwise too generic
10575: (for example <code class="filename">release.tar.gz</code>).</p>
10576: </div>
10577: <div class="sect1" lang="en">
10578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10579: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10580: <p>This directory is currently not in use.</p>
10581: </div>
10582: <div class="sect1" lang="en">
10583: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10584: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10585: <p>This directory contains things that individual pkgsrc
10586: developers find worth publishing.</p>
10587: </div>
10588: <div class="sect1" lang="en">
10589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10590: <a name="ftp-packages"></a>C.5. <code class="filename">packages*</code>: Binary packages</h2></div></div></div>
10591: <p>These directories contain binary packages. Those
10592: directories that have a branch name
10593: (200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>)
10594: contain packages from that particular branch. The directory
10595: <code class="filename">packages</code> contains binary packages from
10596: pkgsrc-current. (However, this does not necessarily mean that
10597: the packages are still current anymore.)</p>
10598: <p>Below the <code class="filename">packages*</code> directories are
10599: directories that distinguish the packages by operating system
10600: and version, the next directory level specifies the hardware
10601: architecture.</p>
10602: <p>In each of the platform-specific directories, there is a
10603: whole binary packages collection. It has a directory called
10604: <code class="filename">All</code> which contains all binary packages.
10605: Besides that, there are various category directories that
10606: contain symbolic links to the real binary packages.</p>
10607: </div>
10608: <div class="sect1" lang="en">
10609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10610: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
10611: <code class="filename">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
10612: source packages</h2></div></div></div>
10613: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
10614: that is the files that define how to create binary packages from
10615: source archives.</p>
10616: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10617: snapshot of the CVS repository, which is updated regularly. The
10618: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10619: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10620: <p>In the directories for the quarterly branches, there is an
10621: additional file called
10622: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10623: which contains the state of pkgsrc when it was branched.</p>
10624: </div>
1.75 rillig 10625: </div>
10626: <div class="appendix" lang="en">
10627: <div class="titlepage"><div><div><h2 class="title">
10628: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
10629: <div class="toc">
10630: <p><b>Table of Contents</b></p>
10631: <dl>
1.79 rillig 10632: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10633: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10634: </dl>
10635: </div>
1.79 rillig 10636: <p>This section contains information on editing the pkgsrc
10637: guide itself.</p>
1.75 rillig 10638: <div class="sect1" lang="en">
10639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10640: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10641: <p>The pkgsrc guide's source code is stored in
10642: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10643: are created from it:</p>
10644: <div class="itemizedlist"><ul type="disc">
10645: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10646: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10647: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/</a></p></li>
10648: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</a>:
10649: The PDF version of the pkgsrc guide.</p></li>
10650: <li><p><a href="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</a>:
10651: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10652: </ul></div>
10653: </div>
10654: <div class="sect1" lang="en">
10655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10656: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10657: <p>The procedure to edit the pkgsrc guide is:</p>
10658: <div class="procedure"><ol type="1">
10659: <li><p>Make sure you have the packages needed to
1.83 wiz 10660: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 ! rillig 10661: 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
! 10662: 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 10663: PostScript and PDF versions. You will need both packages
10664: installed, to make sure documentation is consistent across all
10665: formats.</p></li>
10666: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
10667: right directory. All further steps will take place
10668: here.</p></li>
10669: <li><p>Edit the XML file(s) in
10670: <code class="filename">files/</code>.</p></li>
10671: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
10672: guide for valid XML and to build the final output files. If you
10673: get any errors at this stage, you can just edit the files, as
10674: there are only symbolic links in the working directory, pointing
10675: to the files in <code class="filename">files/</code>.</p></li>
10676: <li><p><span><strong class="command">(cd files && cvs
10677: commit)</strong></span></p></li>
10678: <li><p>Run <span><strong class="command">bmake clean && bmake</strong></span> to
10679: regenerate the output files with the proper RCS
10680: Ids.</p></li>
1.91 ! rillig 10681: <li>
! 10682: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
! 10683: commit the files in both <code class="filename">pkgsrc/doc</code> and
! 10684: <code class="filename">htdocs</code>.</p>
! 10685: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
! 10686: <h3 class="title">Note</h3>
! 10687: <p>If you have added, removed or renamed some chapters,
1.83 wiz 10688: you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
10689: <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91 ! rillig 10690: directory.</p>
! 10691: </div>
! 10692: </li>
1.79 rillig 10693: </ol></div>
1.75 rillig 10694: </div>
10695: </div>
10696: </div></body>
1.1 grant 10697: </html>
CVSweb <webmaster@jp.NetBSD.org>