Annotation of pkgsrc/doc/pkgsrc.html, revision 1.128
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.101 rillig 6: <link rel="stylesheet" href="/global.css" type="text/css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
1.128 ! wiz 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="The pkgsrc guide">
1.75 rillig 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>
1.110 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.75 rillig 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.104 rillig 33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.106 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.128 ! wiz 35: <div><div class="abstract" title="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>
1.128 ! wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 69: </dl></dd>
70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
71: <dd><dl>
72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
74: </dl></dd>
75: </dl></dd>
76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
77: <dd><dl>
1.82 rillig 78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
81: <dd><dl>
82: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
83: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
84: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
85: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
86: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
87: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
88: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 89: </dl></dd>
90: </dl></dd>
91: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
92: <dd><dl>
93: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
94: <dd><dl>
95: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
96: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 97: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
98: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
99: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
100: <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>
101: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
102: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 103: </dl></dd>
104: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
105: <dd><dl>
106: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
107: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
108: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
109: </dl></dd>
110: </dl></dd>
111: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
112: <dd><dl>
113: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
114: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 115: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 116: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 117: <dd><dl>
1.103 wiz 118: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 ! wiz 119: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
! 120: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 121: </dl></dd>
1.103 wiz 122: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
123: <dt><span class="sect1"><a href="#selecting-build-options">5.6. 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>
1.106 rillig 129: </dl></dd>
130: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
131: builds)</a></span></dt>
1.75 rillig 132: <dd><dl>
1.106 rillig 133: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
134: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
135: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
136: <dd><dl>
137: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
138: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
139: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
140: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
141: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
142: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
143: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
144: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
145: </dl></dd>
146: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 147: <dd><dl>
148: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
149: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
150: </dl></dd>
1.106 rillig 151: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
152: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
153: </dl></dd>
154: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
155: <dd><dl>
1.128 ! wiz 156: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
! 157: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106 rillig 158: </dl></dd>
159: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
160: <dd><dl>
161: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
162: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
163: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
164: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
165: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
166: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
167: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.128 ! wiz 168: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106 rillig 169: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.128 ! wiz 170: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
! 171: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
! 172: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.106 rillig 173: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
174: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
175: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.128 ! wiz 176: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.106 rillig 177: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.128 ! wiz 178: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 179: </dl></dd>
180: </dl></dd>
181: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
182: <dd><dl>
1.106 rillig 183: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 184: <dd><dl>
1.106 rillig 185: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 186: <dd><dl>
1.106 rillig 187: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
188: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 189: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 190: </dl></dd>
1.106 rillig 191: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
192: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
193: </dl></dd>
194: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
195: <dd><dl>
1.128 ! wiz 196: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
! 197: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 198: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
199: <dd><dl>
200: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
201: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
202: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
203: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
204: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
205: </dl></dd>
206: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
207: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
208: <dd><dl>
209: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
210: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
211: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
212: </dl></dd>
1.128 ! wiz 213: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
! 214: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 215: </dl></dd>
1.128 ! wiz 216: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 217: <dd><dl>
218: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 ! wiz 219: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 220: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
221: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
222: <dd><dl>
223: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
224: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
225: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
226: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
227: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
228: </dl></dd>
229: </dl></dd>
230: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
231: <dd><dl>
232: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 ! wiz 233: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
! 234: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 235: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
236: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 ! wiz 237: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106 rillig 238: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
239: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
240: </dl></dd>
241: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
242: <dd><dl>
243: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 ! wiz 244: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 245: <dd><dl>
246: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.128 ! wiz 247: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.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.106 rillig 248: </dl></dd>
1.128 ! wiz 249: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106 rillig 250: <dd><dl>
1.128 ! wiz 251: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106 rillig 252: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
253: </dl></dd>
254: </dl></dd>
255: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
256: <dd><dl>
257: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
258: <dd><dl>
259: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
260: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
261: </dl></dd>
262: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
263: <dd><dl>
1.128 ! wiz 264: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106 rillig 265: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
266: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
267: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
268: </dl></dd>
269: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
270: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
271: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
272: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
273: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
274: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
275: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
276: </dl></dd>
277: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
278: <dd><dl>
279: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 ! wiz 280: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106 rillig 281: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 282: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 283: </dl></dd>
284: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
285: <dd><dl>
286: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
287: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
288: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
289: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 ! wiz 290: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 291: <dd><dl>
292: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
293: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
294: </dl></dd>
1.128 ! wiz 295: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
! 296: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
! 297: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
! 298: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
! 299: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
! 300: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
! 301: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
! 302: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
! 303: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
! 304: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 305: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
306: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
307: </dl></dd>
308: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
309: <dd><dl>
310: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
311: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
312: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
313: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
314: </dl></dd>
315: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
316: <dd><dl>
317: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
318: <dd><dl>
319: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 ! wiz 320: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106 rillig 321: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
322: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
323: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
324: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
325: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
326: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
327: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
328: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
329: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
330: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
331: </dl></dd>
1.128 ! wiz 332: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 333: <dd><dl>
334: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
335: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
336: </dl></dd>
1.128 ! wiz 337: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106 rillig 338: <dd><dl>
339: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
340: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
341: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
342: </dl></dd>
343: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
344: <dd><dl>
345: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
346: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
347: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
348: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
349: </dl></dd>
1.128 ! wiz 350: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106 rillig 351: <dd><dl>
352: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
353: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 ! wiz 354: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.106 rillig 355: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
356: </dl></dd>
1.128 ! wiz 357: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106 rillig 358: <dd><dl>
359: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
360: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
361: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
362: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
363: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
364: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
365: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
366: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 367: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 368: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 369: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
370: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
371: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
372: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
373: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
374: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
375: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
376: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 377: emulation</a></span></dt>
1.106 rillig 378: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
379: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 380: </dl></dd>
1.106 rillig 381: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 382: </dl></dd>
1.106 rillig 383: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
384: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 385: <dd><dl>
1.106 rillig 386: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
387: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
388: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
389: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
390: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 391: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
392: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 393: </dl></dd>
394: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
395: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
396: <dd><dl>
397: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
398: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
399: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
400: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 401: </dl></dd>
1.75 rillig 402: </dl></dd>
403: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
404: <dd><dl>
1.106 rillig 405: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 406: <dd><dl>
1.106 rillig 407: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
408: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
409: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 410: <dd><dl>
1.106 rillig 411: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
412: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 413: </dl></dd>
1.106 rillig 414: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
415: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 416: <dd><dl>
1.106 rillig 417: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
418: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 419: </dl></dd>
1.106 rillig 420: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 421: <dd><dl>
1.128 ! wiz 422: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
! 423: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 424: </dl></dd>
425: </dl></dd>
1.106 rillig 426: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 427: <dd><dl>
1.106 rillig 428: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
429: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
430: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 431: <dd><dl>
1.106 rillig 432: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
433: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 434: </dl></dd>
435: </dl></dd>
1.106 rillig 436: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 437: <dd><dl>
1.106 rillig 438: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
439: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 440: </dl></dd>
441: </dl></dd>
442: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
443: <dd><dl>
444: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
445: <dd><dl>
446: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
447: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
448: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 ! wiz 449: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75 rillig 450: </dl></dd>
451: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
452: </dl></dd>
453: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
454: <dd><dl>
455: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
456: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
457: </dl></dd>
1.76 rillig 458: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
459: <dd><dl>
1.128 ! wiz 460: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
! 461: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
! 462: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
! 463: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
! 464: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
! 465: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 466: source packages</a></span></dt>
467: </dl></dd>
1.75 rillig 468: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
469: <dd><dl>
1.79 rillig 470: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 471: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
472: </dl></dd>
473: </dl>
474: </div>
1.82 rillig 475: <div class="list-of-tables">
476: <p><b>List of Tables</b></p>
477: <dl>
478: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
479: </dt>
1.106 rillig 480: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 481: </dt>
1.106 rillig 482: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 483: </dt>
1.82 rillig 484: </dl>
485: </div>
1.128 ! wiz 486: <div class="chapter" title="Chapter 1. What is pkgsrc?">
1.75 rillig 487: <div class="titlepage"><div><div><h2 class="title">
488: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
489: <div class="toc">
490: <p><b>Table of Contents</b></p>
491: <dl>
492: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 493: <dd><dl>
494: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
495: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
496: </dl></dd>
1.75 rillig 497: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
498: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 499: <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 500: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
501: </dl>
502: </div>
1.128 ! wiz 503: <div class="sect1" title="1.1. Introduction">
1.75 rillig 504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
505: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 506: <p>There is a lot of software freely available for Unix-based
507: systems, which is usually available in form of the source code. Before
508: such software can be used, it needs to be configured to the local
509: system, compiled and installed, and this is exactly what The NetBSD
510: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
511: to handle binary packages, so that not every user has to build the
512: packages for himself, which is a time-costly task.</p>
1.75 rillig 513: <p>pkgsrc currently contains several thousand packages,
514: including:</p>
1.128 ! wiz 515: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 516: <li class="listitem"><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 517: web server</p></li>
1.128 ! wiz 518: <li class="listitem"><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 519: web browser</p></li>
1.128 ! wiz 520: <li class="listitem"><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 521: Desktop Environment</p></li>
1.128 ! wiz 522: <li class="listitem"><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 523: Desktop Environment</p></li>
524: </ul></div>
525: <p>...just to name a few.</p>
526: <p>pkgsrc has built-in support for handling varying dependencies,
527: such as pthreads and X11, and extended features such as IPv6 support on
528: a range of platforms.</p>
1.128 ! wiz 529: <div class="sect2" title="1.1.1. Why pkgsrc?">
1.82 rillig 530: <div class="titlepage"><div><div><h3 class="title">
531: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
532: <p>
533: pkgsrc provides the following key features:
534: </p>
1.128 ! wiz 535: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 536: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 537: and installation of binary packages. The source and latest
538: patches are retrieved from a master or mirror download site, checksum
539: verified, then built on your system. Support for binary-only
540: distributions is available for both native platforms and NetBSD
541: emulated platforms.</p></li>
1.128 ! wiz 542: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 543: including binaries, libraries, man pages and other
544: documentation.</p></li>
1.128 ! wiz 545: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82 rillig 546: are handled automatically. The configuration files of various
547: packages are handled automatically during updates, so local changes
548: are preserved.</p></li>
1.128 ! wiz 549: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 550: consists of highly portable code. This allows the greatest speed of
551: development when porting to new a platform. This portability also
552: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
553: platforms</em></span>.</p></li>
1.128 ! wiz 554: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 555: international encryption requirements and build-time options for a
556: large number of packages are all set in a simple, central
557: configuration file.</p></li>
1.128 ! wiz 558: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 559: freely available under a BSD license, so you may extend and adapt
560: pkgsrc to your needs. Support for local packages and patches is
561: available right out of the box, so you can configure it specifically
562: for your environment.</p></li>
563: </ul></div>
1.91 rillig 564: <p>The following principles are basic to pkgsrc:</p>
1.128 ! wiz 565: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 566: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 567: — That means, if a package contains bugs, it's better to find
1.91 rillig 568: them and to complain about them rather than to just install the package
569: and hope that it works. There are numerous checks in pkgsrc that try to
570: 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
571: of shell scripts), and post-installation checks (installed files,
572: references to shared libraries, script interpreters).</p></li>
1.128 ! wiz 573: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 574: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 575: pkgsrc has been ported to many operating systems. Care is taken that
576: packages behave the same on all platforms.</p></li>
577: </ul></div>
1.82 rillig 578: </div>
1.128 ! wiz 579: <div class="sect2" title="1.1.2. Supported platforms">
1.82 rillig 580: <div class="titlepage"><div><div><h3 class="title">
581: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
582: <p>pkgsrc consists of both a source distribution and a binary
583: distribution for these operating systems. After retrieving the required
584: source or binaries, you can be up and running with pkgsrc in just
585: minutes!</p>
1.75 rillig 586: <p>pkgsrc was derived from FreeBSD's ports system, and
587: initially developed for NetBSD only. Since then, pkgsrc has
588: grown a lot, and now supports the following platforms:</p>
1.82 rillig 589: <div class="table">
590: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 591: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 592: <colgroup>
593: <col>
594: <col>
595: </colgroup>
596: <thead><tr>
597: <th>Platform</th>
598: <th>Date Support Added</th>
599: </tr></thead>
600: <tbody>
601: <tr>
1.110 hubertf 602: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 603: <td align="center">Aug 1997</td>
604: </tr>
605: <tr>
1.110 hubertf 606: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 607: <td align="center">Mar 1999</td>
608: </tr>
609: <tr>
1.110 hubertf 610: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 611: <td align="center">Jun 1999</td>
612: </tr>
613: <tr>
614: <td>
1.110 hubertf 615: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
616: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 617: </td>
618: <td align="center">Oct 2001</td>
619: </tr>
620: <tr>
1.110 hubertf 621: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 622: <td align="center">Nov 2002</td>
623: </tr>
624: <tr>
1.110 hubertf 625: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 626: <td align="center">Nov 2002</td>
627: </tr>
628: <tr>
1.110 hubertf 629: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 630: <td align="center">Dec 2002</td>
631: </tr>
632: <tr>
633: <td>BSD/OS</td>
634: <td align="center">Dec 2003</td>
635: </tr>
636: <tr>
1.110 hubertf 637: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 638: <td align="center">Dec 2003</td>
639: </tr>
640: <tr>
641: <td>
1.110 hubertf 642: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 643: (Microsoft Windows Services for Unix)
644: </td>
645: <td align="center">Mar 2004</td>
646: </tr>
647: <tr>
1.110 hubertf 648: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 649: <td align="center">Oct 2004</td>
650: </tr>
651: <tr>
1.110 hubertf 652: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 653: <td align="center">Nov 2004</td>
654: </tr>
1.98 wiz 655: <tr>
1.110 hubertf 656: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 657: <td align="center">Apr 2007</td>
658: </tr>
1.128 ! wiz 659: <tr>
! 660: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
! 661: <td align="center">Sep 2010</td>
! 662: </tr>
1.82 rillig 663: </tbody>
1.91 rillig 664: </table></div>
1.82 rillig 665: </div>
1.91 rillig 666: <br class="table-break">
1.82 rillig 667: </div>
1.75 rillig 668: </div>
1.128 ! wiz 669: <div class="sect1" title="1.2. Overview">
1.75 rillig 670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
671: <a name="overview"></a>1.2. Overview</h2></div></div></div>
672: <p>This document is divided into three parts. The first,
1.110 hubertf 673: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 674: describes how one can use one of the packages in the Package
675: Collection, either by installing a precompiled binary package,
1.93 rillig 676: or by building one's own copy using the NetBSD package system.
1.110 hubertf 677: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75 rillig 678: package so it can be easily built by other NetBSD users without
679: knowing about the package's building details. The third part,
1.110 hubertf 680: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 681: is intended for those who want to understand how pkgsrc is
682: implemented.</p>
683: <p>This document is available in various formats:
1.110 hubertf 684: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75 rillig 685: </div>
1.128 ! wiz 686: <div class="sect1" title="1.3. Terminology">
1.75 rillig 687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
688: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 ! wiz 689: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
! 690: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 691: terminology used within this document.</p>
692: <div class="variablelist"><dl>
693: <dt><span class="term">Package</span></dt>
694: <dd><p>A set of files and building instructions
695: that describe what's necessary
696: to build a certain piece of software using
697: pkgsrc. Packages are traditionally stored under
1.76 rillig 698: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 699: <dt><span class="term">The NetBSD package system</span></dt>
1.128 ! wiz 700: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 701: is part of the NetBSD operating system and can be bootstrapped
702: to run on non-NetBSD operating systems as well. It handles
703: building (compiling), installing, and removing of
704: packages.</p></dd>
1.75 rillig 705: <dt><span class="term">Distfile</span></dt>
706: <dd><p>This term describes the file or files that are
707: provided by the author of the piece of software to
708: distribute his work. All the changes necessary to build on
709: NetBSD are reflected in the corresponding package. Usually
710: the distfile is in the form of a compressed tar-archive,
711: but other types are possible, too. Distfiles are usually
712: stored below
1.76 rillig 713: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 714: <dt><span class="term">Port</span></dt>
715: <dd><p>This is the term used by FreeBSD and OpenBSD people
716: for what we call a package.
1.128 ! wiz 717: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 718: architecture.</p></dd>
719: <dt><span class="term">Precompiled/binary package</span></dt>
720: <dd>
721: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 722: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 723: file so it can be installed on machines of the same
724: machine architecture without the need to
725: recompile. Packages are usually generated in
1.76 rillig 726: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.110 hubertf 727: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 ! wiz 728: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 729: especially in the context of precompiled packages.</p>
730: </dd>
731: <dt><span class="term">Program</span></dt>
1.88 wiz 732: <dd><p>The piece of software to be installed which will be
733: constructed from all the files in the distfile by the
734: actions defined in the corresponding package.</p></dd>
1.75 rillig 735: </dl></div>
1.128 ! wiz 736: <div class="sect2" title="1.3.1. Roles involved in pkgsrc">
1.75 rillig 737: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 738: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75 rillig 739: <div class="variablelist"><dl>
740: <dt><span class="term">pkgsrc users</span></dt>
741: <dd>
742: <p>The
743: pkgsrc users are people who use the packages provided by pkgsrc.
744: Typically they are system administrators. The people using the
1.128 ! wiz 745: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
! 746: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 747: <p>There are two kinds of pkgsrc users: Some only want to
748: install pre-built binary packages. Others build the pkgsrc
749: packages from source, either for installing them directly or for
1.110 hubertf 750: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.75 rillig 751: documentation.</p>
752: </dd>
753: <dt><span class="term">package maintainers</span></dt>
754: <dd><p>A
1.110 hubertf 755: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.75 rillig 756: <dt><span class="term">infrastructure developers</span></dt>
757: <dd><p>These people are involved in all those files
1.76 rillig 758: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 759: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.75 rillig 760: too.</p></dd>
761: </dl></div>
762: </div>
763: </div>
1.128 ! wiz 764: <div class="sect1" title="1.4. Typography">
1.75 rillig 765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
766: <a name="typography"></a>1.4. Typography</h2></div></div></div>
767: <p>When giving examples for commands, shell prompts are used to
768: show if the command should/can be issued as root, or if
1.128 ! wiz 769: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.75 rillig 770: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
771: shell prompt, assuming they use the C-shell or tcsh.</p>
772: </div>
773: </div>
1.128 ! wiz 774: <div class="part" title="Part I. The pkgsrc user's guide">
1.75 rillig 775: <div class="titlepage"><div><div><h1 class="title">
776: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
777: <div class="toc">
778: <p><b>Table of Contents</b></p>
779: <dl>
780: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
781: <dd><dl>
782: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
783: <dd><dl>
784: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.128 ! wiz 785: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 786: </dl></dd>
787: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
788: <dd><dl>
789: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
790: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
791: </dl></dd>
792: </dl></dd>
793: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
794: <dd><dl>
1.82 rillig 795: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
796: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
797: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
798: <dd><dl>
799: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
800: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
801: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
802: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
803: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
804: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
805: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 806: </dl></dd>
807: </dl></dd>
808: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
809: <dd><dl>
810: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
811: <dd><dl>
812: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
813: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 814: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
815: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
816: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
817: <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>
818: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
819: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 820: </dl></dd>
821: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
822: <dd><dl>
823: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
824: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
825: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
826: </dl></dd>
827: </dl></dd>
828: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
829: <dd><dl>
830: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
831: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 832: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 833: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 834: <dd><dl>
1.103 wiz 835: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 ! wiz 836: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
! 837: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 838: </dl></dd>
1.103 wiz 839: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
840: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 841: </dl></dd>
842: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
843: <dd><dl>
844: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
845: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 846: </dl></dd>
847: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
848: builds)</a></span></dt>
1.75 rillig 849: <dd><dl>
1.106 rillig 850: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
851: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
852: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
853: <dd><dl>
854: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
855: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
856: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
857: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
858: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
859: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
860: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
861: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
862: </dl></dd>
863: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 864: <dd><dl>
865: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
866: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
867: </dl></dd>
1.106 rillig 868: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
869: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
870: </dl></dd>
871: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
872: <dd><dl>
1.128 ! wiz 873: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
! 874: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106 rillig 875: </dl></dd>
876: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
877: <dd><dl>
878: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
879: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
880: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
881: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
882: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
883: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
884: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.128 ! wiz 885: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106 rillig 886: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.128 ! wiz 887: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
! 888: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
! 889: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.106 rillig 890: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
891: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
892: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.128 ! wiz 893: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.106 rillig 894: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.128 ! wiz 895: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 896: </dl></dd>
897: </dl>
898: </div>
1.128 ! wiz 899: <div class="chapter" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">
1.75 rillig 900: <div class="titlepage"><div><div><h2 class="title">
901: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
902: <div class="toc">
903: <p><b>Table of Contents</b></p>
904: <dl>
905: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
906: <dd><dl>
907: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.128 ! wiz 908: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 909: </dl></dd>
910: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
911: <dd><dl>
912: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
913: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
914: </dl></dd>
915: </dl>
916: </div>
1.91 rillig 917: <p>Before you download and extract the files, you need to decide
918: where you want to extract them. When using pkgsrc as root user, pkgsrc
919: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
920: free to install the sources and binary packages wherever you want in
921: your filesystem, provided that the pathname does not contain white-space
922: or other characters that are interpreted specially by the shell and some
923: other programs. A safe bet is to use only letters, digits, underscores
924: and dashes.</p>
1.128 ! wiz 925: <div class="sect1" title="2.1. Getting pkgsrc for the first time">
1.75 rillig 926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
927: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
928: <p>Before you download any pkgsrc files, you should decide
929: whether you want the <span class="emphasis"><em>current</em></span> branch or the
930: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
931: quarterly basis from the current branch and only gets modified
932: for security updates. The names of the stable branches are built
933: from the year and the quarter, for example
1.124 snj 934: <code class="literal">2009Q1</code>.</p>
1.75 rillig 935: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 ! wiz 936: want to download pkgsrc. You can get it as a tar file or via CVS.
! 937: Both ways are described here.</p>
! 938: <div class="sect2" title="2.1.1. As tar file">
1.75 rillig 939: <div class="titlepage"><div><div><h3 class="title">
940: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
941: <p>The primary download location for all pkgsrc files is
1.110 hubertf 942: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.75 rillig 943: number of subdirectories for different purposes, which are
1.110 hubertf 944: described in detail in <a class="xref" 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 945: <p>The tar file for the current branch is in the directory
1.110 hubertf 946: <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75 rillig 947: It is autogenerated daily.</p>
1.124 snj 948: <p>The tar file for the stable branch 2009Q1 is in the
949: directory <code class="filename">pkgsrc-2009Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2009Q1/pkgsrc-2009Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2009Q1.tar.gz</code></a>.</p>
1.112 weinem 950: <p>To download a pkgsrc stable tarball, run:</p>
951: <pre class="screen">
1.126 jakllsch 952: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz</code></strong></pre>
953: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 954: stable branch to be downloaded, for example,
1.128 ! wiz 955: <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span>.</p>
1.112 weinem 956: <p>Then, extract it with:</p>
1.126 jakllsch 957: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz -C /usr</code></strong></pre>
1.112 weinem 958: <p>This will create the directory <code class="filename">pkgsrc/</code>
959: in <code class="filename">/usr/</code> and all the package source will be
960: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
961: <p>To download pkgsrc-current, run:</p>
962: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75 rillig 963: </div>
1.128 ! wiz 964: <div class="sect2" title="2.1.2. Via anonymous CVS">
1.75 rillig 965: <div class="titlepage"><div><div><h3 class="title">
1.128 ! wiz 966: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
! 967: <p>To fetch a specific pkgsrc stable branch, run:</p>
! 968: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
! 969: </pre>
! 970: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
! 971: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span></p>
! 972: <p>This will create the directory <code class="filename">pkgsrc/</code>
! 973: in your <code class="filename">/usr/</code> directory and all the package source
! 974: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
! 975: <p>To fetch the pkgsrc current branch, run:</p>
! 976: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 grant 977: </pre>
1.128 ! wiz 978: <p>Refer to <a class="ulink" href="http://NetBSD.org/FIXME" target="_top">list of available CVS mirrors</a> to choose faster one.</p>
! 979: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
! 980: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
! 981: </pre>
! 982: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
! 983: For Bourne shells, you can set it in your <code class="filename">.profile</code>
! 984: or better globally in <code class="filename">/etc/profile</code>:</p>
! 985: <pre class="programlisting">
! 986: # set CVS remote shell command
! 987: CVS_RSH=ssh
! 988: export CVS_RSH
! 989: </pre>
! 990: <p>By default, CVS doesn't do things like most people would expect it to do.
! 991: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
! 992: in your home directory and saving the following lines to it.
! 993: This file will save you lots of headache and some bug reports, so we strongly recommend it.
! 994: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 995: <pre class="programlisting">
996: # recommended CVS configuration file from the pkgsrc guide
1.128 ! wiz 997: cvs -q -z3
1.101 rillig 998: checkout -P
1.103 wiz 999: update -dP
1000: diff -upN
1.101 rillig 1001: rdiff -u
1.128 ! wiz 1002: release -d
1.101 rillig 1003: </pre>
1.75 rillig 1004: </div>
1005: </div>
1.128 ! wiz 1006: <div class="sect1" title="2.2. Keeping pkgsrc up-to-date">
1.75 rillig 1007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1008: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1009: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1010: (which also works if you have first installed it via a tar
1011: file). It saves bandwidth and hard disk activity, compared to
1012: downloading the tar file again.</p>
1.128 ! wiz 1013: <div class="sect2" title="2.2.1. Via tar files">
1.75 rillig 1014: <div class="titlepage"><div><div><h3 class="title">
1015: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.128 ! wiz 1016: <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1017: <h3 class="title">Warning</h3>
1.77 rillig 1018: <p>When updating from a tar file, you first need to
1019: completely remove the old pkgsrc directory. Otherwise those
1020: files that have been removed from pkgsrc in the mean time will
1021: not be removed on your local disk, resulting in inconsistencies.
1022: When removing the old files, any changes that you have done to
1023: the pkgsrc files will be lost after updating. Therefore updating
1024: via CVS is strongly recommended.</p>
1.75 rillig 1025: </div>
1.82 rillig 1026: <p>Note that by default the distfiles and the binary packages
1027: are saved in the pkgsrc tree, so don't forget to rescue them
1028: before updating. You can also configure pkgsrc to use other than
1029: the default directories by setting the
1030: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1031: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1032: <p>To update pkgsrc from a tar file, download the tar file as
1033: explained above. Then, make sure that you have not made any
1034: changes to the files in the pkgsrc directory. Remove the pkgsrc
1035: directory and extract the new tar file. Done.</p>
1036: </div>
1.128 ! wiz 1037: <div class="sect2" title="2.2.2. Via CVS">
1.75 rillig 1038: <div class="titlepage"><div><div><h3 class="title">
1039: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1040: <p>To update pkgsrc via CVS, make sure the environment
1041: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.113 weinem 1042: change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1043: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
1044: <code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1.128 ! wiz 1045: <div class="sect3" title="2.2.2.1. Switching between different pkgsrc branches">
1.75 rillig 1046: <div class="titlepage"><div><div><h4 class="title">
1047: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1048: <p>When updating pkgsrc, the CVS program keeps track of the
1049: branch you selected. But if you, for whatever reason, want to
1050: switch from the stable branch to the current one, you can do it
1.128 ! wiz 1051: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
! 1052: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1053: back to the stable branch, add the
1.128 ! wiz 1054: <span class="quote">“<span class="quote">-rpkgsrc-2009Q3</span>”</span> option.</p>
1.75 rillig 1055: </div>
1.128 ! wiz 1056: <div class="sect3" title="2.2.2.2. What happens to my changes when updating?">
1.75 rillig 1057: <div class="titlepage"><div><div><h4 class="title">
1058: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1059: <p>When you update pkgsrc, the CVS program will only touch
1060: those files that are registered in the CVS repository. That
1061: means that any packages that you created on your own will stay
1062: unmodified. If you change files that are managed by CVS, later
1063: updates will try to merge your changes with those that have been
1064: done by others. See the CVS manual, chapter
1.128 ! wiz 1065: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1066: </div>
1067: </div>
1068: </div>
1069: </div>
1.128 ! wiz 1070: <div class="chapter" title="Chapter 3. Using pkgsrc on systems other than NetBSD">
1.75 rillig 1071: <div class="titlepage"><div><div><h2 class="title">
1072: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1073: <div class="toc">
1074: <p><b>Table of Contents</b></p>
1075: <dl>
1.82 rillig 1076: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1077: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1078: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1079: <dd><dl>
1080: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1081: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1082: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1083: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1084: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1085: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1086: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1087: </dl></dd>
1088: </dl>
1089: </div>
1.128 ! wiz 1090: <div class="sect1" title="3.1. Binary distribution">
1.75 rillig 1091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1092: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1093: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.82 rillig 1094: </div>
1.128 ! wiz 1095: <div class="sect1" title="3.2. Bootstrapping pkgsrc">
1.82 rillig 1096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1097: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1098: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1099: <pre class="screen">
1100: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1101: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1102: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1103: </pre>
1.110 hubertf 1104: <p>See <a class="xref" 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 1105: pkgsrc before bootstrapping. The given
1.110 hubertf 1106: <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.87 wiz 1107: <code class="filename">/usr/pkg</code> for the
1108: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1109: and <code class="filename">/var/db/pkg</code> for the package database
1110: directory where pkgsrc will do its internal bookkeeping.
1111: However, these can also be set using command-line
1112: arguments.</p>
1.128 ! wiz 1113: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1114: <h3 class="title">Note</h3>
1.110 hubertf 1115: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1116: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1117: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 ! wiz 1118: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1119: </div>
1120: </div>
1.128 ! wiz 1121: <div class="sect1" title="3.3. Platform-specific notes">
1.75 rillig 1122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1123: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1124: <p>Here are some platform-specific notes you should be aware of.</p>
1.128 ! wiz 1125: <div class="sect2" title="3.3.1. Darwin (Mac OS X)">
1.75 rillig 1126: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1127: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.126 jakllsch 1128: <p>Darwin 5.x and up are supported. Before you start, you
1129: will need to download and install the Mac OS X Developer Tools
1130: from Apple's Developer Connection. See
1131: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1132: for details. Also, make sure you install X11 (an optional
1133: package included with the Developer Tools) if you intend to
1134: build packages that use the X11 Window System.</p>
1.75 rillig 1135: </div>
1.128 ! wiz 1136: <div class="sect2" title="3.3.2. FreeBSD">
1.75 rillig 1137: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1138: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1139: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1140: other versions may work.</p>
1.75 rillig 1141: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1142: with the FreeBSD userland tools. There are several steps:</p>
1.128 ! wiz 1143: <div class="orderedlist"><ol class="orderedlist" type="1">
! 1144: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 1145: <code class="filename">/var/db/pkg</code>. It is therefore
1146: recommended that you choose a different location (e.g.
1147: <code class="filename">/usr/pkgdb</code>) by
1148: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 ! wiz 1149: <li class="listitem">
1.75 rillig 1150: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1151: good idea to move them out of the way to avoid confusion, e.g.</p>
1152: <pre class="screen">
1153: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1154: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1155: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1156: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1157: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1158: </pre>
1.75 rillig 1159: </li>
1.128 ! wiz 1160: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1161: <code class="filename">/etc/mk.conf.example</code> file
1162: when you use the bootstrap script.</p></li>
1.75 rillig 1163: </ol></div>
1164: </div>
1.128 ! wiz 1165: <div class="sect2" title="3.3.3. Interix">
1.75 rillig 1166: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1167: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1168: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1169: providing a Unix-like environment with a tighter kernel integration than
1170: available with Cygwin. It is part of the Windows Services for Unix
1171: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1172: (not including XP Home), or 2003. SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93 rillig 1173: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1174: are not officially supported. (The main difference in 3.0/3.1 is lack
1175: of pthreads, but other parts of libc may also be lacking.)</p>
1176: <p>Services for Unix Applications (aka SUA) is an integrated component
1.128 ! wiz 1177: of Windows Server 2003 R2 (5.2), Windows Vista and Windows Server 2008
! 1178: (6.0), Windows 7 and Windows Server 2008 R2 (6.1). As of this writing,
! 1179: SUA's Interix 6.0 (32bit) subsystem has been tested. 6.0 (64bit) and 6.1
! 1180: (both 32bit and 64bit) may work.
1.95 tron 1181: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.128 ! wiz 1182: <div class="sect3" title="3.3.3.1. When installing Interix/SFU">
1.75 rillig 1183: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1184: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1185: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1186: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.128 ! wiz 1187: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 1188: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
! 1189: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
! 1190: <li class="listitem"><p>Remote Connectivity</p></li>
! 1191: <li class="listitem"><p>Interix SDK</p></li>
1.75 rillig 1192: </ul></div>
1193: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1194: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1195: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1196: pkgsrc (or from a binary package).</p>
1.75 rillig 1197: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1198: not need to be installed, but Remote Connectivity itself should be
1199: installed in order to have a working inetd.</p>
1.75 rillig 1200: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1201: behavior for Interix programs, and whether to make pathnames default to
1202: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1203: enabled. (Without case-sensitivity, a large number of packages including
1204: perl will not build.)</p>
1.75 rillig 1205: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1206: works (via the Data Execution Prevention feature). In order to use
1207: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1208: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1209: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1210: support contract; however, Debian Interix Port has made most Interix
1211: hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.93 rillig 1212: <p>In addition to the hotfix noted above, it may be necessary to
1213: disable Data Execution Prevention entirely to make Interix functional.
1214: This may happen only with certain types of CPUs; the cause is not fully
1215: understood at this time. If gcc or other applications still segfault
1216: repeatedly after installing one of the hotfixes note above, the
1217: following option can be added to the appropriate "boot.ini" line on the
1218: Windows boot drive: /NoExecute=AlwaysOff
1219: (WARNING, this will disable DEP completely, which may be a security
1220: risk if applications are often run as a user in the Administrators
1221: group!)</p>
1.75 rillig 1222: </div>
1.128 ! wiz 1223: <div class="sect3" title="3.3.3.2. What to do if Interix/SFU is already installed">
1.75 rillig 1224: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1225: <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 1226: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1227: with pkgsrc, note the following things.</p>
1.128 ! wiz 1228: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 1229: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1230: Windows Services for UNIX, then click Change. In the installer, choose
1231: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 ! wiz 1232: <li class="listitem">
1.75 rillig 1233: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1234: change the following registry key:</p>
1.75 rillig 1235: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1236: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1237: </li>
1.128 ! wiz 1238: <li class="listitem">
1.75 rillig 1239: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1240: following registry key:</p>
1.75 rillig 1241: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1242: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1243: </li>
1244: </ul></div>
1245: </div>
1.128 ! wiz 1246: <div class="sect3" title="3.3.3.3. Important notes for using pkgsrc">
1.75 rillig 1247: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1248: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1249: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1250: running "pkg_add") must be a member of the local Administrators
1251: group. Such a user must also be used to run the bootstrap. This is
1252: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1253: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1254: automatically complain if this is not the case. This ensures that
1255: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1256: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1257: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1258: NOT be used in conjunction with pkgsrc. If you choose to use them at
1259: the same time as the pkgsrc packages, ensure that you use the proper
1260: pkg_* tools for each type of binary package.</p>
1.75 rillig 1261: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1262: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1263: don't have a termcap/terminfo entry for it, but the following .termcap
1264: entry provides adequate emulation in most cases:</p>
1.75 rillig 1265: <pre class="programlisting">
1.100 rillig 1266: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1267: </pre>
1.75 rillig 1268: </div>
1.128 ! wiz 1269: <div class="sect3" title="3.3.3.4. Limitations of the Interix platform">
1.75 rillig 1270: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1271: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1272: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1273: for a full Unix-like platform, it has some drawbacks that should
1274: be noted for those desiring to make the most of Interix.</p>
1.128 ! wiz 1275: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 1276: <li class="listitem">
1.75 rillig 1277: <p><span class="strong"><strong>X11:</strong></span></p>
1278: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1279: and can run X11 based applications, but it does
1280: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1281: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1282: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1283: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1284: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1285: and the free X11 server included with
1.110 hubertf 1286: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1287: </li>
1.128 ! wiz 1288: <li class="listitem">
1.75 rillig 1289: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1290: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1291: Win32 applications, it does not currently support various X11
1292: protocol extensions for acceleration (such as MIT-SHM or DGA).
1293: Most interactive applications to a local X server will run
1294: reasonably fast, but full motion video and other graphics
1295: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1296: </li>
1.128 ! wiz 1297: <li class="listitem">
1.75 rillig 1298: <p><span class="strong"><strong>Audio:</strong></span></p>
1299: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1300: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1301: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1302: <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.110 hubertf 1303: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1304: server component. To output audio via an Interix host, the
1.91 rillig 1305: <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 1306: must also be installed.</p>
1.75 rillig 1307: </li>
1.128 ! wiz 1308: <li class="listitem">
1.75 rillig 1309: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1310: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1311: is not currently possible to access CD/DVD drives, USB devices,
1312: or SCSI devices through non-filesystem means. Among other things,
1313: this makes it impossible to use Interix directly for CD/DVD
1314: burning.</p>
1.75 rillig 1315: </li>
1.128 ! wiz 1316: <li class="listitem">
1.75 rillig 1317: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1318: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1319: drives are also not directly accessible in Interix. However,
1320: support is in work to make tape drive access possible by using
1321: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1322: esound server).</p>
1.75 rillig 1323: </li>
1324: </ul></div>
1325: </div>
1.128 ! wiz 1326: <div class="sect3" title="3.3.3.5. Known issues for pkgsrc on Interix">
1.75 rillig 1327: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1328: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1329: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1330: Windows system; any member of the local Administrators group will
1331: suffice. However, some packages currently assume that the user
1332: named "root" is the privileged user. To accommodate these, you
1333: may create such a user; make sure it is in the local group
1334: Administrators (or your language equivalent).</p>
1.110 hubertf 1335: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1336: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1337: time being, install packages as the local Administrator (or
1338: your language equivalent), or run the following command after
1339: installing a package to work around the issue:</p>
1.75 rillig 1340: <pre class="screen">
1.87 wiz 1341: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1342: </pre>
1.75 rillig 1343: </div>
1344: </div>
1.128 ! wiz 1345: <div class="sect2" title="3.3.4. IRIX">
1.75 rillig 1346: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1347: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1348: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1349: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1350: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1351: compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75 rillig 1352: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.110 hubertf 1353: version of IRIX providing support for <a class="citerefentry" 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 class="citerefentry" 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>,
1.87 wiz 1354: etc.</p>
1.86 schwarz 1355: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1356: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1357: you start out using "abi=n32", that's what all your packages will be built
1358: with.</p>
1359: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1360: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1361: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1362: try to link n32 object files with lib64 or vice versa. Check your
1363: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1364: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1365: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1366: as it appears that IRIX linker occasionally runs into issues when trying to
1367: link over a network-mounted file system.</p>
1.75 rillig 1368: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1369: as imake(1), but you may want to set some options depending on your local
1370: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1371: course, your compiler's man pages for details.</p>
1.75 rillig 1372: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1373:
1.87 wiz 1374: </p>
1.75 rillig 1375: <pre class="programlisting">
1.100 rillig 1376: PKGSRC_COMPILER= mipspro
1.87 wiz 1377: </pre>
1.75 rillig 1378: <p>
1.1 grant 1379:
1.110 hubertf 1380: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1381: are using gcc and may end up passing invalid flags to the compiler. Note that
1382: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1383: default.</p>
1.75 rillig 1384: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1385: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1386: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1387: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1388: '--preserve-path' flag.</p>
1.75 rillig 1389: </div>
1.128 ! wiz 1390: <div class="sect2" title="3.3.5. Linux">
1.75 rillig 1391: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1392: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1393: <p>Some versions of Linux (for example Debian GNU/Linux) need
1394: either libtermcap or libcurses (libncurses). Installing the
1395: distributions libncurses-dev package (or equivalent) should fix
1396: the problem.</p>
1397: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1398: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1399: i386 have been tested.</p>
1.75 rillig 1400: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1401: directory:</p>
1.75 rillig 1402: <pre class="programlisting">
1.100 rillig 1403: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1404: ac_cv___attribute__=yes ./bootstrap
1.87 wiz 1405: </pre>
1.128 ! wiz 1406: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1407: <h3 class="title">Note</h3>
1408: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1409: </div>
1410: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1411: function, which icc does not support. #undef'ing __attribute__ has the
1412: unfortunate side-effect of breaking many of the Linux header files, which
1413: cannot be compiled properly without __attribute__. The test must be
1414: overridden so that __attribute__ is assumed supported by the
1415: compiler.</p>
1.75 rillig 1416: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.110 hubertf 1417: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1418: <pre class="programlisting">
1.100 rillig 1419: PKGSRC_COMPILER= icc
1.87 wiz 1420: </pre>
1.75 rillig 1421: <p>The default installation directory for icc is
1.87 wiz 1422: <code class="filename">/opt/intel_cc_80</code>, which
1423: is also the pkgsrc default. If you have installed it into a different
1424: directory, set <code class="varname">ICCBASE</code> in
1.110 hubertf 1425: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1426: <pre class="programlisting">
1.100 rillig 1427: ICCBASE= /opt/icc
1.87 wiz 1428: </pre>
1.75 rillig 1429: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1430: provided by icc, so binaries can be run on other systems which do not
1431: have the shared libraries installed.</p>
1432: <p>Libtool, however, extracts a list of libraries from the
1.110 hubertf 1433: <a class="citerefentry" 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
1.87 wiz 1434: records it, throwing away the -Bstatic and -Bdynamic options
1435: interspersed between the libraries. This means that
1436: libtool-linked C++ shared libraries will have a runtime
1437: dependency on the icc libraries until this is fixed in
1438: libtool.</p>
1.75 rillig 1439: </div>
1.128 ! wiz 1440: <div class="sect2" title="3.3.6. OpenBSD">
1.75 rillig 1441: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1442: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1443: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1444: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1445: with the OpenBSD userland tools. There are several steps:</p>
1.128 ! wiz 1446: <div class="orderedlist"><ol class="orderedlist" type="1">
! 1447: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 1448: <code class="filename">/var/db/pkg</code>. It is therefore
1449: recommended that you choose a different location (e.g.
1450: <code class="filename">/usr/pkgdb</code>) by
1451: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 ! wiz 1452: <li class="listitem">
1.75 rillig 1453: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1454: good idea to move them out of the way to avoid confusion, e.g.</p>
1455: <pre class="screen">
1456: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1457: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1458: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1459: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1460: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1461: </pre>
1.75 rillig 1462: </li>
1.128 ! wiz 1463: <li class="listitem">
1.110 hubertf 1464: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1465: <code class="filename">/etc/mk.conf.example</code> file
1466: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1467: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1468: as well. You can work around this by enclosing all the pkgsrc-specific parts
1469: of the file with:</p>
1470: <pre class="programlisting">
1.100 rillig 1471: .ifdef BSD_PKG_MK
1472: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1473: .else
1474: # OpenBSD stuff
1475: .endif
1.87 wiz 1476: </pre>
1.75 rillig 1477: </li>
1478: </ol></div>
1479: </div>
1.128 ! wiz 1480: <div class="sect2" title="3.3.7. Solaris">
1.75 rillig 1481: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1482: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1483: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1484: You will need a working C compiler. Both gcc 2.95.3 and
1485: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1486: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1487: process and to build packages.</p>
1.128 ! wiz 1488: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 1489: <li class="listitem"><p>SUNWsprot</p></li>
! 1490: <li class="listitem"><p>SUNWarc</p></li>
! 1491: <li class="listitem"><p>SUNWbtool</p></li>
! 1492: <li class="listitem"><p>SUNWtoo</p></li>
! 1493: <li class="listitem"><p>SUNWlibm</p></li>
1.75 rillig 1494: </ul></div>
1.78 rillig 1495: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1496: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1497: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1498: your $prefix are in your <code class="varname">PATH</code>. This includes
1499: <code class="filename">/usr/ccs/{bin,lib}</code>
1500: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.128 ! wiz 1501: <div class="sect3" title="3.3.7.1. If you are using gcc">
1.75 rillig 1502: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1503: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1504: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1505: for building all packages.</p>
1.75 rillig 1506: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1507: then either build gcc from
1.91 rillig 1508: <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 1509: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1510: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75 rillig 1511: </div>
1.128 ! wiz 1512: <div class="sect3" title="3.3.7.2. If you are using Sun WorkShop">
1.75 rillig 1513: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1514: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1515: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1516: 5.0)</p>
1.128 ! wiz 1517: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 1518: <li class="listitem"><p>SPROcc
1.87 wiz 1519: - Sun WorkShop Compiler C 5.0</p></li>
1.128 ! wiz 1520: <li class="listitem"><p>SPROcpl
1.87 wiz 1521: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 ! wiz 1522: <li class="listitem"><p>SPROild
1.87 wiz 1523: - Sun WorkShop Incremental Linker</p></li>
1.128 ! wiz 1524: <li class="listitem"><p>SPROlang
1.87 wiz 1525: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1526: </ul></div>
1.96 rillig 1527: <p>You should set the following variables in your
1.110 hubertf 1528: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1529: <pre class="programlisting">
1.100 rillig 1530: CC= cc
1531: CXX= CC
1532: CPP= cc -E
1533: CXXCPP= CC -E
1.96 rillig 1534: </pre>
1.128 ! wiz 1535: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1536: <h3 class="title">Note</h3>
1537: <p>The <code class="varname">CPP</code> setting might break some
1538: packages that use the C preprocessor for processing things other
1539: than C source code.</p>
1540: </div>
1.75 rillig 1541: </div>
1.128 ! wiz 1542: <div class="sect3" title="3.3.7.3. Building 64-bit binaries with SunPro">
1.75 rillig 1543: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1544: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1545: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1546: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1547: <pre class="programlisting">
1.100 rillig 1548: PKGSRC_COMPILER= sunpro
1549: ABI= 64
1.96 rillig 1550: </pre>
1.128 ! wiz 1551: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1552: <h3 class="title">Note</h3>
1553: <p>This setting has been tested for the SPARC
1554: architecture. Intel and AMD machines need some more
1555: work.</p>
1556: </div>
1.75 rillig 1557: </div>
1.128 ! wiz 1558: <div class="sect3" title="3.3.7.4. Common problems">
1.75 rillig 1559: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1560: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110 hubertf 1561: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1562: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1563: The workaround is to use another shell for the configure
1.91 rillig 1564: 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.110 hubertf 1565: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1566: <pre class="programlisting">
1.100 rillig 1567: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1568: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1569: </pre>
1.91 rillig 1570: <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 1571: </div>
1572: </div>
1573: </div>
1574: </div>
1.128 ! wiz 1575: <div class="chapter" title="Chapter 4. Using pkgsrc">
1.75 rillig 1576: <div class="titlepage"><div><div><h2 class="title">
1577: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1578: <div class="toc">
1579: <p><b>Table of Contents</b></p>
1580: <dl>
1581: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1582: <dd><dl>
1583: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1584: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1585: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1586: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1587: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1588: <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>
1589: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1590: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1591: </dl></dd>
1592: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1593: <dd><dl>
1594: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1595: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1596: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1597: </dl></dd>
1598: </dl>
1599: </div>
1600: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1601: is to only install the package tools and to use binary packages
1.128 ! wiz 1602: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
! 1603: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1604: of pkgsrc, too. Then you are able to build your own packages,
1605: and you can still use binary packages from someone else.</p>
1.128 ! wiz 1606: <div class="sect1" title="4.1. Using binary packages">
1.75 rillig 1607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1608: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1609: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1610: server and its mirrors, there are collections of binary packages,
1611: ready to be installed. These binary packages have been built using the
1612: default settings for the directories, that is:</p>
1.128 ! wiz 1613: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 1614: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
! 1615: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
! 1616: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.109 rillig 1617: </ul></div>
1618: <p>If you cannot use these directories for whatever reasons (maybe
1619: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1620: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.128 ! wiz 1621: <div class="sect2" title="4.1.1. Finding binary packages">
1.75 rillig 1622: <div class="titlepage"><div><div><h3 class="title">
1623: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1624: <p>To install binary packages, you first need to know from where
1625: to get them. The first place where you should look is on the main
1.110 hubertf 1626: pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105 weinem 1627: <p>This directory contains binary packages for multiple
1628: platforms. First, select your operating system. (Ignore the
1629: directories with version numbers attached to it, they just exist for
1630: legacy reasons.) Then, select your hardware architecture, and in the
1.128 ! wiz 1631: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1632: <p>In this directory, you often find a file called
1633: <code class="filename">bootstrap.tar.gz</code> which contains the package
1634: management tools. If the file is missing, it is likely that your
1635: operating system already provides those tools. Download the file and
1636: extract it in the <code class="filename">/</code> directory. It will create
1637: the directories <code class="filename">/usr/pkg</code> (containing the tools
1638: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1639: (the database of installed packages).</p>
1.75 rillig 1640: </div>
1.128 ! wiz 1641: <div class="sect2" title="4.1.2. Installing binary packages">
1.75 rillig 1642: <div class="titlepage"><div><div><h3 class="title">
1643: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1644: <p>In the directory from the last section, there is a
1645: subdirectory called <code class="filename">All</code>, which contains all the
1646: binary packages that are available for the platform, excluding those
1647: that may not be distributed via FTP or CDROM (depending on which
1.128 ! wiz 1648: medium you are using).</p>
1.109 rillig 1649: <p>To install packages directly from an FTP or HTTP server, run
1650: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1651: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1652: <pre class="screen">
1653: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1654: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All"</code></strong>
1655: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1656: </pre>
1657: <p>Instead of URLs, you can also use local paths, for example if
1658: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1659: repository. If you want to install packages from multiple sources,
1660: you can separate them by a semicolon in
1661: <code class="varname">PKG_PATH</code>.</p>
1662: <p>After these preparations, installing a package is very
1663: easy:</p>
1664: <pre class="screen">
1665: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1666: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1667: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1668: </pre>
1.75 rillig 1669: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1670: package in question will be installed, too, assuming they are
1671: present where you install from.</p>
1.128 ! wiz 1672: <p>Adding packages might install vulnerable packages.
! 1673: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
! 1674: regularly, especially after installing new packages, and verify
! 1675: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1676: <p>After you've installed packages, be sure to have
1.88 wiz 1677: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1678: <code class="varname">PATH</code> so you can actually start the just
1679: installed program.</p>
1.75 rillig 1680: </div>
1.128 ! wiz 1681: <div class="sect2" title="4.1.3. Deinstalling packages">
1.75 rillig 1682: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1683: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1684: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1685: installed from source code or from a binary package. The
1.110 hubertf 1686: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1687: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1688: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1689: name can be given with or without version number. Wildcards can
1690: also be used to deinstall a set of packages, for example
1691: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1692: so that the shell does not expand them before
1693: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1694: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1695: removes all the packages that require the package in question
1696: and then removes the package itself. For example:
1.82 rillig 1697:
1.88 wiz 1698: </p>
1.82 rillig 1699: <pre class="screen">
1.88 wiz 1700: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1701: </pre>
1.82 rillig 1702: <p>
1703:
1.88 wiz 1704: will remove jpeg and all the packages that used it; this allows
1705: upgrading the jpeg package.</p>
1.82 rillig 1706: </div>
1.128 ! wiz 1707: <div class="sect2" title="4.1.4. Getting information about installed packages">
1.82 rillig 1708: <div class="titlepage"><div><div><h3 class="title">
1709: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1710: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1711: installed packages or binary package files.</p>
1.82 rillig 1712: </div>
1.128 ! wiz 1713: <div class="sect2" title="4.1.5. Checking for security vulnerabilities in installed packages">
1.82 rillig 1714: <div class="titlepage"><div><div><h3 class="title">
1715: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1716: <p>
1.88 wiz 1717: The NetBSD Security-Officer and Packages Groups maintain a list of
1718: known security vulnerabilities to packages which are (or have been)
1719: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1720: FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.88 wiz 1721: </p>
1.82 rillig 1722: <p>
1.125 wiz 1723: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1724: this list can be downloaded
1725: automatically, and a security audit of all packages installed on a system
1726: can take place.
1727: </p>
1.82 rillig 1728: <p>
1.125 wiz 1729: There are two components to auditing. The first
1730: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1731: is for downloading
1.88 wiz 1732: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1733: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1734: installed packages are vulnerable. If a package is vulnerable, you
1735: will see output similar to the following:
1736: </p>
1.82 rillig 1737: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1738: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1739: <p>
1.125 wiz 1740: You may wish to have the
1.110 hubertf 1741: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1742: file downloaded daily so that
1743: it remains current. This may be done by adding an appropriate entry
1744: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1745: </p>
1746: <pre class="screen">
1747: # download vulnerabilities file
1748: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1749: </pre>
1750: <p>
1751: will update the vulnerability list every day at 3AM. You may wish to do
1752: this more often than once a day.
1753:
1754: In addition, you may wish to run the package audit from the daily
1755: security script. This may be accomplished by adding the following
1756: line to <code class="filename">/etc/security.local</code>:
1757: </p>
1758: <pre class="screen">
1759: /usr/sbin/pkg_admin audit
1760: </pre>
1761: <p>
1.88 wiz 1762: </p>
1.82 rillig 1763: </div>
1.128 ! wiz 1764: <div class="sect2" title="4.1.6. Finding if newer versions of your installed packages are in pkgsrc">
1.82 rillig 1765: <div class="titlepage"><div><div><h3 class="title">
1766: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1767: <p>
1.112 weinem 1768: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128 ! wiz 1769: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1770: argument to check if your packages are up-to-date, e.g.
1771: </p>
1772: <pre class="screen">
1773: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1774: ...
1.88 wiz 1775: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1776: </pre>
1.110 hubertf 1777: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1778: package on your system and rebuild any dependencies.
1779: </p>
1.82 rillig 1780: </div>
1.128 ! wiz 1781: <div class="sect2" title="4.1.7. Other administrative functions">
1.82 rillig 1782: <div class="titlepage"><div><div><h3 class="title">
1783: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1784: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1785: administrative functions on the package system.</p>
1.82 rillig 1786: </div>
1.128 ! wiz 1787: <div class="sect2" title="4.1.8. A word of warning">
1.82 rillig 1788: <div class="titlepage"><div><div><h3 class="title">
1789: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1790: <p>Please pay very careful attention to the warnings
1.110 hubertf 1791: expressed in the <a class="citerefentry" 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
1.88 wiz 1792: inherent dangers of installing binary packages which you did
1793: not create yourself, and the security holes that can be
1794: introduced onto your system by indiscriminate adding of such
1795: files.</p>
1.75 rillig 1796: <p>The same warning of course applies to every package you
1.88 wiz 1797: install from source when you haven't completely read and
1798: understood the source code of the package, the compiler that
1799: is used to build the package and all the other tools that are
1800: involved.</p>
1.75 rillig 1801: </div>
1802: </div>
1.128 ! wiz 1803: <div class="sect1" title="4.2. Building packages from source">
1.75 rillig 1804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1805: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1806: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1807: directory now contains a set of packages, organized into
1808: categories. You can browse the online index of packages, or run
1.110 hubertf 1809: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1810: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 1811: 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 1812: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1813: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1814: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1815: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1816: different <code class="varname">LOCALBASE</code> definitions on the same
1817: system (inside a chroot is an exception). </p>
1818: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1819: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.88 wiz 1820: instructions how to create your own packages.</p>
1.128 ! wiz 1821: <div class="sect2" title="4.2.1. Requirements">
1.75 rillig 1822: <div class="titlepage"><div><div><h3 class="title">
1823: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1824: <p>To build packages from source, you need a working C
1.88 wiz 1825: compiler. On NetBSD, you need to install the
1.128 ! wiz 1826: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1827: sets. If you want to build X11-related packages, the
1.128 ! wiz 1828: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1829: sets are required, too.</p>
1.75 rillig 1830: </div>
1.128 ! wiz 1831: <div class="sect2" title="4.2.2. Fetching distfiles">
1.75 rillig 1832: <div class="titlepage"><div><div><h3 class="title">
1833: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1834: <p>The first step for building a package is downloading the
1.88 wiz 1835: distfiles (i.e. the unmodified source). If they have not yet been
1836: downloaded, pkgsrc will fetch them automatically.</p>
1837: <p>If you have all files that you need in the
1838: <code class="filename">distfiles</code> directory,
1839: you don't need to connect. If the distfiles are on CD-ROM, you can
1840: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1841: </p>
1.82 rillig 1842: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1843: <p>
1.110 hubertf 1844: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1845: <p>By default a list of distribution sites will be randomly
1846: intermixed to prevent huge load on servers which holding popular
1847: packages (for example, SourceForge.net mirrors). Thus, every
1848: time when you need to fetch yet another distfile all the mirrors
1849: will be tried in new (random) order. You can turn this feature
1850: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1851: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1852: <p>You can overwrite some of the major distribution sites to
1853: fit to sites that are close to your own. By setting one or two
1854: variables you can modify the order in which the master sites are
1855: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1856: delimited list of domain suffixes.
1857: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1858: contains a whitespace delimited list of regular expressions. It
1859: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1860: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1861: some examples. This may save some of your bandwidth and
1862: time.</p>
1.75 rillig 1863: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1864: if you want to keep the settings, by editing the
1.110 hubertf 1865: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1866: and adding the definitions there.</p>
1.82 rillig 1867: <p>
1.88 wiz 1868: If a package depends on many other packages (such as
1.93 rillig 1869: <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 1870: alternate between periods of
1871: downloading source, and compiling. To ensure you have all the source
1872: downloaded initially you can run the command:
1873: </p>
1.82 rillig 1874: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1875: <p>
1.88 wiz 1876: which will output and run a set of shell commands to fetch the
1877: necessary files into the <code class="filename">distfiles</code> directory. You can
1878: also choose to download the files manually.
1879: </p>
1.75 rillig 1880: </div>
1.128 ! wiz 1881: <div class="sect2" title="4.2.3. How to build and install">
1.75 rillig 1882: <div class="titlepage"><div><div><h3 class="title">
1883: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1884: <p>
1.88 wiz 1885: Once the software has downloaded, any patches will be applied, then it
1886: will be compiled for you. This may take some time depending on your
1887: computer, and how many other packages the software depends on and their
1888: compile time.
1889: </p>
1.128 ! wiz 1890: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1891: <h3 class="title">Note</h3>
1892: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1893: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 ! wiz 1894: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1895: </div>
1.87 wiz 1896: <p>For example, type</p>
1.88 wiz 1897: <pre class="screen">
1898: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1899: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1900: </pre>
1.75 rillig 1901: <p>at the shell prompt to build the various components of the
1.88 wiz 1902: package.</p>
1.82 rillig 1903: <p>The next stage is to actually install the newly compiled
1.88 wiz 1904: program onto your system. Do this by entering:
1.82 rillig 1905:
1.88 wiz 1906: </p>
1.82 rillig 1907: <pre class="screen">
1.88 wiz 1908: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1909: </pre>
1.82 rillig 1910: <p>
1911:
1.88 wiz 1912: while you are still in the directory for whatever package you
1913: are installing.</p>
1.82 rillig 1914: <p>Installing the package on your system may require you to
1.88 wiz 1915: be root. However, pkgsrc has a
1916: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1917: to only become root for the actual installation step.</p>
1.82 rillig 1918: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1919: You can now enter:
1.82 rillig 1920:
1.88 wiz 1921: </p>
1.82 rillig 1922: <pre class="screen">
1.88 wiz 1923: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1924: </pre>
1.82 rillig 1925: <p>
1926:
1.88 wiz 1927: to remove the compiled files in the work directory, as you shouldn't need
1928: them any more. If other packages were also added to your system
1929: (dependencies) to allow your program to compile, you can tidy these up
1930: also with the command:</p>
1.82 rillig 1931: <pre class="screen">
1.88 wiz 1932: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1933: </pre>
1.75 rillig 1934: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 1935: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88 wiz 1936: <p>The program is installed under the default root of the
1937: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1938: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1939: variable in your environment, and it will use that value as the
1940: root of your packages tree. So, to use
1941: <code class="filename">/usr/local</code>, set
1942: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1943: Please note that you should use a directory which is dedicated to
1944: packages and not shared with other programs (i.e., do not try and
1945: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1946: to add any of your own files or directories (such as
1947: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1948: <code class="filename">pkgsrc/</code>) below the
1949: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1950: conflicts between programs and other files installed by the
1951: package system and whatever else may have been installed
1952: there.</p>
1.110 hubertf 1953: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1954: alter some configuration options at build time. Have a look at
1955: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1956: of what will be set there by default. Environment variables such
1957: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1958: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1959: set them each time you want to use pkgsrc.</p>
1.128 ! wiz 1960: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
! 1961: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1962: or being installed. This may be for debugging purposes, or out of
1963: simple curiosity. A number of utility values have been added to
1964: help with this.</p>
1.128 ! wiz 1965: <div class="orderedlist"><ol class="orderedlist" type="1">
! 1966: <li class="listitem">
1.110 hubertf 1967: <p>If you invoke the <a class="citerefentry" 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
1.88 wiz 1968: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1969: information will be displayed. For example,</p>
1.75 rillig 1970: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1971: <p>will show all the commands that are invoked, up to and
1.128 ! wiz 1972: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1973: </li>
1.128 ! wiz 1974: <li class="listitem">
1.110 hubertf 1975: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1976: definition, then the <code class="varname">VARNAME</code> definition
1977: should be used, in conjunction with the show-var
1.110 hubertf 1978: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1979: variable <code class="varname">LOCALBASE</code>:</p>
1980: <pre class="screen">
1981: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1982: /usr/pkg
1983: <code class="prompt">%</code>
1.88 wiz 1984: </pre>
1.75 rillig 1985: </li>
1986: </ol></div>
1987: <p>If you want to install a binary package that you've either
1.88 wiz 1988: created yourself (see next section), that you put into
1989: pkgsrc/packages manually or that is located on a remote FTP
1990: server, you can use the "bin-install" target. This target will
1.110 hubertf 1991: install a binary package - if available - via <a class="citerefentry" 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>,
1992: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1993: sites searched is kept in the variable
1994: <code class="varname">BINPKG_SITES</code>, which defaults to
1.110 hubertf 1995: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" 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.88 wiz 1996: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1997: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1998: details.</p>
1999: <p>A final word of warning: If you set up a system that has a
2000: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2001: set that before any packages are installed, as you cannot use
2002: several directories for the same purpose. Doing so will result in
2003: pkgsrc not being able to properly detect your installed packages,
2004: and fail miserably. Note also that precompiled binary packages are
2005: usually built with the default <code class="varname">LOCALBASE</code> of
2006: <code class="filename">/usr/pkg</code>, and that you should
2007: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2008: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2009: </div>
2010: </div>
2011: </div>
1.128 ! wiz 2012: <div class="chapter" title="Chapter 5. Configuring pkgsrc">
1.75 rillig 2013: <div class="titlepage"><div><div><h2 class="title">
2014: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2015: <div class="toc">
2016: <p><b>Table of Contents</b></p>
2017: <dl>
2018: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2019: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2020: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2021: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2022: <dd><dl>
1.103 wiz 2023: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 ! wiz 2024: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
! 2025: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 2026: </dl></dd>
1.103 wiz 2027: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2028: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2029: </dl>
2030: </div>
1.104 rillig 2031: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2032: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2033: that file depends on the installation. On NetBSD, when you use
1.110 hubertf 2034: <a class="citerefentry" 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
1.89 rillig 2035: <code class="filename">/etc/</code>. In all other cases the default location is
2036: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2037: bootstrap program to install the binary packages.</p>
2038: <p>During the bootstrap, an example configuration file is created. To
2039: use that, you have to create the directory
2040: <code class="filename">${PREFIX}/etc</code> and copy the example file
2041: there.</p>
2042: <p>The format of the configuration file is that of the usual
2043: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2044: is done by setting variables in this file. Note that you can define all
2045: kinds of variables, and no special error checking (for example for
2046: spelling mistakes) takes place, so you have to try it out to see if it
2047: works.</p>
1.128 ! wiz 2048: <div class="sect1" title="5.1. General configuration">
1.75 rillig 2049: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2050: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2051: <p>In this section, you can find some variables that apply to all
1.89 rillig 2052: pkgsrc packages. A complete list of the variables that can be
2053: configured by the user is available in
2054: <code class="filename">mk/defaults/mk.conf</code>, together with some
2055: comments that describe each variable's intent.</p>
1.128 ! wiz 2056: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2057: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2058: packages will be installed. The default is
1.76 rillig 2059: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2060: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 ! wiz 2061: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
! 2062: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 2063: installed. The default is
1.76 rillig 2064: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 ! wiz 2065: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2066: X11 is installed on the system. The default is
1.76 rillig 2067: <code class="filename">/usr/X11R6</code>.</p></li>
1.128 ! wiz 2068: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2069: downloaded copies of the original source distributions used
2070: for building pkgsrc packages. The default is
1.76 rillig 2071: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 ! wiz 2072: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2073: database about installed packages is stored. The default is
2074: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 ! wiz 2075: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2076: If set, override the packages'
2077: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 ! wiz 2078: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2079: Backup location(s) for distribution files and patch files
2080: if not found locally or in
1.76 rillig 2081: <code class="filename">${MASTER_SITES}</code> or
2082: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2083: The defaults are
1.76 rillig 2084: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2085: and
1.76 rillig 2086: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 ! wiz 2087: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2088: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2089: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 ! wiz 2090: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
! 2091: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
! 2092: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2093: List of acceptable licenses. License names are case-sensitive.
2094: Whenever you try to build a package whose license is not in this
2095: list, you will get an error message. If the license condition is
2096: simple enough, the error message will include specific
2097: instructions on how to change this variable.</p></li>
1.75 rillig 2098: </ul></div>
2099: </div>
1.128 ! wiz 2100: <div class="sect1" title="5.2. Variables affecting the build process">
1.75 rillig 2101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2102: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2103: <p>XXX
2104: </p>
1.128 ! wiz 2105: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2106: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2107: directory for the binary packages. The default is
1.76 rillig 2108: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 ! wiz 2109: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2110: The top level directory where, if defined, the separate
2111: working directories will get created, and symbolically
1.76 rillig 2112: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2113: This is useful for building packages on several
1.76 rillig 2114: architectures, then <code class="filename">${PKGSRCDIR}</code>
2115: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2116: is local to every architecture. (It should be noted that
2117: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2118: — it is an internal definition which refers to the
1.75 rillig 2119: root of the pkgsrc tree. It is possible to have many
2120: pkgsrc tree instances.)</p></li>
1.128 ! wiz 2121: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2122: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2123: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2124: information.</p></li>
1.128 ! wiz 2125: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2126: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2127: BSD-style Makefile. If this is not set,
2128: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2129: <code class="filename">/dev/null</code> to avoid picking up
2130: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 ! wiz 2131: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2132: By default, dependencies are only installed, and no binary
2133: package is created for them. You can set this variable to
2134: <code class="literal">package</code> to automatically create binary
2135: packages after installing dependencies.</p></li>
1.75 rillig 2136: </ul></div>
2137: </div>
1.128 ! wiz 2138: <div class="sect1" title="5.3. Variables affecting the installation process">
1.75 rillig 2139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2140: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103 wiz 2141: <p>A growing number of packages support installation into a
2142: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2143: to be built, before the actual filesystem is touched. DESTDIR
2144: support exists in two variations:</p>
1.128 ! wiz 2145: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2146: <li class="listitem"><p>Basic DESTDIR support means that the package
1.103 wiz 2147: installation and packaging is still run as
2148: root.</p></li>
1.128 ! wiz 2149: <li class="listitem"><p>Full DESTDIR support can run the complete build,
1.103 wiz 2150: installation and packaging as normal user. Root privileges are
2151: only needed to add packages.</p></li>
2152: </ul></div>
1.123 snj 2153: <p>To use the DESTDIR support, set
2154: <code class="varname">USE_DESTDIR=yes</code> to get the full support for packages
2155: that support it and with fallback to basic support. </p>
1.103 wiz 2156: <p>DESTDIR support changes the behaviour of various targets
2157: slightly. To install a package after building it, use
2158: <code class="literal">package-install</code>. <code class="literal">package</code> and
2159: <code class="literal">install</code> don't do that any
2160: longer. <code class="literal">package-install</code> can be used as
2161: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2162: will ask for the root password to install the package and fail,
2163: <code class="literal">package-install</code> will ask again.</p>
2164: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2165: clean</code></strong> needs to be run as root.</p>
1.118 imil 2166: <p>Considering the <code class="filename">foo/bar</code> package,
2167: DESTDIR full support can be tested using the following commands
2168:
2169: </p>
2170: <pre class="programlisting">
2171: <code class="prompt">$</code> id
2172: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2173: <code class="prompt">$</code> mkdir $HOME/packages
2174: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2175: </pre>
2176: <p>
2177:
2178: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2179: should be needed
2180:
2181: </p>
2182: <pre class="programlisting">
1.123 snj 2183: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.118 imil 2184: </pre>
2185: <p>
2186:
2187: Create a package without root privileges
2188:
2189: </p>
2190: <pre class="programlisting">
1.123 snj 2191: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.118 imil 2192: </pre>
2193: <p>
2194:
2195: For the following command, you must be able to gain root
2196: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
2197:
2198: </p>
2199: <pre class="programlisting">
1.123 snj 2200: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.118 imil 2201: </pre>
2202: <p>
2203:
2204: Then, as a simple user
2205:
2206: </p>
2207: <pre class="programlisting">
2208: <code class="prompt">$</code> make clean
2209: </pre>
2210: <p>
2211:
2212: </p>
1.103 wiz 2213: </div>
1.128 ! wiz 2214: <div class="sect1" title="5.4. Selecting and configuring the compiler">
1.103 wiz 2215: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2216: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.128 ! wiz 2217: <div class="sect2" title="5.4.1. Selecting the compiler">
1.78 rillig 2218: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2219: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2220: <p>By default, pkgsrc will use GCC to build packages. This may be
2221: overridden by setting the following variables in /etc/mk.conf:</p>
2222: <div class="variablelist"><dl>
2223: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2224: <dd>
2225: <p>This is a list of values specifying the chain of
2226: compilers to invoke when building packages. Valid values
2227: are:</p>
1.128 ! wiz 2228: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2229: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2230: distributed C/C++ (chainable)</p></li>
1.128 ! wiz 2231: <li class="listitem"><p><code class="varname">ccache</code>:
1.89 rillig 2232: compiler cache (chainable)</p></li>
1.128 ! wiz 2233: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2234: GNU C/C++ Compiler</p></li>
1.128 ! wiz 2235: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2236: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.128 ! wiz 2237: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2238: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 ! wiz 2239: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2240: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2241: </ul></div>
2242: <p>The default is
1.128 ! wiz 2243: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 2244: <code class="varname">ccache</code> and/or
2245: <code class="varname">distcc</code> with an appropriate
2246: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 ! wiz 2247: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2248: variable should always be terminated with a value for
2249: a real compiler. Note that only one real compiler
1.128 ! wiz 2250: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2251: is not allowed).</p>
1.89 rillig 2252: </dd>
2253: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2254: <dd><p>This specifies the minimum version of GCC to use
2255: when building packages. If the system GCC doesn't
2256: satisfy this requirement, then pkgsrc will build and
2257: install one of the GCC packages to use instead.</p></dd>
2258: </dl></div>
2259: </div>
1.128 ! wiz 2260: <div class="sect2" title="5.4.2. Additional flags to the compiler (CFLAGS)">
1.89 rillig 2261: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2262: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78 rillig 2263: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2264: please make sure to use the <code class="literal">+=</code> operator
2265: instead of the <code class="literal">=</code> operator:</p>
2266: <pre class="programlisting">
1.100 rillig 2267: CFLAGS+= -your -flags
1.78 rillig 2268: </pre>
2269: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 ! wiz 2270: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2271: need to add their own flags. You may want to take a look
2272: at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128 ! wiz 2273: package if you're interested in optimization specifically
! 2274: for the current CPU. </p>
1.78 rillig 2275: </div>
1.128 ! wiz 2276: <div class="sect2" title="5.4.3. Additional flags to the linker (LDFLAGS)">
1.88 wiz 2277: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2278: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88 wiz 2279: <p>If you want to pass flags to the linker, both in the configure
2280: step and the build step, you can do this in two ways. Either set
2281: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2282: between the two is that <code class="varname">LIBS</code> will be appended to
2283: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2284: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2285: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2286: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2287: <code class="varname">CFLAGS</code>, if you do not wish to override these
2288: settings, use the <code class="literal">+=</code> operator:</p>
2289: <pre class="programlisting">
1.100 rillig 2290: LDFLAGS+= -your -linkerflags
1.88 wiz 2291: </pre>
2292: </div>
1.78 rillig 2293: </div>
1.128 ! wiz 2294: <div class="sect1" title="5.5. Developer/advanced settings">
1.78 rillig 2295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2296: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2297: <p>XXX
2298: </p>
1.128 ! wiz 2299: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2300: <li class="listitem">
1.75 rillig 2301: <p><code class="varname">PKG_DEVELOPER</code>:
2302: Run some sanity checks that package developers want:
2303: </p>
1.128 ! wiz 2304: <div class="itemizedlist"><ul class="itemizedlist" type="circle">
! 2305: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2306: fuzz</p></li>
1.128 ! wiz 2307: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2308: binaries will find their shared libs.</p></li>
1.75 rillig 2309: </ul></div>
2310: <p>
1.87 wiz 2311: </p>
1.75 rillig 2312: </li>
1.128 ! wiz 2313: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 2314: of debugging output which is displayed whilst making and
2315: installing the package. The default value for this is 0,
2316: which will not display the commands as they are executed
2317: (normal, default, quiet operation); the value 1 will display
2318: all shell commands before their invocation, and the value 2
2319: will display both the shell commands before their invocation,
1.110 hubertf 2320: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2321: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2322: </ul></div>
2323: <p>
2324: </p>
2325: </div>
1.128 ! wiz 2326: <div class="sect1" title="5.6. Selecting Build Options">
1.75 rillig 2327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2328: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2329: <p>Some packages have build time options, usually to select
2330: between different dependencies, enable optional support for big
2331: dependencies or enable experimental features.</p>
1.75 rillig 2332: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2333: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2334: show-options</strong></span>, for example:</p>
1.75 rillig 2335: <pre class="programlisting">
2336: The following options are supported by this package:
2337: ssl Enable SSL support.
2338: Exactly one of the following gecko options is required:
2339: firefox Use firefox as gecko rendering engine.
2340: mozilla Use mozilla as gecko rendering engine.
2341: At most one of the following database options may be selected:
2342: mysql Enable support for MySQL database.
2343: pgsql Enable support for PostgreSQL database.
1.1 grant 2344:
1.75 rillig 2345: These options are enabled by default: firefox
2346: These options are currently enabled: mozilla ssl
1.1 grant 2347: </pre>
1.75 rillig 2348: <p>The following variables can be defined in
1.110 hubertf 2349: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2350: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2351: which can be used to select or disable options for all packages
2352: that support them, and
2353: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2354: which can be used to select or disable options specifically for
2355: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 ! wiz 2356: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2357: are disabled. A few examples:</p>
1.75 rillig 2358: <pre class="screen">
1.110 hubertf 2359: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75 rillig 2360: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2361: PKG_OPTIONS.kdebase= debug -sasl
2362: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2363: <p>It is important to note that options that were specifically
1.120 snj 2364: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2365: you do not wish to include the option. If you are unsure you can view
2366: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2367: <p>The following settings are consulted in the order given, and
2368: the last setting that selects or disables an option is
2369: used:</p>
1.128 ! wiz 2370: <div class="orderedlist"><ol class="orderedlist" type="1">
! 2371: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2372: maintainer</p></li>
1.128 ! wiz 2373: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2374: variables (see below)</p></li>
1.128 ! wiz 2375: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
! 2376: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2377: </ol></div>
2378: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2379: selected is used, all others are automatically disabled. If an
2380: option of the group is explicitly disabled, the previously
2381: selected option, if any, is used. It is an error if no option
2382: from a required group of options is selected, and building the
2383: package will fail.</p>
2384: <p>Before the options framework was introduced, build options
2385: were selected by setting a variable (often named
2386: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2387: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2388: transition to the options framework for the user, these legacy
2389: variables are converted to the appropriate options setting
2390: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2391: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2392: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2393: directly. Support for the legacy variables will be removed
2394: eventually.</p>
1.75 rillig 2395: </div>
2396: </div>
1.128 ! wiz 2397: <div class="chapter" title="Chapter 6. Creating binary packages">
1.75 rillig 2398: <div class="titlepage"><div><div><h2 class="title">
2399: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2400: <div class="toc">
2401: <p><b>Table of Contents</b></p>
2402: <dl>
2403: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2404: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2405: </dl>
2406: </div>
1.128 ! wiz 2407: <div class="sect1" title="6.1. Building a single binary package">
1.75 rillig 2408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2409: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2410: <p>Once you have built and installed a package, you can create
2411: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110 hubertf 2412: another system with <a class="citerefentry" 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
1.87 wiz 2413: the same package on a group of hosts and wasting CPU time. It also
2414: provides a simple means for others to install your package, should
2415: you distribute it.</p>
2416: <p>To create a binary package, change into the appropriate
1.110 hubertf 2417: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2418: package</strong></span>:</p>
2419: <pre class="screen">
2420: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2421: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2422: </pre>
2423: <p>This will build and install your package (if not already done),
2424: and then build a binary package from what was installed. You can
1.110 hubertf 2425: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2426: it. Binary packages are created by default in
2427: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2428: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2429: 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.110 hubertf 2430: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.87 wiz 2431: such a binary package.</p>
1.75 rillig 2432: </div>
1.128 ! wiz 2433: <div class="sect1" title="6.2. Settings for creation of binary packages">
1.75 rillig 2434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2435: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2436: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.106 rillig 2437: </div>
2438: </div>
1.128 ! wiz 2439: <div class="chapter" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">
1.106 rillig 2440: <div class="titlepage"><div><div><h2 class="title">
2441: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2442: builds)</h2></div></div></div>
2443: <div class="toc">
2444: <p><b>Table of Contents</b></p>
2445: <dl>
2446: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2447: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2448: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2449: <dd><dl>
2450: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2451: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2452: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2453: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2454: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2455: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2456: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2457: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2458: </dl></dd>
2459: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 2460: <dd><dl>
2461: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2462: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2463: </dl></dd>
1.106 rillig 2464: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2465: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2466: </dl>
2467: </div>
2468: <p>When you have multiple machines that should run the same packages,
2469: it is wasted time if they all build their packages themselves from
2470: source. There are two ways of getting a set of binary packages: The old
2471: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2472: system. This chapter describes how to set them up so that the packages
2473: are most likely to be usable later.</p>
1.128 ! wiz 2474: <div class="sect1" title="7.1. Think first, build later">
1.106 rillig 2475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2476: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2477: <p>Since a bulk build takes several days or even weeks to finish, you
2478: should think about the setup before you start everything. Pay attention
2479: to at least the following points:</p>
1.128 ! wiz 2480: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2481: <li class="listitem">
1.106 rillig 2482: <p>If you want to upload the binary packages to
2483: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2484: packages:</p>
1.128 ! wiz 2485: <div class="itemizedlist"><ul class="itemizedlist" type="circle">
! 2486: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.106 rillig 2487: by a NetBSD developer on a trusted machine (that is, where you and only
2488: you have root access).</p></li>
1.128 ! wiz 2489: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.124 snj 2490: the stable branches (like 2009Q1), so that users browsing the available
1.106 rillig 2491: collections can see at a glance how old the packages
2492: are.</p></li>
1.128 ! wiz 2493: <li class="listitem"><p>The packages must be built as root, since some packages
1.106 rillig 2494: require set-uid binaries at runtime, and creating those packages as
2495: unprivileged user doesn't work well at the moment.</p></li>
2496: </ul></div>
2497: </li>
1.128 ! wiz 2498: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.106 rillig 2499: your system. Most bulk builds run as root, so they should be run at least
2500: in a chroot environment or something even more restrictive, depending on
2501: what the operating system provides. There have been numerous cases where
2502: certain packages tried to install files outside the
2503: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2504: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2505: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2506: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2507: that you don't need any package during the build.</p></li>
2508: </ul></div>
2509: </div>
1.128 ! wiz 2510: <div class="sect1" title="7.2. Requirements of a bulk build">
1.106 rillig 2511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2512: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2513: <p>A complete bulk build requires lots of disk space. Some of the
2514: disk space can be read-only, some other must be writable. Some can be on
2515: remote filesystems (such as NFS) and some should be local. Some can be
2516: temporary filesystems, others must survive a sudden reboot.</p>
1.128 ! wiz 2517: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2518: <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
! 2519: <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
! 2520: <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
! 2521: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
! 2522: <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
! 2523: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.106 rillig 2524: </ul></div>
1.75 rillig 2525: </div>
1.128 ! wiz 2526: <div class="sect1" title="7.3. Running an old-style bulk build">
1.75 rillig 2527: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2528: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.128 ! wiz 2529: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.116 rillig 2530: <h3 class="title">Note</h3>
2531: <p>There are two ways of doing a bulk build. The old-style
1.128 ! wiz 2532: one and the new-style <span class="quote">“<span class="quote">pbulk</span>”</span>. The latter is the recommended
1.116 rillig 2533: way.</p>
1.106 rillig 2534: </div>
1.128 ! wiz 2535: <div class="sect2" title="7.3.1. Configuration">
1.75 rillig 2536: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2537: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.128 ! wiz 2538: <div class="sect3" title="7.3.1.1. build.conf">
1.75 rillig 2539: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2540: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93 rillig 2541: </h4></div></div></div>
1.76 rillig 2542: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2543: configuration file for bulk builds. You can configure how your
2544: copy of pkgsrc is kept up to date, how the distfiles are
2545: downloaded, how the packages are built and how the report is
2546: generated. You can find an annotated example file in
2547: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2548: it, copy <code class="filename">build.conf-example</code> to
2549: <code class="filename">build.conf</code> and edit it, following the
2550: comments in that file.</p>
1.75 rillig 2551: </div>
1.128 ! wiz 2552: <div class="sect3" title="7.3.1.2. mk.conf">
1.75 rillig 2553: <div class="titlepage"><div><div><h4 class="title">
1.110 hubertf 2554: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.104 rillig 2555: </h4></div></div></div>
1.110 hubertf 2556: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87 wiz 2557: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2558: details of the default settings. You will want to ensure that
2559: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.125 wiz 2560: As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.104 rillig 2561: completely bypasses the license check.</p>
1.87 wiz 2562: <pre class="programlisting">
1.100 rillig 2563: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2564: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2565: BSDSRCDIR= /usr/src
2566: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2567: OBJHOSTNAME?= yes # use work.`hostname`
2568: FAILOVER_FETCH= yes # insist on the correct checksum
2569: PKG_DEVELOPER?= yes
1.125 wiz 2570: SKIP_LICENSE_CHECK= yes
1.100 rillig 2571: </pre>
1.75 rillig 2572: <p>Some options that are especially useful for bulk builds
2573: can be found at the top lines of the file
1.76 rillig 2574: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2575: options of these are briefly described here.</p>
1.128 ! wiz 2576: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2577: <li class="listitem"><p>If you are on a slow machine, you may want to
1.87 wiz 2578: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.128 ! wiz 2579: <span class="quote">“<span class="quote">no</span>”</span>.</p></li>
! 2580: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.87 wiz 2581: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2582: to the directory where all log files are created. Otherwise the
2583: log files are created in the pkgsrc directory.</p></li>
1.128 ! wiz 2584: <li class="listitem"><p>Another important variable is
1.87 wiz 2585: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2586: should be always available while building other
2587: packages.</p></li>
1.75 rillig 2588: </ul></div>
2589: <p>Some other options are scattered in the pkgsrc
2590: infrastructure:</p>
1.128 ! wiz 2591: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2592: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
! 2593: should be set to <code class="literal">yes</code>. The purpose of the
! 2594: bulk builds is creating binary packages, no matter if they
! 2595: are vulnerable or not. Leaving this variable unset would
! 2596: prevent the bulk build system from even trying to build
! 2597: them, so possible building errors would not show
! 2598: up.</p></li>
! 2599: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2600: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.128 ! wiz 2601: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed set of files
1.87 wiz 2602: matches the <code class="filename">PLIST</code>.</p></li>
1.128 ! wiz 2603: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2604: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.128 ! wiz 2605: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed
! 2606: <span class="quote">“<span class="quote">#!</span>”</span>-scripts will find their
1.87 wiz 2607: interpreter.</p></li>
1.128 ! wiz 2608: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
! 2609: set to <span class="quote">“<span class="quote"><code class="literal">yes</code></span>”</span> to run each
1.91 rillig 2610: package's self-test before installing it. Note that some
1.128 ! wiz 2611: packages make heavy use of <span class="quote">“<span class="quote">good</span>”</span> random
1.91 rillig 2612: numbers, so you need to assure that the machine on which you
2613: are doing the bulk builds is not completely idle. Otherwise
2614: some test programs will seem to hang, while they are just
2615: waiting for new random data to be
2616: available.</p></li>
1.75 rillig 2617: </ul></div>
2618: </div>
1.128 ! wiz 2619: <div class="sect3" title="7.3.1.3. pre-build.local">
1.75 rillig 2620: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2621: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93 rillig 2622: </h4></div></div></div>
1.75 rillig 2623: <p>It is possible to configure the bulk build to perform
1.87 wiz 2624: certain site-specific tasks at the end of the pre-build
2625: stage. If the file
2626: <code class="filename">pre-build.local</code> exists in
2627: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110 hubertf 2628: (as a <a class="citerefentry" 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
1.87 wiz 2629: stage. An example use of
2630: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2631: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2632: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2633: <p>to prevent the system from trying to build a particular package
1.87 wiz 2634: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2635: </div>
2636: </div>
1.128 ! wiz 2637: <div class="sect2" title="7.3.2. Other environmental considerations">
1.75 rillig 2638: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2639: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2640: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2641: deleted at the start of bulk builds, make sure your login
2642: shell is placed somewhere else. Either drop it into
2643: <code class="filename">/usr/local/bin</code> (and adjust your login
2644: shell in the passwd file), or (re-)install it via
1.110 hubertf 2645: <a class="citerefentry" 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
1.87 wiz 2646: you can login after a reboot (remember that your current
2647: process won't die if the package is removed, you just can't
2648: start any new instances of the shell any more). Also, if you
2649: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2650: version of ssh for some reason, be sure to install ssh before
2651: starting it from <code class="filename">rc.local</code>:</p>
2652: <pre class="programlisting">
1.100 rillig 2653: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2654: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2655: /usr/pkg/etc/rc.d/sshd
2656: fi
2657: </pre>
1.75 rillig 2658: <p>Not doing so will result in you being not able to log in
1.87 wiz 2659: via ssh after the bulk build is finished or if the machine
2660: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2661: </div>
1.128 ! wiz 2662: <div class="sect2" title="7.3.3. Operation">
1.75 rillig 2663: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2664: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75 rillig 2665: <p>Make sure you don't need any of the packages still
1.87 wiz 2666: installed.</p>
1.128 ! wiz 2667: <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 2668: <h3 class="title">Warning</h3>
1.99 rillig 2669: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2670: configuration files and some more files from
2671: <code class="filename">/var</code>, <code class="filename">/home</code> and
2672: possibly other locations will be removed! So don't run a bulk
2673: build with privileges that might harm your
2674: system.</em></span></p>
1.75 rillig 2675: </div>
2676: <p>Be sure to remove all other things that might
1.87 wiz 2677: interfere with builds, like some libs installed in
2678: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2679: <pre class="screen">
2680: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2681: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2682: </pre>
1.75 rillig 2683: <p>If for some reason your last build didn't complete (power
1.87 wiz 2684: failure, system panic, ...), you can continue it by
2685: running:</p>
1.75 rillig 2686: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2687: <p>At the end of the bulk build, you will get a summary via mail,
2688: and find build logs in the directory specified by
2689: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2690: file.</p>
1.75 rillig 2691: </div>
1.128 ! wiz 2692: <div class="sect2" title="7.3.4. What it does">
1.75 rillig 2693: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2694: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75 rillig 2695: <p>The bulk builds consist of three steps:</p>
2696: <div class="variablelist"><dl>
2697: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2698: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2699: cleans out any broken distfiles, and removes all
2700: packages installed.</p></dd>
1.75 rillig 2701: <dt><span class="term">2. the bulk build</span></dt>
1.128 ! wiz 2702: <dd><p>This is basically <span class="quote">“<span class="quote">make bulk-package</span>”</span> with
1.87 wiz 2703: an optimised order in which packages will be
2704: built. Packages that don't require other packages will
2705: be built first, and packages with many dependencies will
2706: be built later.</p></dd>
1.75 rillig 2707: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2708: <dd><p>Generates a report that's placed in the directory
2709: specified in the <code class="filename">build.conf</code> file
2710: named <code class="filename">broken.html</code>, a short version
2711: of that report will also be mailed to the build's
2712: admin.</p></dd>
1.75 rillig 2713: </dl></div>
1.87 wiz 2714: <p>During the build, a list of broken packages will be compiled
2715: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2716: <code class="filename">.../.broken.${MACHINE}</code> if
2717: <code class="varname">OBJMACHINE</code> is set), individual build logs
2718: of broken builds can be found in the package's
2719: directory. These files are used by the bulk-targets to mark
2720: broken builds to not waste time trying to rebuild them, and
2721: they can be used to debug these broken package builds
2722: later.</p>
1.75 rillig 2723: </div>
1.128 ! wiz 2724: <div class="sect2" title="7.3.5. Disk space requirements">
1.75 rillig 2725: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2726: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75 rillig 2727: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2728: NetBSD 2.0/i386:</p>
1.128 ! wiz 2729: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2730: <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
! 2731: <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
! 2732: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.87 wiz 2733: </ul></div>
2734: <p>Note that all pkgs will be de-installed as soon as they are
2735: turned into a binary package, and that sources are removed,
2736: so there is no excessively huge demand to disk
2737: space. Afterwards, if the package is needed again, it will
1.110 hubertf 2738: be installed via <a class="citerefentry" 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
1.87 wiz 2739: there are no cycles wasted by recompiling.</p>
1.75 rillig 2740: </div>
1.128 ! wiz 2741: <div class="sect2" title="7.3.6. Setting up a sandbox for chrooted builds">
1.75 rillig 2742: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2743: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2744: <p>If you don't want all the packages nuked from a machine
2745: (rendering it useless for anything but pkg compiling), there
2746: is the possibility of doing the package bulk build inside a
2747: chroot environment.</p>
2748: <p>The first step is to set up a chroot sandbox,
2749: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2750: using null mounts, or manually.</p>
2751: <p>There is a shell script called
2752: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2753: up the sandbox environment using null mounts. It will also
2754: create a script called <code class="filename">sandbox</code> in the
2755: root of the sandbox environment, which will allow the null
1.110 hubertf 2756: mounts to be activated using the <span class="command"><strong>sandbox
1.87 wiz 2757: mount</strong></span> command and deactivated using the
1.110 hubertf 2758: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87 wiz 2759: <p>To set up a sandbox environment by hand, after extracting all
1.110 hubertf 2760: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87 wiz 2761: distribution DESTDIR=/usr/sandbox</strong></span> in
2762: <code class="filename">/usr/src/etc</code>, be sure the following items
2763: are present and properly configured:</p>
1.128 ! wiz 2764: <div class="procedure"><ol class="procedure" type="1">
! 2765: <li class="step" title="Step 1">
1.75 rillig 2766: <p>Kernel</p>
2767: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2768: </li>
1.128 ! wiz 2769: <li class="step" title="Step 2">
1.76 rillig 2770: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2771: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2772: </li>
1.128 ! wiz 2773: <li class="step" title="Step 3">
1.91 rillig 2774: <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 2775: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2776: </li>
1.128 ! wiz 2777: <li class="step" title="Step 4">
1.75 rillig 2778: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2779: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2780: </li>
1.128 ! wiz 2781: <li class="step" title="Step 5">
1.91 rillig 2782: <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 2783: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2784: </li>
1.128 ! wiz 2785: <li class="step" title="Step 6">
1.76 rillig 2786: <p><code class="filename">/usr/src</code> (system sources,
1.126 jakllsch 2787: 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 2788: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2789: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2790: </li>
1.128 ! wiz 2791: <li class="step" title="Step 7">
1.76 rillig 2792: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2793: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2794: </li>
1.128 ! wiz 2795: <li class="step" title="Step 8">
1.76 rillig 2796: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2797: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2798: </li>
1.128 ! wiz 2799: <li class="step" title="Step 9">
1.75 rillig 2800: <p>Checkout pkgsrc via cvs into
1.87 wiz 2801: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2802: <pre class="screen">
2803: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2804: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2805: </pre>
1.75 rillig 2806: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2807: you do development in, as this will likely cause problems!</p>
1.75 rillig 2808: </li>
1.128 ! wiz 2809: <li class="step" title="Step 10"><p>Make
1.87 wiz 2810: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2811: <code class="filename">.../distfiles</code> point somewhere
2812: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.128 ! wiz 2813: <li class="step" title="Step 11"><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. mk.conf">Section 7.3.1.2, “<code class="filename">mk.conf</code>”</a>.</p></li>
! 2814: <li class="step" title="Step 12"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2815: </ol></div>
2816: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2817: the build with the following steps:</p>
2818: <pre class="screen">
2819: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2820: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2821: </pre>
2822: <p>This will just jump inside the sandbox and start building. At
2823: the end of the build, mail will be sent with the results of
2824: the build. Created binary pkgs will be in
2825: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2826: (wherever that points/mounts to/from).</p>
1.75 rillig 2827: </div>
1.128 ! wiz 2828: <div class="sect2" title="7.3.7. Building a partial set of packages">
1.75 rillig 2829: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2830: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2831: <p>In addition to building a complete set of all packages in
2832: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2833: may be used to build a subset of the packages contained in
2834: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.110 hubertf 2835: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.128 ! wiz 2836: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2837: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
! 2838: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
! 2839: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
! 2840: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.75 rillig 2841: </ul></div>
1.87 wiz 2842: <p>will define the set of packages which should be built.
2843: The bulk build code will also include any packages which are
2844: needed as dependencies for the explicitly listed packages.</p>
2845: <p>One use of this is to do a bulk build with
2846: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2847: periodically to have a complete set of the binary packages
2848: needed for your site available without the overhead of
2849: building extra packages that are not needed.</p>
1.75 rillig 2850: </div>
1.128 ! wiz 2851: <div class="sect2" title="7.3.8. Uploading results of a bulk build">
1.75 rillig 2852: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2853: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2854: <p>This section describes how pkgsrc developers can upload binary
2855: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2856: <p>If you would like to automatically create checksum files for the
2857: binary packages you intend to upload, remember to set
2858: <code class="varname">MKSUMS=yes</code> in your
2859: <code class="filename">mk/bulk/build.conf</code>.</p>
2860: <p>If you would like to PGP sign the checksum files (highly
2861: recommended!), remember to set
2862: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2863: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2864: your GPG password to sign the files before uploading everything.</p>
2865: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2866: set properly in your <code class="filename">mk/bulk/build.conf</code>
2867: file, i.e. adjust it to something like one of the following:</p>
1.126 jakllsch 2868: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload </pre>
2869: <p>Please use appropriate values for "packages-20xxQy",
1.87 wiz 2870: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2871: is different from your local login, write your login directly
2872: into the variable, e.g. my local account is "feyrer", but for my
2873: login "hubertf", I use:</p>
1.126 jakllsch 2874: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 2875: <p>A separate <code class="filename">upload</code> directory is used
2876: here to allow "closing" the directory during upload. To do
2877: so, run the following command on ftp.NetBSD.org next:</p>
1.126 jakllsch 2878: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87 wiz 2879: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2880: only appropriate for packages for the NetBSD operating
2881: system. Binary packages for other operating systems should go
2882: into <code class="filename">/pub/pkgsrc</code>.</p>
2883: <p>Before uploading the binary pkgs, ssh authentication needs
2884: to be set up. This example shows how to set up temporary keys
2885: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2886: (assuming that no keys should be present there usually):</p>
2887: <pre class="screen">
2888: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 2889: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2890: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 2891: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
2892: </pre>
2893: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
2894: append it to your <code class="filename">~/.ssh/authorized_keys</code>
2895: file on ftp.NetBSD.org. You can remove the key after the
2896: upload is done!</p>
2897: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 2898: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 2899: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2900: <p>Now after all this works, you can exit the sandbox and start
2901: the upload:</p>
2902: <pre class="screen">
2903: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 2904: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 2905: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2906: </pre>
1.110 hubertf 2907: <p>The upload process may take quite some time. Use <a class="citerefentry" 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
2908: <a class="citerefentry" 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
1.87 wiz 2909: upload. The upload script will take care of not uploading
1.127 spz 2910: restricted packages.</p>
1.128 ! wiz 2911: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 2912: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 2913: Gdd:x! </pre>
2914: <p>Use whatever is needed to remove the key you've entered
2915: before! Last, move the uploaded packages out of the
2916: <code class="filename">upload</code> directory to have them accessible
2917: to everyone:</p>
2918: <pre class="screen">
1.126 jakllsch 2919: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 2920: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2921: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 2922: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
2923: </pre>
1.75 rillig 2924: </div>
2925: </div>
1.128 ! wiz 2926: <div class="sect1" title="7.4. Running a pbulk-style bulk build">
1.75 rillig 2927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2928: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2929: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.128 ! wiz 2930: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2931: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
! 2932: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2933: </ul></div>
1.128 ! wiz 2934: <div class="sect2" title="7.4.1. Preparation">
1.116 rillig 2935: <div class="titlepage"><div><div><h3 class="title">
2936: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
1.117 jnemeth 2937: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk</code> or <code class="filename">$HOME/pbulk</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
1.116 rillig 2938: <pre class="screen">
2939: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2940: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
2941: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
2942: </pre>
2943: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
1.128 ! wiz 2944: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 2945: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
! 2946: <li class="listitem"><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
! 2947: <li class="listitem"><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
! 2948: <li class="listitem"><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
! 2949: <li class="listitem"><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.116 rillig 2950: </ul></div>
2951: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
2952: <pre class="screen">
2953: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
2954: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
2955: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
2956: </pre>
2957: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
2958: </div>
1.128 ! wiz 2959: <div class="sect2" title="7.4.2. Configuration">
1.106 rillig 2960: <div class="titlepage"><div><div><h3 class="title">
1.116 rillig 2961: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114 jmcneill 2962: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116 rillig 2963: <p>TODO: continue writing</p>
1.106 rillig 2964: </div>
2965: </div>
1.128 ! wiz 2966: <div class="sect1" title="7.5. Creating a multiple CD-ROM packages collection">
1.106 rillig 2967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2968: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2969: <p>After your pkgsrc bulk-build has completed, you may wish to
2970: create a CD-ROM set of the resulting binary packages to assist
2971: in installing packages on other machines. The
1.91 rillig 2972: <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 2973: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2974: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2975: way that keeps all the dependencies for a given package on the same
2976: CD as that package.</p>
1.128 ! wiz 2977: <div class="sect2" title="7.5.1. Example of cdpack">
1.75 rillig 2978: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2979: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2980: <p>Complete documentation for cdpack is found in the cdpack(1)
2981: man page. The following short example assumes that the binary
2982: packages are left in
2983: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2984: sufficient disk space exists in <code class="filename">/u2</code> to
2985: hold the ISO 9660 images.</p>
2986: <pre class="screen">
2987: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2988: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2989: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2990: </pre>
2991: <p>If you wish to include a common set of files
2992: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2993: etc.) on each CD in the collection, then you need to create a
2994: directory which contains these files. e.g.</p>
2995: <pre class="screen">
2996: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2997: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2998: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2999: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3000: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3001: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3002: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3003: </pre>
1.75 rillig 3004: <p>Now create the images:</p>
3005: <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 3006: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3007: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3008: in their root directories.</p>
1.75 rillig 3009: </div>
3010: </div>
3011: </div>
1.128 ! wiz 3012: <div class="chapter" title="Chapter 8. Directory layout of the installed files">
1.75 rillig 3013: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3014: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 3015: <div class="toc">
3016: <p><b>Table of Contents</b></p>
3017: <dl>
1.128 ! wiz 3018: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
! 3019: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90 rillig 3020: </dl>
3021: </div>
3022: <p>The files that are installed by pkgsrc are organized in a way that
3023: is similar to what you find in the <code class="filename">/usr</code> directory
3024: of the base system. But some details are different. This is because
3025: pkgsrc initially came from FreeBSD and had adopted its file system
3026: hierarchy. Later it was largely influenced by NetBSD. But no matter
3027: which operating system you are using pkgsrc with, you can expect the
3028: same layout for pkgsrc.</p>
1.91 rillig 3029: <p>There are mainly four root directories for pkgsrc, which are all
3030: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3031: When pkgsrc has been installed as root, the default locations
3032: are:</p>
3033: <pre class="programlisting">
1.100 rillig 3034: LOCALBASE= /usr/pkg
3035: PKG_SYSCONFBASE= /usr/pkg/etc
3036: VARBASE= /var
3037: PKG_DBDIR= /var/db/pkg
1.91 rillig 3038: </pre>
3039: <p>In unprivileged mode (when pkgsrc has been installed as any other
3040: user), the default locations are:</p>
3041: <pre class="programlisting">
1.100 rillig 3042: LOCALBASE= ${HOME}/pkg
3043: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3044: VARBASE= ${HOME}/pkg/var
3045: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3046: </pre>
3047: <p>What these four directories are for, and what they look like is
3048: explained below.</p>
1.128 ! wiz 3049: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 3050: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 3051: <code class="filename">/usr</code> directory in the base system. It is the
1.128 ! wiz 3052: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 3053: the well-known subdirectories like <code class="filename">bin</code>,
3054: <code class="filename">include</code>, <code class="filename">lib</code>,
3055: <code class="filename">share</code> and
3056: <code class="filename">sbin</code>.</p></li>
1.128 ! wiz 3057: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 3058: <code class="filename">/var</code> in the base system. Some programs (especially
3059: games, network daemons) need write access to it during normal
3060: operation.</p></li>
1.128 ! wiz 3061: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 3062: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 3063: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90 rillig 3064: itself.</p></li>
3065: </ul></div>
1.128 ! wiz 3066: <div class="sect1" title="8.1. File system layout in ${LOCALBASE}">
1.90 rillig 3067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3068: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 3069: </h2></div></div></div>
1.90 rillig 3070: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3071: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3072: <div class="variablelist"><dl>
3073: <dt><span class="term"><code class="filename">bin</code></span></dt>
3074: <dd><p>Contains executable programs that are intended to be
3075: directly used by the end user.</p></dd>
3076: <dt><span class="term"><code class="filename">emul</code></span></dt>
3077: <dd><p>Contains files for the emulation layers of various other
3078: operating systems, especially for
3079: NetBSD.</p></dd>
3080: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3081: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3082: <dd><p>Contains
3083: the configuration files.</p></dd>
3084: <dt><span class="term"><code class="filename">include</code></span></dt>
3085: <dd><p>Contains headers for the C and C++ programming
3086: languages.</p></dd>
3087: <dt><span class="term"><code class="filename">info</code></span></dt>
3088: <dd><p>Contains GNU info files of various
3089: packages.</p></dd>
3090: <dt><span class="term"><code class="filename">lib</code></span></dt>
3091: <dd><p>Contains shared and static
3092: libraries.</p></dd>
3093: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3094: <dd><p>Contains data files that don't change after
3095: installation. Other data files belong into
3096: <code class="filename">${VARBASE}</code>.</p></dd>
3097: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3098: <dd><p>Contains programs that are not intended to be used by
3099: end users, such as helper programs or network
3100: daemons.</p></dd>
3101: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3102: <dd><p>Contains programs that are intended to be executed as
3103: CGI scripts by a web server.</p></dd>
3104: <dt><span class="term"><code class="filename">man</code> (the usual value of
3105: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3106: <dd><p>Contains brief
3107: documentation in form of manual pages.</p></dd>
3108: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3109: <dd><p>Contains programs that are intended to be used only by
3110: the super-user.</p></dd>
3111: <dt><span class="term"><code class="filename">share</code></span></dt>
3112: <dd><p>Contains platform-independent data files that don't
3113: change after installation.</p></dd>
3114: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3115: <dd><p>Contains documentation files provided by the
3116: packages.</p></dd>
3117: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3118: <dd><p>Contains example files provided by the packages. Among
3119: others, the original configuration files are saved here and copied to
3120: <code class="filename">${PKG_SYSCONFDIR}</code> during
3121: installation.</p></dd>
3122: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3123: <dd><p>Contains the original files for rc.d
3124: scripts.</p></dd>
3125: <dt><span class="term"><code class="filename">var</code> (the usual location of
3126: <code class="filename">${VARBASE}</code>)</span></dt>
3127: <dd><p>Contains files
3128: that may be modified after
3129: installation.</p></dd>
3130: </dl></div>
3131: </div>
1.128 ! wiz 3132: <div class="sect1" title="8.2. File system layout in ${VARBASE}">
1.90 rillig 3133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3134: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 3135: </h2></div></div></div>
1.90 rillig 3136: <div class="variablelist"><dl>
3137: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3138: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3139: <dd><p>Contains
3140: information about the currently installed
3141: packages.</p></dd>
3142: <dt><span class="term"><code class="filename">games</code></span></dt>
3143: <dd><p>Contains highscore
3144: files.</p></dd>
3145: <dt><span class="term"><code class="filename">log</code></span></dt>
3146: <dd><p>Contains log files.</p></dd>
3147: <dt><span class="term"><code class="filename">run</code></span></dt>
3148: <dd><p>Contains informational files about daemons that are
3149: currently running.</p></dd>
3150: </dl></div>
3151: </div>
3152: </div>
1.128 ! wiz 3153: <div class="chapter" title="Chapter 9. Frequently Asked Questions">
1.90 rillig 3154: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3155: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3156: <div class="toc">
3157: <p><b>Table of Contents</b></p>
3158: <dl>
1.106 rillig 3159: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3160: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3161: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3162: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3163: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3164: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
3165: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.128 ! wiz 3166: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106 rillig 3167: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.128 ! wiz 3168: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
! 3169: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
! 3170: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.106 rillig 3171: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3172: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3173: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.128 ! wiz 3174: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.106 rillig 3175: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.128 ! wiz 3176: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 3177: </dl>
3178: </div>
3179: <p>This section contains hints, tips & tricks on special things in
3180: pkgsrc that we didn't find a better place for in the previous chapters, and
3181: it contains items for both pkgsrc users and developers.</p>
1.128 ! wiz 3182: <div class="sect1" title="9.1. Are there any mailing lists for pkg-related discussion?">
1.75 rillig 3183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3184: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3185: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.128 ! wiz 3186: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 3187: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 3188: This is a general purpose list for most issues regarding
3189: pkgsrc, regardless of platform, e.g. soliciting user help
3190: for pkgsrc configuration, unexpected build failures, using
3191: particular packages, upgrading pkgsrc installations,
3192: questions regarding the pkgsrc release branches, etc. General announcements or
3193: proposals for changes that impact the pkgsrc user community,
3194: e.g. major infrastructure changes, new features, package
3195: removals, etc., may also be posted.</p></li>
1.128 ! wiz 3196: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 3197: A list where the results of pkgsrc bulk builds are sent and
3198: discussed.</p></li>
1.128 ! wiz 3199: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 3200: This list is for those who are interested in getting a
3201: commit message for every change committed to pkgsrc. It is
3202: also available in digest form, meaning one daily message
3203: containing all commit messages for changes to the package
3204: source tree in that 24 hour period.</p></li>
3205: </ul></div>
3206: <p>To subscribe, do:</p>
3207: <pre class="programlisting">
1.100 rillig 3208: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 3209: </pre>
3210: <p>Archives for all these mailing lists are available from
1.110 hubertf 3211: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 3212: </div>
1.128 ! wiz 3213: <div class="sect1" title="9.2. Where's the pkgviews documentation?">
1.75 rillig 3214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3215: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3216: <p>Pkgviews is tightly integrated with buildlink. You can find a
3217: pkgviews User's guide in
1.76 rillig 3218: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3219: </div>
1.128 ! wiz 3220: <div class="sect1" title="9.3. Utilities for package management (pkgtools)">
1.75 rillig 3221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3222: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3223: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3224: a number of useful utilities for both users and developers of pkgsrc. This
3225: section attempts only to make the reader aware of the utilities and when
3226: they might be useful, and not to duplicate the documentation that comes
3227: with each package.</p>
3228: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.128 ! wiz 3229: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><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 3230: Symlinks for use by buildlink.</p></li></ul></div>
3231: <p>OS tool augmentation (automatically installed when needed):</p>
1.128 ! wiz 3232: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 3233: <li class="listitem"><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 3234: Calculates various kinds of checksums (including SHA1).</p></li>
1.128 ! wiz 3235: <li class="listitem"><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 3236: Compatibility library for pkgsrc tools.</p></li>
1.128 ! wiz 3237: <li class="listitem"><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 3238: non-BSD systems due to lack of native mtree.</p></li>
1.128 ! wiz 3239: <li class="listitem"><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 3240: Up-to-date replacement for
1.76 rillig 3241: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3242: systems where pkg_install is not present.</p></li>
3243: </ul></div>
3244: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.128 ! wiz 3245: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 3246: <li class="listitem"><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 3247: Create a binary package from an
1.110 hubertf 3248: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 3249: save the old package.</p></li>
1.128 ! wiz 3250: <li class="listitem"><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 3251: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3252: from multiple locations. It currently supports the following
3253: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.128 ! wiz 3254: <li class="listitem"><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 3255: packages someplace else (enabled by default).</p></li>
1.128 ! wiz 3256: <li class="listitem"><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
1.117 jnemeth 3257: the best compiler flags to optimise code for your current
1.128 ! wiz 3258: CPU and compiler. </p></li>
1.75 rillig 3259: </ul></div>
3260: <p>Utilities for keeping track of installed packages, being up to date,
3261: etc:</p>
1.128 ! wiz 3262: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 3263: <li class="listitem"><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 3264: packages whose installed versions do not match the latest pkgsrc
3265: entries.</p></li>
1.128 ! wiz 3266: <li class="listitem"><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 3267: dependency graphs of packages, to aid in choosing a strategy for
3268: updating.</p></li>
1.128 ! wiz 3269: <li class="listitem"><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
1.91 rillig 3270: 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>
1.128 ! wiz 3271: <li class="listitem"><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.112 weinem 3272: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.128 ! wiz 3273: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75 rillig 3274: does various checks on the complete pkgsrc system.</p></li>
1.128 ! wiz 3275: <li class="listitem"><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 3276: packages you have installed.</p></li>
3277: </ul></div>
3278: <p>Utilities for people maintaining or creating individual packages:</p>
1.128 ! wiz 3279: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 3280: <li class="listitem"><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 3281: making and maintaining patches for a package (includes pkgdiff,
3282: pkgvi, mkpatches, etc.).</p></li>
1.128 ! wiz 3283: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
1.91 rillig 3284: <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 3285: converting to pkgsrc.</p></li>
1.128 ! wiz 3286: <li class="listitem"><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 3287: pkgsrc to a Solaris package.</p></li>
3288: </ul></div>
3289: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3290: utilities)</p>
1.128 ! wiz 3291: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 3292: <li class="listitem"><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 3293: packages in a chrooted area.</p></li>
1.128 ! wiz 3294: <li class="listitem"><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 3295: kernel version for chrooted cross builds.</p></li>
3296: </ul></div>
3297: </div>
1.128 ! wiz 3298: <div class="sect1" title="9.4. How to use pkgsrc as non-root">
1.75 rillig 3299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3300: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3301: <p>If you want to use pkgsrc as non-root user, you can set some
3302: variables to make pkgsrc work under these conditions. At the very least,
1.128 ! wiz 3303: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.75 rillig 3304: will turn on unprivileged mode and set multiple related variables to allow
3305: installation of packages as non-root.</p>
3306: <p>In case the defaults are not enough, you may want to tune some other
3307: variables used. For example, if the automatic user/group detection leads
3308: to incorrect values (or not the ones you would like to use), you can change
3309: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3310: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3311: <p>As regards bootstrapping, please note that the
1.110 hubertf 3312: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128 ! wiz 3313: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.76 rillig 3314: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3315: installation targets. These directories can be overridden by the
1.128 ! wiz 3316: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.75 rillig 3317: that allow finer tuning of the tree layout.</p>
3318: </div>
1.128 ! wiz 3319: <div class="sect1" title="9.5. How to resume transfers when fetching distfiles?">
1.75 rillig 3320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3321: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3322: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3323: enable this feature by adding the option
3324: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3325: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3326: distfile is found, pkgsrc will try to resume it.</p>
3327: <p>You can also
1.110 hubertf 3328: use a different program than the default <a class="citerefentry" 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
1.117 jnemeth 3329: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3330: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3331: by using the value manual. A value of custom disables the system defaults
3332: and dependency tracking for the fetch program. In that case you have to
3333: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3334: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3335: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3336: <p>For example, if you want to use
1.117 jnemeth 3337: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3338: like:</p>
3339: <pre class="programlisting">
1.117 jnemeth 3340: FETCH_USING= wget
1.1 grant 3341: </pre>
1.75 rillig 3342: </div>
1.128 ! wiz 3343: <div class="sect1" title="9.6. How can I install/use modular X.org from pkgsrc?">
1.75 rillig 3344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3345: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 3346: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3347: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3348: you will have to add the following line into
1.110 hubertf 3349: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3350: <pre class="programlisting">
1.103 wiz 3351: X11_TYPE=modular
1.1 grant 3352: </pre>
1.128 ! wiz 3353: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 3354: <h3 class="title">Note</h3>
1.103 wiz 3355: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3356: </p>
1.75 rillig 3357: </div>
3358: </div>
1.128 ! wiz 3359: <div class="sect1" title="9.7. How to fetch files from behind a firewall">
1.75 rillig 3360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3361: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3362: <p>If you are sitting behind a firewall which does not allow direct
3363: connections to Internet hosts (i.e. non-NAT), you may specify the
3364: relevant proxy hosts. This is done using an environment variable in the
3365: form of a URL, e.g. in Amdahl, the machine
1.128 ! wiz 3366: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 3367: port 80 as the proxy port number. So the proxy environment variables
3368: are:</p>
3369: <pre class="programlisting">
1.100 rillig 3370: ftp_proxy=ftp://orpheus.amdahl.com:80/
3371: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3372: </pre>
1.75 rillig 3373: </div>
1.128 ! wiz 3374: <div class="sect1" title="9.8. How do I tell make fetch to do passive FTP?">
1.75 rillig 3375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 3376: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 3377: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3378: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3379: the first available command from the following list:</p>
1.128 ! wiz 3380: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 3381: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
! 3382: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3383: </ul></div>
3384: <p>On a default NetBSD installation, this will be
1.76 rillig 3385: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3386: connections first, and falls back to active connections if the server
3387: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3388: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3389: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3390: <p>Having that option present will prevent
1.76 rillig 3391: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3392: transfers.</p>
3393: </div>
1.128 ! wiz 3394: <div class="sect1" title="9.9. How to fetch all distfiles at once">
1.75 rillig 3395: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3396: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3397: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3398: from work or university, where you can't run a <span class="command"><strong>make
3399: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75 rillig 3400: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3401: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3402: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3403: resulting list to your machine at work/school and use it there. If you
1.110 hubertf 3404: don't have a NetBSD-compatible <a class="citerefentry" 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
1.75 rillig 3405: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3406: URL:</p>
3407: <p>At home:</p>
3408: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3409: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3410: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3411: <p>At work:</p>
3412: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3413: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3414: home.</p>
3415: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3416: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3417: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3418: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3419: directly by running:</p>
1.75 rillig 3420: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3421: <p>If you even decide to ignore
3422: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3423: by running:</p>
3424: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3425: </div>
1.128 ! wiz 3426: <div class="sect1" title="9.10. What does “Don't know how to make /usr/share/tmac/tmac.andoc” mean?">
1.75 rillig 3427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 ! wiz 3428: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
! 3429: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.91 rillig 3430: <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 3431: package, you get the error from make that it doesn't know how to make
1.76 rillig 3432: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 ! wiz 3433: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3434: the NetBSD base distribution on your machine. It is recommended to do
3435: that to format man pages.</p>
1.91 rillig 3436: <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 3437: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3438: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3439: </div>
1.128 ! wiz 3440: <div class="sect1" title="9.11. What does “Could not find bsd.own.mk” mean?">
1.75 rillig 3441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 ! wiz 3442: <a name="bsd.own.mk-missing"></a>9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.87 wiz 3443: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3444: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3445: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3446: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3447: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3448: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3449: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3450: -r</strong></span>).</p>
3451: </div>
1.128 ! wiz 3452: <div class="sect1" title="9.12. Using 'sudo' with pkgsrc">
1.75 rillig 3453: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3454: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3455: <p>When installing packages as non-root user and using the just-in-time
1.110 hubertf 3456: <a class="citerefentry" 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
1.75 rillig 3457: password for each required package installed. To avoid this, the sudo
3458: package can be used, which does password caching over a limited time. To
3459: use it, install sudo (either as binary package or from
1.98 wiz 3460: <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
1.110 hubertf 3461: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3462: <span class="emphasis"><em>after</em></span> the definition of the
3463: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3464: <pre class="programlisting">
1.100 rillig 3465: .if exists(${LOCALBASE}/bin/sudo)
3466: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3467: .endif
1.1 grant 3468: </pre>
1.75 rillig 3469: </div>
1.128 ! wiz 3470: <div class="sect1" title="9.13. How do I change the location of configuration files?">
1.75 rillig 3471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3472: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3473: <p>As the system administrator, you can choose where configuration files
3474: are installed. The default settings make all these files go into
1.76 rillig 3475: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3476: be suboptimal depending on your expectations (e.g., a read-only,
3477: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3478: configuration of the provided packages).</p>
3479: <p>In order to change the defaults, you can modify the
3480: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3481: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3482: directory; some common examples include <code class="filename">/etc</code> or
3483: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3484: <p>Furthermore, you can change this value on a per-package basis by
3485: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3486: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3487: package you would like to modify, that is, the contents of
3488: <code class="varname">PKGBASE</code>.</p>
3489: <p>Note that after changing these settings, you must rebuild and
3490: reinstall any affected packages.</p>
3491: </div>
1.128 ! wiz 3492: <div class="sect1" title="9.14. Automated security checks">
1.75 rillig 3493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3494: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 3495: <p>Please be aware that there can often be bugs in third-party software,
3496: and some of these bugs can leave a machine vulnerable to exploitation by
3497: attackers. In an effort to lessen the exposure, the NetBSD packages team
3498: maintains a database of known-exploits to packages which have at one time
3499: been included in pkgsrc. The database can be downloaded automatically, and
3500: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3501: do this, refer to the following two tools (installed as part of the
3502: <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):</p>
1.128 ! wiz 3503: <div class="orderedlist"><ol class="orderedlist" type="1">
! 3504: <li class="listitem">
1.122 reed 3505: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3506: download a list of the security vulnerabilities information. This list
3507: is kept up to date by the NetBSD security officer and the NetBSD
3508: packages team, and is distributed from the NetBSD ftp server:</p>
1.110 hubertf 3509: <p><a class="ulink" 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>
1.75 rillig 3510: </li>
1.128 ! wiz 3511: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
! 3512: current machine, checking each known vulnerability. If a
1.75 rillig 3513: vulnerable package is installed, it will be shown by output to stdout,
3514: including a description of the type of vulnerability, and a URL
3515: containing more information.</p></li>
3516: </ol></div>
1.114 jmcneill 3517: <p>Use of these tools is strongly recommended! After
1.128 ! wiz 3518: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.75 rillig 3519: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3520: pkg_install</code></strong>.</p>
1.87 wiz 3521: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3522: perform a security check before building any package. See <a class="xref" 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
1.87 wiz 3523: check.</p>
1.75 rillig 3524: </div>
1.128 ! wiz 3525: <div class="sect1" title="9.15. Why do some packages ignore my CFLAGS?">
1.75 rillig 3526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3527: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3528: <p>When you add your own preferences to the
3529: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3530: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3531: environment variables to the <code class="filename">./configure</code>
1.110 hubertf 3532: scripts and to <a class="citerefentry" 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
1.75 rillig 3533: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3534: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3535: package.</p>
3536: <p>Currently there is no solution to this problem. If you
3537: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3538: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3539: directory and then inspect any <code class="filename">Makefile</code> and
3540: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3541: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 ! wiz 3542: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3543: programmers write so bad code that it only works for the
3544: specific combination of <code class="varname">CFLAGS</code> they have
3545: chosen.</p>
3546: </div>
1.128 ! wiz 3547: <div class="sect1" title="9.16. A package does not build. What shall I do?">
1.80 rillig 3548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3549: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 ! wiz 3550: <div class="procedure"><ol class="procedure" type="1">
! 3551: <li class="step" title="Step 1"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3552: case that occurs often is that people only update pkgsrc in
3553: parts, because of performance reasons. Since pkgsrc is one large
3554: system, not a collection of many small systems, there are
3555: sometimes changes that only work when the whole pkgsrc tree is
3556: updated.</p></li>
1.128 ! wiz 3557: <li class="step" title="Step 2"><p>Make sure that you don't have any CVS conflicts.
! 3558: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
! 3559: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3560: files.</p></li>
1.128 ! wiz 3561: <li class="step" title="Step 3"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3562: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3563: verify this.</p></li>
1.128 ! wiz 3564: <li class="step" title="Step 4"><p>If the problem still exists, write a mail to the
1.80 rillig 3565: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3566: </ol></div>
3567: </div>
1.128 ! wiz 3568: <div class="sect1" title="9.17. What does “Makefile appears to contain unresolved cvs/rcs/??? merge conflicts” mean?">
1.88 wiz 3569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 ! wiz 3570: <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.89 rillig 3571: <p>You have modified a file from pkgsrc, and someone else has
3572: modified that same file afterwards in the CVS repository. Both changes
3573: are in the same region of the file, so when you updated pkgsrc, the
3574: <code class="literal">cvs</code> command marked the conflicting changes in the
3575: file. Because of these markers, the file is no longer a valid
3576: <code class="filename">Makefile</code>.</p>
3577: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3578: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3579: -dP</strong></span> in that directory to download the current version.</p>
3580: </div>
1.75 rillig 3581: </div>
3582: </div>
1.128 ! wiz 3583: <div class="part" title="Part II. The pkgsrc developer's guide">
1.75 rillig 3584: <div class="titlepage"><div><div><h1 class="title">
3585: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.128 ! wiz 3586: <div class="partintro" title="The pkgsrc developer's guide">
1.77 rillig 3587: <div></div>
3588: <p>This part of the book deals with creating and
1.128 ! wiz 3589: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3590: guide on creating a new package. The remaining chapters are more
3591: like a reference manual for pkgsrc.</p>
1.75 rillig 3592: <div class="toc">
3593: <p><b>Table of Contents</b></p>
3594: <dl>
1.106 rillig 3595: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3596: <dd><dl>
1.106 rillig 3597: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3598: <dd><dl>
1.106 rillig 3599: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3600: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3601: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3602: </dl></dd>
1.106 rillig 3603: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3604: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
3605: </dl></dd>
3606: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3607: <dd><dl>
1.128 ! wiz 3608: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
! 3609: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3610: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3611: <dd><dl>
3612: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3613: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3614: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3615: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3616: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3617: </dl></dd>
3618: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3619: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3620: <dd><dl>
3621: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3622: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3623: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3624: </dl></dd>
1.128 ! wiz 3625: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
! 3626: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3627: </dl></dd>
1.128 ! wiz 3628: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3629: <dd><dl>
3630: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 ! wiz 3631: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 3632: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3633: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3634: <dd><dl>
3635: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3636: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3637: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3638: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3639: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3640: </dl></dd>
3641: </dl></dd>
3642: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3643: <dd><dl>
3644: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 ! wiz 3645: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
! 3646: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 3647: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3648: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 ! wiz 3649: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106 rillig 3650: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3651: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3652: </dl></dd>
3653: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3654: <dd><dl>
3655: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 ! wiz 3656: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3657: <dd><dl>
3658: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.128 ! wiz 3659: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.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.106 rillig 3660: </dl></dd>
1.128 ! wiz 3661: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106 rillig 3662: <dd><dl>
1.128 ! wiz 3663: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106 rillig 3664: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3665: </dl></dd>
3666: </dl></dd>
3667: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3668: <dd><dl>
3669: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3670: <dd><dl>
3671: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3672: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3673: </dl></dd>
3674: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3675: <dd><dl>
1.128 ! wiz 3676: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106 rillig 3677: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3678: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3679: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3680: </dl></dd>
3681: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3682: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3683: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3684: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3685: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3686: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3687: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
3688: </dl></dd>
3689: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3690: <dd><dl>
3691: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 ! wiz 3692: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106 rillig 3693: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3694: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3695: </dl></dd>
3696: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3697: <dd><dl>
3698: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3699: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3700: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3701: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 ! wiz 3702: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 3703: <dd><dl>
3704: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3705: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3706: </dl></dd>
1.128 ! wiz 3707: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
! 3708: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
! 3709: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
! 3710: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
! 3711: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
! 3712: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
! 3713: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
! 3714: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
! 3715: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
! 3716: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 3717: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3718: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3719: </dl></dd>
3720: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3721: <dd><dl>
3722: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3723: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3724: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3725: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3726: </dl></dd>
3727: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3728: <dd><dl>
3729: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3730: <dd><dl>
3731: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 ! wiz 3732: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106 rillig 3733: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3734: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3735: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3736: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3737: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3738: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3739: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3740: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3741: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3742: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3743: </dl></dd>
1.128 ! wiz 3744: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 3745: <dd><dl>
3746: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3747: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
3748: </dl></dd>
1.128 ! wiz 3749: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106 rillig 3750: <dd><dl>
3751: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3752: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3753: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3754: </dl></dd>
3755: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3756: <dd><dl>
3757: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3758: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3759: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3760: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3761: </dl></dd>
1.128 ! wiz 3762: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106 rillig 3763: <dd><dl>
3764: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3765: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 ! wiz 3766: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.106 rillig 3767: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3768: </dl></dd>
1.128 ! wiz 3769: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106 rillig 3770: <dd><dl>
3771: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3772: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3773: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3774: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3775: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3776: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3777: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3778: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3779: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3780: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3781: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3782: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3783: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3784: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3785: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3786: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3787: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3788: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3789: emulation</a></span></dt>
1.106 rillig 3790: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3791: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3792: </dl></dd>
1.106 rillig 3793: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3794: </dl></dd>
1.106 rillig 3795: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3796: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3797: <dd><dl>
1.106 rillig 3798: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3799: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3800: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3801: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3802: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3803: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3804: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3805: </dl></dd>
3806: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3807: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3808: <dd><dl>
3809: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3810: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3811: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3812: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3813: </dl></dd>
1.75 rillig 3814: </dl>
3815: </div>
1.77 rillig 3816: </div>
1.128 ! wiz 3817: <div class="chapter" title="Chapter 10. Creating a new pkgsrc package from scratch">
1.77 rillig 3818: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3819: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3820: <div class="toc">
3821: <p><b>Table of Contents</b></p>
3822: <dl>
1.106 rillig 3823: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3824: <dd><dl>
1.106 rillig 3825: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3826: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3827: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3828: </dl></dd>
1.106 rillig 3829: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3830: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91 rillig 3831: </dl>
3832: </div>
1.77 rillig 3833: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3834: most likely have a URL from where you can download the source
3835: code. Starting with this URL, creating a package involves only a
3836: few steps.</p>
1.128 ! wiz 3837: <div class="procedure"><ol class="procedure" type="1">
! 3838: <li class="step" title="Step 1"><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>
! 3839: <li class="step" title="Step 2"><p>Then, choose one of the top-level directories as the
1.91 rillig 3840: category in which you want to place your package. You can also create a
3841: directory of your own (maybe called <code class="filename">local</code>). In that
3842: category directory, create another directory for your package and change
3843: into it.</p></li>
1.128 ! wiz 3844: <li class="step" title="Step 3"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3845: you for a URL. Enter the URL of the distribution file (in most cases a
3846: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3847: of your package are created automatically. The distribution file is
3848: extracted automatically to fill in some details in the
3849: <code class="filename">Makefile</code> that would otherwise have to be done
3850: manually.</p></li>
1.128 ! wiz 3851: <li class="step" title="Step 4">
1.91 rillig 3852: <p>Examine the extracted files to determine the dependencies of
3853: your package. Ideally, this is mentioned in some
3854: <code class="filename">README</code> file, but things may differ. For each of
3855: these dependencies, look where it exists in pkgsrc, and if there is a
3856: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3857: line to your package <code class="filename">Makefile</code> which includes that
3858: file just before the last line. If the
3859: <code class="filename">buildlink3.mk</code> file does not exist, add a
3860: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3861: version of the dependency and where it can be found in pkgsrc. This line
3862: should be placed in the third paragraph. If the dependency is only
3863: needed for building the package, but not when using it, use
3864: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3865: Your package may then look like this:</p>
1.77 rillig 3866: <pre class="programlisting">
1.100 rillig 3867: [...]
1.77 rillig 3868:
1.100 rillig 3869: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3870: DEPENDS+= screen-[0-9]*:../../misc/screen
3871: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3872:
1.100 rillig 3873: [...]
1.77 rillig 3874:
1.100 rillig 3875: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3876: .include "../../devel/glib2/buildlink3.mk"
3877: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3878: </pre>
3879: </li>
1.128 ! wiz 3880: <li class="step" title="Step 5"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
! 3881: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.110 hubertf 3882: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3883: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3884: -e</strong></span>, which outputs additional
3885: explanations.</p></li>
1.128 ! wiz 3886: <li class="step" title="Step 6"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3887: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, “Common types of packages”</a>. After you have followed the instructions
1.91 rillig 3888: over there, you can hopefully continue here.</p></li>
1.128 ! wiz 3889: <li class="step" title="Step 7"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3890: directory from the extracted files. Besides these files, a lot of cache
3891: files and other system information has been saved in the working
3892: directory, which may become wrong after you edited the
3893: <code class="filename">Makefile</code>.</p></li>
1.128 ! wiz 3894: <li class="step" title="Step 8"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 3895: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.128 ! wiz 3896: <li class="step" title="Step 9"><p>When the package builds fine, the next step is to install
1.110 hubertf 3897: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3898: everything works.</p></li>
1.128 ! wiz 3899: <li class="step" title="Step 10"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3900: contains a list of the files that are installed by the package, is
1.110 hubertf 3901: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3902: >PLIST</strong></span> to generate a probably correct list. Check
3903: the file using your preferred text editor to see if the list of
3904: files looks plausible.</p></li>
1.128 ! wiz 3905: <li class="step" title="Step 11"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3906: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.128 ! wiz 3907: <li class="step" title="Step 12"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3908: has been registered in the database of installed files, but with an
1.110 hubertf 3909: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3910: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3911: registered with the list of files from
3912: <code class="filename">PLIST</code>.</p></li>
1.128 ! wiz 3913: <li class="step" title="Step 13"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3914: package from the set of installed files.</p></li>
1.77 rillig 3915: </ol></div>
1.128 ! wiz 3916: <div class="sect1" title="10.1. Common types of packages">
1.91 rillig 3917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3918: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.128 ! wiz 3919: <div class="sect2" title="10.1.1. Perl modules">
1.91 rillig 3920: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3921: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3922: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3923: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3924: </div>
1.128 ! wiz 3925: <div class="sect2" title="10.1.2. KDE applications">
1.91 rillig 3926: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3927: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91 rillig 3928: <p>KDE applications should always include
3929: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3930: settings that are typical of KDE packages.</p>
3931: </div>
1.128 ! wiz 3932: <div class="sect2" title="10.1.3. Python modules and programs">
1.118 imil 3933: <div class="titlepage"><div><div><h3 class="title">
3934: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3935: <p>Python modules and programs packages are easily created using a
3936: set of predefined variables.</p>
1.128 ! wiz 3937: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
! 3938: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
! 3939: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, set the
! 3940: <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">“<span class="quote">yes</span>”</span> so
1.118 imil 3941: pkgsrc will make use of this framework.
1.128 ! wiz 3942: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
! 3943: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
1.118 imil 3944: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3945: to the name of the script.</p>
3946: <p>
3947: If the default Python versions are not supported by the software, set the
3948: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
3949: the software is known to work with, from the most recent to the older
3950: one, e.g.
3951: </p>
3952: <pre class="programlisting">
1.126 jakllsch 3953: PYTHON_VERSIONS_ACCEPTED= 25 24
1.118 imil 3954: </pre>
3955: <p>
3956: If the packaged software is a Python module, include
1.128 ! wiz 3957: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 3958: In this case, the package directory should be called
1.128 ! wiz 3959: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
! 3960: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3961: </p>
3962: <pre class="programlisting">
3963: DISTNAME= foopymodule-1.2.10
3964: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3965: </pre>
3966: <p>If it is an application, also include
1.128 ! wiz 3967: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>
! 3968: before <span class="quote">“<span class="quote">extension.mk</span>”</span>.</p>
1.118 imil 3969: <p>If the packaged software, either it is an application or a module, is
3970: egg-aware, you only need to include
1.128 ! wiz 3971: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
1.118 imil 3972: <p>In order to correctly set the path to the Python interpreter, use the
3973: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
3974: that must be corrected. For example :
3975: </p>
3976: <pre class="programlisting">
3977: REPLACE_PYTHON= ${WRKSRC}/*.py
3978: </pre>
3979: </div>
1.91 rillig 3980: </div>
1.128 ! wiz 3981: <div class="sect1" title="10.2. Examples">
1.91 rillig 3982: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3983: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.128 ! wiz 3984: <div class="sect2" title="10.2.1. How the www/nvu package came into pkgsrc">
1.91 rillig 3985: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3986: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.128 ! wiz 3987: <div class="sect3" title="10.2.1.1. The initial package">
1.91 rillig 3988: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3989: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3990: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 ! wiz 3991: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3992: pkgsrc. As the description says it has to do with the web, the obvious
1.128 ! wiz 3993: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3994: <pre class="programlisting">
1.100 rillig 3995: <code class="prompt">$</code> mkdir www/nvu
3996: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3997: </pre>
3998: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3999: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 4000: <pre class="programlisting">
1.100 rillig 4001: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 4002: </pre>
4003: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4004: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 ! wiz 4005: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 4006: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4007: <code class="varname">COMMENT</code> fields. Then the package
4008: <code class="filename">Makefile</code> looked like that:</p>
4009: <pre class="programlisting">
1.100 rillig 4010: # $NetBSD$
4011: #
1.91 rillig 4012:
1.100 rillig 4013: DISTNAME= nvu-1.0-sources
4014: PKGNAME= nvu-1.0
4015: CATEGORIES= www
4016: MASTER_SITES= http://cvs.nvu.com/download/
4017: EXTRACT_SUFX= .tar.bz2
4018:
4019: MAINTAINER= rillig@NetBSD.org
4020: HOMEPAGE= http://cvs.nvu.com/
4021: COMMENT= Web Authoring System
1.91 rillig 4022:
1.100 rillig 4023: # url2pkg-marker (please do not remove this line.)
4024: .include "../../mk/bsd.pkg.mk"
1.91 rillig 4025: </pre>
4026: <p>Then, I quit the editor and watched pkgsrc downloading a large
4027: source archive:</p>
4028: <pre class="programlisting">
1.100 rillig 4029: url2pkg> Running "make makesum" ...
4030: => Required installed package digest>=20010302: digest-20060826 found
4031: => Fetching nvu-1.0-sources.tar.bz2
4032: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4033: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4034: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4035: url2pkg> Running "make extract" ...
4036: => Required installed package digest>=20010302: digest-20060826 found
4037: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4038: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4039: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4040: ===> Installing dependencies for nvu-1.0
4041: ===> Overriding tools for nvu-1.0
4042: ===> Extracting for nvu-1.0
4043: url2pkg> Adjusting the Makefile.
1.91 rillig 4044:
1.100 rillig 4045: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 4046:
1.100 rillig 4047: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 4048: </pre>
4049: </div>
1.128 ! wiz 4050: <div class="sect3" title="10.2.1.2. Fixing all kinds of problems to make the package work">
1.91 rillig 4051: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4052: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91 rillig 4053: <p>Now that the package has been extracted, let's see what's inside
4054: it. The package has a <code class="filename">README.txt</code>, but that only
4055: says something about mozilla, so it's probably useless for seeing what
4056: dependencies this package has. But since there is a GNU configure script
4057: in the package, let's hope that it will complain about everything it
4058: needs.</p>
4059: <pre class="programlisting">
1.100 rillig 4060: <code class="prompt">$</code> bmake
4061: => Required installed package digest>=20010302: digest-20060826 found
4062: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4063: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4064: ===> Patching for nvu-1.0
4065: ===> Creating toolchain wrappers for nvu-1.0
4066: ===> Configuring for nvu-1.0
4067: [...]
4068: configure: error: Perl 5.004 or higher is required.
4069: [...]
4070: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4071: [...]
1.91 rillig 4072: </pre>
4073: <p>That worked quite well. So I opened the package Makefile in my
4074: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 ! wiz 4075: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 4076: package have changed now, and since a perl wrapper is automatically
1.128 ! wiz 4077: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 4078: from scratch.</p>
4079: <pre class="programlisting">
1.100 rillig 4080: <code class="prompt">$</code> bmake clean
4081: ===> Cleaning for nvu-1.0
4082: <code class="prompt">$</code> bmake
4083: [...]
4084: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4085: GNU Make. You will not be able to build Mozilla without GNU Make.
4086: [...]
1.91 rillig 4087: </pre>
1.128 ! wiz 4088: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 4089: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4090: <pre class="programlisting">
1.100 rillig 4091: [...]
4092: checking for GTK - version >= 1.2.0... no
4093: *** Could not run GTK test program, checking why...
4094: [...]
1.91 rillig 4095: </pre>
4096: <p>Now to the other dependencies. The first question is: Where is the
4097: GTK package hidden in pkgsrc?</p>
4098: <pre class="programlisting">
1.100 rillig 4099: <code class="prompt">$</code> echo ../../*/gtk*
4100: [many packages ...]
4101: <code class="prompt">$</code> echo ../../*/gtk
4102: ../../x11/gtk
4103: <code class="prompt">$</code> echo ../../*/gtk2
4104: ../../x11/gtk2
4105: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4106: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4107: </pre>
4108: <p>The first try was definitely too broad. The second one had exactly
4109: one result, which is very good. But there is one pitfall with GNOME
4110: packages. Before GNOME 2 had been released, there were already many
4111: GNOME 1 packages in pkgsrc. To be able to continue to use these
4112: packages, the GNOME 2 packages were imported as separate packages, and
1.128 ! wiz 4113: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 4114: whether this was the case here, and indeed it was.</p>
4115: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4116: file, adding the dependency is very easy. I just inserted an
4117: <code class="literal">.include</code> line before the last line of the package
4118: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4119: <pre class="programlisting">
1.100 rillig 4120: [...]
4121: .include "../../x11/gtk2/buildlink3.mk"
4122: .include "../../mk/bsd.pkg.mk
1.91 rillig 4123: </pre>
1.110 hubertf 4124: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 4125: was:</p>
4126: <pre class="programlisting">
1.100 rillig 4127: [...]
4128: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4129: checking for GTK - version >= 1.2.0... no
4130: *** Could not run GTK test program, checking why...
4131: *** The test program failed to compile or link. See the file config.log for the
4132: *** exact error that occured. This usually means GTK was incorrectly installed
4133: *** or that you have moved GTK since it was installed. In the latter case, you
4134: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4135: configure: error: Test for GTK failed.
4136: [...]
1.91 rillig 4137: </pre>
1.128 ! wiz 4138: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
! 4139: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 4140: told me that this package really wanted to have the GNOME 1 version of
4141: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 4142: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 4143: So I changed the <code class="literal">x11/gtk2</code> to
4144: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4145: and tried again.</p>
4146: <pre class="programlisting">
1.100 rillig 4147: [...]
4148: 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
4149: In file included from xpidl.c:42:
4150: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4151: In file included from xpidl.c:42:
4152: xpidl.h:132: error: parse error before "IDL_ns"
4153: [...]
1.91 rillig 4154: </pre>
4155: <p>The package still does not find all of its dependencies. Now the
4156: question is: Which package provides the
4157: <code class="filename">libIDL/IDL.h</code> header file?</p>
4158: <pre class="programlisting">
1.100 rillig 4159: <code class="prompt">$</code> echo ../../*/*idl*
4160: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4161: <code class="prompt">$</code> echo ../../*/*IDL*
4162: ../../net/libIDL
1.91 rillig 4163: </pre>
4164: <p>Let's take the one from the second try. So I included the
4165: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4166: again. But the error didn't change. After digging through some of the
4167: code, I concluded that the build process of the package was broken and
4168: couldn't have ever worked, but since the Mozilla source tree is quite
4169: large, I didn't want to fix it. So I added the following to the package
4170: <code class="filename">Makefile</code> and tried again:</p>
4171: <pre class="programlisting">
1.100 rillig 4172: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4173: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4174: </pre>
4175: <p>The latter line is needed because the package expects the library
4176: <code class="filename">libIDL.so</code>, but only
4177: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4178: wrapper to rewrite that on the fly.</p>
4179: <p>The next problem was related to a recent change of the FreeType
4180: 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>
4181: which patch files were relevant for this issue and copied them to the
4182: <code class="filename">patches</code> directory. Then I retried, fixed the
4183: patches so that they applied cleanly and retried again. This time,
4184: everything worked.</p>
4185: </div>
1.128 ! wiz 4186: <div class="sect3" title="10.2.1.3. Installing the package">
1.91 rillig 4187: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4188: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 4189: <pre class="programlisting">
1.100 rillig 4190: <code class="prompt">$</code> bmake CHECK_FILES=no install
4191: [...]
4192: <code class="prompt">$</code> bmake print-PLIST >PLIST
4193: <code class="prompt">$</code> bmake deinstall
4194: <code class="prompt">$</code> bmake install
1.91 rillig 4195: </pre>
4196: </div>
4197: </div>
4198: </div>
1.77 rillig 4199: </div>
1.128 ! wiz 4200: <div class="chapter" title="Chapter 11. Package components - files, directories and contents">
1.75 rillig 4201: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4202: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4203: <div class="toc">
4204: <p><b>Table of Contents</b></p>
4205: <dl>
1.128 ! wiz 4206: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
! 4207: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 4208: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4209: <dd><dl>
4210: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4211: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4212: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4213: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4214: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4215: </dl></dd>
4216: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4217: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4218: <dd><dl>
4219: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4220: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4221: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4222: </dl></dd>
1.128 ! wiz 4223: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
! 4224: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4225: </dl>
4226: </div>
1.87 wiz 4227: <p>Whenever you're preparing a package, there are a number of
4228: files involved which are described in the following
4229: sections.</p>
1.128 ! wiz 4230: <div class="sect1" title="11.1. Makefile">
1.75 rillig 4231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4232: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 4233: </h2></div></div></div>
1.75 rillig 4234: <p>Building, installation and creation of a binary package are all
1.87 wiz 4235: controlled by the package's <code class="filename">Makefile</code>.
4236: The <code class="filename">Makefile</code> describes various things about
4237: a package, for example from where to get it, how to configure,
4238: build, and install it.</p>
1.76 rillig 4239: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4240: sections that describe the package.</p>
1.75 rillig 4241: <p>In the first section there are the following variables, which
1.87 wiz 4242: should appear exactly in the order given here. The order and
4243: grouping of the variables is mostly historical and has no further
4244: meaning.</p>
1.128 ! wiz 4245: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 4246: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4247: distribution file to be downloaded from the package's
4248: website.</p></li>
1.128 ! wiz 4249: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4250: package, as used by pkgsrc. You only need to provide it if
4251: <code class="varname">DISTNAME</code> (which is the default) is not a good
4252: name for the package in pkgsrc. Usually it is the pkgsrc
4253: directory name together with the version number. It must match the
4254: regular expression
4255: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4256: starts with a letter or digit, and contains only letters, digits,
4257: dashes, underscores, dots and plus signs.</p></li>
1.128 ! wiz 4258: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.87 wiz 4259: the package file to create if the <code class="varname">PKGNAME</code>
4260: isn't unique on a SVR4 system. The default is
4261: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4262: <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 4263: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4264: does not produce an unique package name on a SVR4 system.
4265: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4266: characters.</p></li>
1.128 ! wiz 4267: <li class="listitem">
1.75 rillig 4268: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4269: which the package fits in. You can choose any of the top-level
4270: directories of pkgsrc for it.</p>
1.75 rillig 4271: <p>Currently the following values are available for
1.87 wiz 4272: <code class="varname">CATEGORIES</code>. If more than
4273: one is used, they need to be separated by spaces:</p>
1.75 rillig 4274: <pre class="programlisting">
1.100 rillig 4275: archivers cross geography meta-pkgs security
4276: audio databases graphics misc shells
4277: benchmarks devel ham multimedia sysutils
4278: biology editors inputmethod net textproc
4279: cad emulators lang news time
4280: chat finance mail parallel wm
4281: comms fonts math pkgtools www
4282: converters games mbone print x11
4283: </pre>
1.75 rillig 4284: </li>
1.128 ! wiz 4285: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4286: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4287: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4288: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 ! wiz 4289: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.75 rillig 4290: </ul></div>
4291: <p>The second section contains information about separately
1.87 wiz 4292: downloaded patches, if any.
4293: </p>
1.128 ! wiz 4294: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 4295: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4296: Name(s) of additional files that contain distribution patches.
4297: There is no default. pkgsrc will look for them at
4298: <code class="varname">PATCH_SITES</code>.
4299: They will automatically be uncompressed before patching if
4300: the names end with <code class="filename">.gz</code> or
4301: <code class="filename">.Z</code>.</p></li>
1.128 ! wiz 4302: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4303: Primary location(s) for distribution patch files (see
4304: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4305: </ul></div>
4306: <p>The third section contains the following variables.
1.87 wiz 4307: </p>
1.128 ! wiz 4308: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 4309: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4310: address of the person who feels responsible for this package,
4311: and who is most likely to look at problems or questions regarding
4312: this package which have been reported with <a class="citerefentry" 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>.
4313: Other developers may contact the <code class="varname">MAINTAINER</code>
4314: before making changes to the package, but are not required to
4315: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4316: to yourself. If you really can't maintain the package for future
4317: updates, set it to
1.110 hubertf 4318: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 ! wiz 4319: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4320: of <code class="varname">MAINTAINER</code> when you do not want other
4321: developers to update or change the package without contacting
4322: you first. A package Makefile should contain one of
4323: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4324: not both. </p></li>
1.128 ! wiz 4325: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4326: find more information about the package.</p></li>
1.128 ! wiz 4327: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4328: description of the package (should not include the package
4329: name).</p></li>
1.75 rillig 4330: </ul></div>
4331: <p>Other variables that affect the build:
1.87 wiz 4332: </p>
1.128 ! wiz 4333: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
1.75 rillig 4334: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4335: interesting distribution files of the package are found. The
4336: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4337: works for most packages.</p>
1.75 rillig 4338: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4339: (most GNU software does, for instance), but extracts itself in
4340: the current directory, you should set
4341: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4342: <p>If a package doesn't create a subdirectory with the
4343: name of <code class="varname">DISTNAME</code> but some different name,
4344: set <code class="varname">WRKSRC</code> to point to the proper name in
4345: <code class="filename">${WRKDIR}</code>, for example
4346: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4347: <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 4348: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4349: taken from the <code class="varname">WRKDIR_BASENAME</code>
4350: variable. By default, its value is
4351: <code class="filename">work</code>. If you want to use the same
4352: pkgsrc tree for building different kinds of binary packages,
4353: you can change the variable according to your needs. Two
4354: other variables handle common cases of setting
4355: <code class="varname">WRKDIR_BASENAME</code> individually. If
4356: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4357: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4358: the host's name is attached to the directory name. If
4359: <code class="varname">OBJMACHINE</code> is defined, the platform name
4360: is attached, which might look like
4361: <code class="filename">work.i386</code> or
4362: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4363: </li></ul></div>
4364: <p>Please pay attention to the following gotchas:</p>
1.128 ! wiz 4365: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 4366: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4367: installed in compressed form by the package. For packages using
4368: BSD-style makefiles which honor MANZ, there is
4369: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 ! wiz 4370: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
! 4371: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4372: below).</p></li>
1.128 ! wiz 4373: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, “Packages installing info files”</a>.</p></li>
1.75 rillig 4374: </ul></div>
4375: </div>
1.128 ! wiz 4376: <div class="sect1" title="11.2. distinfo">
1.75 rillig 4377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4378: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4379: </h2></div></div></div>
1.76 rillig 4380: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4381: digest, or checksum, of each distfile needed for the package. This
4382: ensures that the distfiles retrieved from the Internet have not been
4383: corrupted during transfer or altered by a malign force to introduce
4384: a security hole. Due to recent rumor about weaknesses of digest
4385: algorithms, all distfiles are protected using both SHA1 and RMD160
4386: message digests, as well as the file size.</p>
1.76 rillig 4387: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4388: checksums for all the patches found in the
1.110 hubertf 4389: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.76 rillig 4390: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4391: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4392: command.</p>
1.75 rillig 4393: <p>Some packages have different sets of distfiles depending on
1.128 ! wiz 4394: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.87 wiz 4395: <code class="filename">distinfo</code> file and care should be taken when
4396: upgrading such a package to ensure distfile information is not
4397: lost.</p>
1.75 rillig 4398: </div>
1.128 ! wiz 4399: <div class="sect1" title="11.3. patches/*">
1.75 rillig 4400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4401: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4402: <p>Many packages still don't work out-of-the box on the various
4403: platforms that are supported by pkgsrc. Therefore, a number of custom
4404: patch files are needed to make the package work. These patch files are
4405: found in the <code class="filename">patches/</code> directory.</p>
4406: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4407: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4408: extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.93 rillig 4409: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4410: <code class="filename">patch-ab</code>, etc.</p>
1.128 ! wiz 4411: <div class="sect2" title="11.3.1. Structure of a single patch file">
1.93 rillig 4412: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4413: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4414: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4415: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4416: problems. (To force patches to apply with fuzz you can set
4417: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4418: should contain only changes for a single file, and no file should be
1.93 rillig 4419: patched by more than one patch file. This helps to keep future
4420: modifications simple.</p>
4421: <p>Each patch file is structured as follows: In the first line,
4422: there is the RCS Id of the patch itself. The second line should be
4423: empty for aesthetic reasons. After that, there should be a comment for
4424: each change that the patch does. There are a number of standard
4425: cases:</p>
1.128 ! wiz 4426: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 4427: <li class="listitem"><p>Patches that replace the <code class="literal">==</code>
1.110 hubertf 4428: operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.111 rillig 4429: are so common that they don't need a comment at all.</p></li>
1.128 ! wiz 4430: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4431: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 ! wiz 4432: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4433: platform and other environment (for example, the compiler) that the
4434: patch is needed for.</p></li>
4435: </ul></div>
4436: <p>In all other cases, the patch should be commented so that any
4437: developer who knows the code of the application can make some use of
4438: the patch. Special care should be taken for the upstream developers,
4439: since we generally want that they accept our patches, so we have less
4440: work in the future.</p>
4441: </div>
1.128 ! wiz 4442: <div class="sect2" title="11.3.2. Creating patch files">
1.93 rillig 4443: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4444: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4445: <p>One important thing to mention is to pay attention that no RCS
4446: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4447: later checked into the NetBSD CVS tree. Use the
1.110 hubertf 4448: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93 rillig 4449: problems.</p>
1.87 wiz 4450: <p>For even more automation, we recommend using
1.110 hubertf 4451: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4452: whole set of patches. You just have to backup files before you
4453: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4454: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4455: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4456: you upgrade a package this way, you can easily compare the new
4457: set of patches with the previously existing one with
1.110 hubertf 4458: <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87 wiz 4459: or update from the <code class="filename">work/.newpatches</code>
4460: directory to <code class="filename">patches/</code>.</p>
4461: <p>When you have finished a package, remember to generate
1.110 hubertf 4462: the checksums for the patch files by using the <span class="command"><strong>make
1.128 ! wiz 4463: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.87 wiz 4464: <p>When adding a patch that corrects a problem in the
4465: distfile (rather than e.g. enforcing pkgsrc's view of where
4466: man pages should go), send the patch as a bug report to the
4467: maintainer. This benefits non-pkgsrc users of the package,
4468: and usually makes it possible to remove the patch in future
4469: version.</p>
1.101 rillig 4470: <p>The file names of the patch files are usually of the form
4471: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93 rillig 4472: </div>
1.128 ! wiz 4473: <div class="sect2" title="11.3.3. Sources where the patch files come from">
1.93 rillig 4474: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4475: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4476: <p>If you want to share patches between multiple packages
4477: in pkgsrc, e.g. because they use the same distfiles, set
4478: <code class="varname">PATCHDIR</code> to the path where the patch files
4479: can be found, e.g.:</p>
4480: <pre class="programlisting">
1.100 rillig 4481: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4482: </pre>
1.75 rillig 4483: <p>Patch files that are distributed by the author or other
1.87 wiz 4484: maintainers can be listed in
4485: <code class="varname">PATCHFILES</code>.</p>
4486: <p>If it is desired to store any patches that should not be
4487: committed into pkgsrc, they can be kept outside the pkgsrc
4488: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4489: directory tree there is expected to have the same
1.128 ! wiz 4490: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4491: patches are expected to be stored inside these dirs (also
4492: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4493: example, if you want to keep a private patch for
4494: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4495: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4496: files in the named directory are expected to be patch files,
4497: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4498: applied</em></span>.</p>
1.93 rillig 4499: </div>
1.128 ! wiz 4500: <div class="sect2" title="11.3.4. Patching guidelines">
1.85 jmmv 4501: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4502: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4503: <p>When fixing a portability issue in the code do not use
4504: preprocessor magic to check for the current operating system nor
4505: platform. Doing so hurts portability to other platforms because
4506: the OS-specific details are not abstracted appropriately.</p>
4507: <p>The general rule to follow is: instead of checking for the
4508: operating system the application is being built on, check for the
4509: specific <span class="emphasis"><em>features</em></span> you need. For example,
4510: instead of assuming that kqueue is available under NetBSD and
4511: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4512: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4513: yes, this generally involves patching the
1.110 hubertf 4514: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4515: that prevents some OSes from adopting interfaces from other OSes
4516: (e.g. Linux implementing kqueue), something that the above checks
4517: cannot take into account.</p>
4518: <p>Of course, checking for features generally involves more
4519: work on the developer's side, but the resulting changes are
1.87 wiz 4520: cleaner and there are chances they will work on many other
1.85 jmmv 4521: platforms. Not to mention that there are higher chances of being
4522: later integrated into the mainstream sources. Remember:
4523: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4524: <p>Some typical examples:</p>
4525: <div class="table">
1.106 rillig 4526: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4527: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4528: <colgroup>
4529: <col>
4530: <col>
4531: <col>
4532: </colgroup>
4533: <thead><tr>
4534: <th>Where</th>
4535: <th>Incorrect</th>
4536: <th>Correct</th>
4537: </tr></thead>
4538: <tbody>
4539: <tr>
4540: <td>configure script</td>
4541: <td>
1.100 rillig 4542: <pre class="programlisting">
4543: case ${target_os} in
4544: netbsd*) have_kvm=yes ;;
4545: *) have_kvm=no ;;
4546: esac
4547: </pre>
1.85 jmmv 4548: </td>
4549: <td>
1.100 rillig 4550: <pre class="programlisting">
4551: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4552: </pre>
1.85 jmmv 4553: </td>
4554: </tr>
4555: <tr>
4556: <td>C source file</td>
4557: <td>
1.100 rillig 4558: <pre class="programlisting">
4559: #if defined(__NetBSD__)
4560: # include <sys/event.h>
4561: #endif
4562: </pre>
1.85 jmmv 4563: </td>
4564: <td>
1.100 rillig 4565: <pre class="programlisting">
4566: #if defined(HAVE_SYS_EVENT_H)
4567: # include <sys/event.h>
4568: #endif
4569: </pre>
1.85 jmmv 4570: </td>
4571: </tr>
4572: <tr>
4573: <td>C source file</td>
4574: <td>
1.100 rillig 4575: <pre class="programlisting">
4576: int
4577: monitor_file(...)
4578: {
4579: #if defined(__NetBSD__)
4580: int fd = kqueue();
4581: ...
4582: #else
4583: ...
4584: #endif
4585: }
4586: </pre>
1.85 jmmv 4587: </td>
4588: <td>
1.100 rillig 4589: <pre class="programlisting">
4590: int
4591: monitor_file(...)
4592: {
4593: #if defined(HAVE_KQUEUE)
4594: int fd = kqueue();
4595: ...
4596: #else
4597: ...
4598: #endif
4599: }
4600: </pre>
1.85 jmmv 4601: </td>
4602: </tr>
4603: </tbody>
1.91 rillig 4604: </table></div>
1.85 jmmv 4605: </div>
1.91 rillig 4606: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4607: packager-friendly software</em></span> article (<a class="ulink" href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4608: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4609: 2</a>). It summarizes multiple details on how to make
4610: software easier to package; all the suggestions in it were
4611: collected from our experience in pkgsrc work, so they are possibly
4612: helpful when creating patches too.</p>
4613: </div>
1.128 ! wiz 4614: <div class="sect2" title="11.3.5. Feedback to the author">
1.85 jmmv 4615: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4616: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4617: <p>Always, always, <span class="strong"><strong>always</strong></span>
4618: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4619: improvements you do to a package to the mainstream developers.
4620: This is the only way to get their attention on portability issues
4621: and to ensure that future versions can be built out-of-the box on
4622: NetBSD. Furthermore, any user that gets newer distfiles will get
4623: the fixes straight from the packaged code.</p>
1.93 rillig 4624: <p>This generally involves cleaning up the patches
4625: (because sometimes the patches that are
1.85 jmmv 4626: added to pkgsrc are quick hacks), filling bug reports in the
4627: appropriate trackers for the projects and working with the
4628: mainstream authors to accept your changes. It is
4629: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4630: the packages in pkgsrc are kept simple and thus further changes
4631: can be done without much hassle.</p>
4632: <p>Support the idea of free software!</p>
4633: </div>
1.75 rillig 4634: </div>
1.128 ! wiz 4635: <div class="sect1" title="11.4. Other mandatory files">
1.75 rillig 4636: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4637: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4638: <div class="variablelist"><dl>
1.76 rillig 4639: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4640: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4641: any credits where they are due. Please bear in mind that others do not
4642: share your sense of humour (or spelling idiosyncrasies), and that others
4643: will read everything that you write here.</p></dd>
1.76 rillig 4644: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4645: <dd><p>This file governs the files that are installed on your
4646: system: all the binaries, manual pages, etc. There are other
4647: directives which may be entered in this file, to control the
4648: creation and deletion of directories, and the location of
1.110 hubertf 4649: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87 wiz 4650: information.</p></dd>
1.75 rillig 4651: </dl></div>
4652: </div>
1.128 ! wiz 4653: <div class="sect1" title="11.5. Optional files">
1.75 rillig 4654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4655: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.128 ! wiz 4656: <div class="sect2" title="11.5.1. Files affecting the binary package">
1.78 rillig 4657: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4658: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4659: <div class="variablelist"><dl>
1.76 rillig 4660: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110 hubertf 4661: <dd><p>This shell script is invoked twice by <a class="citerefentry" 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 4662: First time after package extraction and before files are
4663: moved in place, the second time after the files to install
4664: are moved in place. This can be used to do any custom
4665: procedures not possible with @exec commands in
1.110 hubertf 4666: <code class="filename">PLIST</code>. See <a class="citerefentry" 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
4667: <a class="citerefentry" 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 class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a>.</p></dd>
1.76 rillig 4668: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4669: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4670: this script's responsibility to clean up any additional messy details
4671: around the package's installation, since all pkg_delete knows is how to
4672: delete the files created in the original distribution.
1.110 hubertf 4673: See <a class="citerefentry" 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>
4674: and <a class="citerefentry" 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 4675: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4676: <dd>
4677: <p>This file is displayed after installation of the package.
1.87 wiz 4678: Useful for things like legal notices on almost-free
4679: software and hints for updating config files after
4680: installing modules for apache, PHP etc.
4681: Please note that you can modify variables in it easily by using
4682: <code class="varname">MESSAGE_SUBST</code> in the package's
4683: <code class="filename">Makefile</code>:</p>
1.75 rillig 4684: <pre class="programlisting">
1.100 rillig 4685: MESSAGE_SUBST+= SOMEVAR="somevalue"
4686: </pre>
1.128 ! wiz 4687: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4688: <code class="filename">MESSAGE</code>. By default, substitution is
4689: performed for <code class="varname">PKGNAME</code>,
4690: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4691: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4692: <code class="varname">X11BASE</code>,
4693: <code class="varname">PKG_SYSCONFDIR</code>,
4694: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4695: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4696: <p>You can display a different or additional files by
4697: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4698: default is <code class="filename">MESSAGE</code>, if the file
4699: exists.</p>
1.75 rillig 4700: </dd>
1.78 rillig 4701: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4702: <dd><p>FIXME: There is no documentation on the
4703: alternatives framework.</p></dd>
4704: </dl></div>
4705: </div>
1.128 ! wiz 4706: <div class="sect2" title="11.5.2. Files affecting the build process">
1.78 rillig 4707: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4708: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4709: <div class="variablelist"><dl>
4710: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4711: <dd><p>This file contains arbitrary things that could
4712: also go into a <code class="filename">Makefile</code>, but its purpose is
4713: to be used by more than one package. This file should only be
4714: used when the packages that will use the file are known in
4715: advance. For other purposes it is often better to write a
4716: <code class="filename">*.mk</code> file and give it a good name that
4717: describes what it does.</p></dd>
4718: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4719: <dd><p>This file contains the dependency information
1.110 hubertf 4720: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.78 rillig 4721: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4722: <dd><p>This file contains workarounds for compiler bugs
4723: and similar things. It is included automatically by the pkgsrc
4724: infrastructure, so you don't need an extra
4725: <code class="literal">.include</code> line for
4726: it.</p></dd>
4727: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4728: <dd><p>This file contains the code for the
1.110 hubertf 4729: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.78 rillig 4730: selected by the user. If a package has only one or two options,
4731: it is equally acceptable to put the code directly into the
4732: <code class="filename">Makefile</code>.</p></dd>
4733: </dl></div>
4734: </div>
1.128 ! wiz 4735: <div class="sect2" title="11.5.3. Files affecting nothing at all">
1.78 rillig 4736: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4737: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4738: <div class="variablelist"><dl>
4739: <dt><span class="term"><code class="filename">README*</code></span></dt>
4740: <dd><p>These files do not take place in the creation of
4741: a package and thus are purely informative to the package
4742: developer.</p></dd>
4743: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4744: <dd><p>This file contains things that need to be done
4745: to make the package even
4746: better.</p></dd>
1.75 rillig 4747: </dl></div>
4748: </div>
1.78 rillig 4749: </div>
1.128 ! wiz 4750: <div class="sect1" title="11.6. work*">
1.75 rillig 4751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4752: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4753: </h2></div></div></div>
1.110 hubertf 4754: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4755: unpacked into the directory denoted by
4756: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4757: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4758: directory is also used to keep various timestamp files.
4759: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4760: The default is <code class="filename">${.CURDIR}/work</code>
4761: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4762: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4763: </div>
1.128 ! wiz 4764: <div class="sect1" title="11.7. files/*">
1.75 rillig 4765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4766: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4767: </h2></div></div></div>
1.75 rillig 4768: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4769: to configuration or building, you could place these files here and use
1.110 hubertf 4770: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 ! wiz 4771: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4772: this. Alternatively, you could simply diff the file against
4773: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4774: the creation of this file.</p>
4775: <p>If you want to share files in this way with other
4776: packages, set the <code class="varname">FILESDIR</code> variable to point
4777: to the other package's <code class="filename">files</code> directory,
4778: e.g.:</p>
4779: <pre class="programlisting">
1.100 rillig 4780: FILESDIR=${.CURDIR}/../xemacs/files
4781: </pre>
1.75 rillig 4782: </div>
4783: </div>
1.128 ! wiz 4784: <div class="chapter" title="Chapter 12. Programming in Makefiles">
1.75 rillig 4785: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4786: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4787: <div class="toc">
4788: <p><b>Table of Contents</b></p>
4789: <dl>
1.106 rillig 4790: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 ! wiz 4791: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4792: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4793: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4794: <dd><dl>
4795: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4796: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4797: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4798: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4799: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75 rillig 4800: </dl></dd>
4801: </dl>
4802: </div>
1.76 rillig 4803: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4804: each of which forms a well-defined part of the pkgsrc system. Using
1.110 hubertf 4805: the <a class="citerefentry" 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
1.75 rillig 4806: like pkgsrc requires some discipline to keep the code correct and
4807: understandable.</p>
1.76 rillig 4808: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4809: programming are variables (which are actually macros) and shell
4810: commands. Among these shell commands may even be more complex ones
1.110 hubertf 4811: like <a class="citerefentry" 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
1.75 rillig 4812: as intended it is necessary to quote all variables correctly when they
4813: are used.</p>
4814: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4815: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4816: with them.</p>
1.128 ! wiz 4817: <div class="sect1" title="12.1. Caveats">
1.75 rillig 4818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4819: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.128 ! wiz 4820: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
1.97 rillig 4821: <p>When you are creating a file as a
4822: target of a rule, always write the data to a temporary file first
4823: and finally rename that file. Otherwise there might occur an error
4824: in the middle of generating the file, and when the user runs
1.110 hubertf 4825: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97 rillig 4826: regenerated properly. Example:</p>
4827: <pre class="programlisting">
1.100 rillig 4828: wrong:
4829: @echo "line 1" > ${.TARGET}
4830: @echo "line 2" >> ${.TARGET}
4831: @false
4832:
4833: correct:
4834: @echo "line 1" > ${.TARGET}.tmp
4835: @echo "line 2" >> ${.TARGET}.tmp
4836: @false
4837: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4838: </pre>
1.110 hubertf 4839: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4840: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4841: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4842: correct</strong></span> gives an error message twice, as expected.</p>
1.110 hubertf 4843: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97 rillig 4844: <code class="literal">${.TARGET}</code> in case of error, but this only
4845: happens when it is interrupted, for example by pressing
4846: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110 hubertf 4847: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97 rillig 4848: </li></ul></div>
4849: </div>
1.128 ! wiz 4850: <div class="sect1" title="12.2. Makefile variables">
1.97 rillig 4851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4852: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4853: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4854: can be processed using the five operators ``='', ``+='', ``?='',
1.110 hubertf 4855: ``:='', and ``!='', which are described in the <a class="citerefentry" 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
1.75 rillig 4856: page.</p>
4857: <p>When a variable's value is parsed from a
1.76 rillig 4858: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4859: backslash character ``\'' are handled specially. If a backslash is
4860: followed by a newline, any whitespace immediately in front of the
4861: backslash, the backslash, the newline, and any whitespace
4862: immediately behind the newline are replaced with a single space. A
4863: backslash character and an immediately following hash character are
4864: replaced with a single hash character. Otherwise, the backslash is
4865: passed as is. In a variable assignment, any hash character that is
4866: not preceded by a backslash starts a comment that continues upto the
4867: end of the logical line.</p>
4868: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4869: the only way to create a variable consisting of a single backslash
4870: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4871: <p>So far for defining variables. The other thing you can do with
4872: variables is evaluating them. A variable is evaluated when it is
4873: part of the right side of the ``:='' or the ``!='' operator, or
4874: directly before executing a shell command which the variable is part
1.110 hubertf 4875: of. In all other cases, <a class="citerefentry" 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
1.75 rillig 4876: is, variables are not evaluated until there's no other way. The
4877: ``modifiers'' mentioned in the man page also evaluate the
4878: variable.</p>
4879: <p>Some of the modifiers split the string into words and then
4880: operate on the words, others operate on the string as a whole. When
4881: a string is split into words, it is split as you would expect
1.110 hubertf 4882: it from <a class="citerefentry" 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.126 jakllsch 4883: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4884: loop does not follow the shell quoting rules but splits at sequences
4885: of whitespace.</p>
4886: <p>There are several types of variables that should be handled
4887: differently. Strings and two types of lists.</p>
1.128 ! wiz 4888: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 4889: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4890: characters. Nevertheless, you should restrict yourself to only
4891: using printable characters. Examples are
4892: <code class="varname">PREFIX</code> and
4893: <code class="varname">COMMENT</code>.</p></li>
1.128 ! wiz 4894: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4895: are never exported to any shell command. Their elements are
4896: separated by whitespace. Therefore, the elements themselves cannot
4897: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4898: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4899: Examples are <code class="varname">DEPENDS</code> and
4900: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 ! wiz 4901: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4902: may be exported to a shell command. Their elements can contain any
4903: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4904: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4905: <code class="varname">DISTFILES</code> and
4906: <code class="varname">MASTER_SITES</code>.</p></li>
4907: </ul></div>
1.128 ! wiz 4908: <div class="sect2" title="12.2.1. Naming conventions">
1.75 rillig 4909: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4910: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.128 ! wiz 4911: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 4912: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4913: are reserved for use by the pkgsrc infrastructure. They shall
4914: not be used by package
1.76 rillig 4915: <code class="filename">Makefile</code>s.</p></li>
1.128 ! wiz 4916: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4917: lowercase variable names for the iteration
4918: variables.</p></li>
1.128 ! wiz 4919: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4920: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4921: <code class="varname">DISTFILES</code>.</p></li>
4922: </ul></div>
4923: </div>
4924: </div>
1.128 ! wiz 4925: <div class="sect1" title="12.3. Code snippets">
1.75 rillig 4926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4927: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4928: <p>This section presents you with some code snippets you should
4929: use in your own code. If you don't find anything appropriate here,
4930: you should test your code and add it here.</p>
1.128 ! wiz 4931: <div class="sect2" title="12.3.1. Adding things to a list">
1.75 rillig 4932: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4933: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4934: <pre class="programlisting">
1.100 rillig 4935: STRING= foo * bar `date`
4936: INT_LIST= # empty
4937: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4938: EXT_LIST= # empty
4939: ANOTHER_EXT_LIST= a=b c=d
4940:
4941: INT_LIST+= ${STRING} # 1
4942: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4943: EXT_LIST+= ${STRING:Q} # 3
4944: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4945: </pre>
1.75 rillig 4946: <p>When you add a string to an external list (example 3), it
4947: must be quoted. In all other cases, you must not add a quoting
4948: level. You must not merge internal and external lists, unless you
4949: are sure that all entries are correctly interpreted in both
4950: lists.</p>
4951: </div>
1.128 ! wiz 4952: <div class="sect2" title="12.3.2. Converting an internal list into an external list">
1.75 rillig 4953: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4954: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75 rillig 4955: <pre class="programlisting">
1.100 rillig 4956: EXT_LIST= # empty
4957: .for i in ${INT_LIST}
4958: EXT_LIST+= ${i:Q}""
4959: .endfor
1.1 grant 4960: </pre>
1.75 rillig 4961: <p>This code converts the internal list
4962: <code class="varname">INT_LIST</code> into the external list
4963: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4964: are unquoted they must be quoted here. The reason for appending
4965: <code class="varname">""</code> is explained below.</p>
4966: </div>
1.128 ! wiz 4967: <div class="sect2" title="12.3.3. Passing variables to a shell command">
1.75 rillig 4968: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4969: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4970: <p>Sometimes you may want to print an arbitrary string. There
4971: are many ways to get it wrong and only few that can handle every
4972: nastiness.</p>
1.75 rillig 4973: <pre class="programlisting">
1.100 rillig 4974: STRING= foo bar < > * `date` $$HOME ' "
4975: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4976:
1.100 rillig 4977: all:
4978: echo ${STRING} # 1
4979: echo "${STRING}" # 2
4980: echo "${STRING:Q}" # 3
4981: echo ${STRING:Q} # 4
4982: echo x${STRING:Q} | sed 1s,.,, # 5
4983: printf "%s\\n" ${STRING:Q}"" # 6
4984: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4985: </pre>
1.75 rillig 4986: <p>Example 1 leads to a syntax error in the shell, as the
4987: characters are just copied.</p>
4988: <p>Example 2 leads to a syntax error too, and if you leave out
4989: the last " character from <code class="varname">${STRING}</code>,
1.110 hubertf 4990: <a class="citerefentry" 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
1.75 rillig 4991: variable would be evaluated, too.</p>
4992: <p>Example 3 outputs each space character preceded by a
4993: backslash (or not), depending on the implementation of the
1.110 hubertf 4994: <a class="citerefentry" 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>
1.75 rillig 4995: <p>Example 4 handles correctly every string that does not start
4996: with a dash. In that case, the result depends on the
1.110 hubertf 4997: implementation of the <a class="citerefentry" 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
1.75 rillig 4998: guarantee that your input does not start with a dash, this form is
4999: appropriate.</p>
5000: <p>Example 5 handles even the case of a leading dash
5001: correctly.</p>
1.79 rillig 5002: <p>Example 6 also works with every string and is the
5003: light-weight solution, since it does not involve a pipe, which has
5004: its own problems.</p>
1.75 rillig 5005: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5006: because the quoting has already been done when adding elements to
5007: the list.</p>
5008: <p>As internal lists shall not be passed to the shell, there is
5009: no example for it.</p>
5010: </div>
1.128 ! wiz 5011: <div class="sect2" title="12.3.4. Quoting guideline">
1.75 rillig 5012: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5013: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 5014: <p>There are many possible sources of wrongly quoted variables.
5015: This section lists some of the commonly known ones.</p>
1.128 ! wiz 5016: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 5017: <li class="listitem">
1.75 rillig 5018: <p>Whenever you use the value of a list, think
5019: about what happens to leading or trailing whitespace. If the
5020: list is a well-formed shell expression, you can apply the
5021: <code class="varname">:M*</code> modifier to strip leading and trailing
5022: whitespace from each word. The <code class="varname">:M</code> operator
5023: first splits its argument according to the rules of the shell,
5024: and then creates a new list consisting of all words that match
5025: the shell glob expression <code class="varname">*</code>, that is: all.
5026: One class of situations where this is needed is when adding a
5027: variable like <code class="varname">CPPFLAGS</code> to
5028: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5029: invokes other configure scripts, it strips the leading and
5030: trailing whitespace from the variable and then passes it to the
5031: other configure scripts. But these configure scripts expect the
5032: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5033: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5034: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5035: here is how we do it:</p>
5036: <pre class="programlisting">
1.100 rillig 5037: CPPFLAGS= # empty
5038: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5039: CPPFLAGS+= ${MY_CPPFLAGS}
5040:
5041: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5042:
5043: all:
5044: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5045: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5046: </pre>
1.75 rillig 5047: </li>
1.128 ! wiz 5048: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 5049: <code class="varname">${PREFIX}</code> is a properly quoted shell
5050: expression, but there is the C compiler after it, which also
5051: expects a properly quoted string (this time in C syntax). The
5052: version above is therefore only correct if
5053: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5054: or double quotes. If you want to allow these, you have to add
5055: another layer of quoting to each variable that is used as a C
5056: string literal. You cannot use the <code class="varname">:Q</code>
5057: operator for it, as this operator only works for the
5058: shell.</p></li>
1.128 ! wiz 5059: <li class="listitem">
1.75 rillig 5060: <p>Whenever a variable can be empty, the
5061: <code class="varname">:Q</code> operator can have surprising results. Here
5062: are two completely different cases which can be solved with the
5063: same trick.</p>
5064: <pre class="programlisting">
1.100 rillig 5065: EMPTY= # empty
5066: empty_test:
5067: for i in a ${EMPTY:Q} c; do \
5068: echo "$$i"; \
5069: done
5070:
5071: for_test:
5072: .for i in a:\ a:\test.txt
5073: echo ${i:Q}
5074: echo "foo"
5075: .endfor
1.1 grant 5076: </pre>
1.75 rillig 5077: <p>The first example will only print two of the three lines
5078: we might have expected. This is because
5079: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5080: the shell cannot see. The workaround is to write
5081: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5082: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5083: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5084: <p>The second example will only print three lines instead of
5085: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5086: This is because the backslash of the value
5087: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110 hubertf 5088: <a class="citerefentry" 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
5089: <a class="citerefentry" 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
1.75 rillig 5090: <code class="varname">${i:Q}""</code>.</p>
5091: </li>
5092: </ul></div>
5093: </div>
1.128 ! wiz 5094: <div class="sect2" title="12.3.5. Workaround for a bug in BSD Make">
1.75 rillig 5095: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5096: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5097: <p>The pkgsrc bmake program does not handle the following
5098: assignment correctly. In case <code class="varname">_othervar_</code>
5099: contains a ``-'' character, one of the closing braces is included
5100: in <code class="varname">${VAR}</code> after this code executes.</p>
5101: <pre class="programlisting">
1.100 rillig 5102: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5103: </pre>
1.75 rillig 5104: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5105: 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 5106: <code class="varname">bug1</code>.</p>
5107: </div>
5108: </div>
5109: </div>
1.128 ! wiz 5110: <div class="chapter" title="Chapter 13. PLIST issues">
1.75 rillig 5111: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5112: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 5113: <div class="toc">
5114: <p><b>Table of Contents</b></p>
5115: <dl>
1.106 rillig 5116: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 ! wiz 5117: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
! 5118: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 5119: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5120: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 ! wiz 5121: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106 rillig 5122: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5123: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5124: </dl>
5125: </div>
1.87 wiz 5126: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 ! wiz 5127: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 5128: the package (relative to the <code class="filename">${PREFIX}</code>
5129: directory it's been installed in) plus some additional statements
1.110 hubertf 5130: - see the <a class="citerefentry" 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.
1.87 wiz 5131: This chapter addresses some issues that need attention when
5132: dealing with the <code class="filename">PLIST</code> file (or files, see
5133: below!).</p>
1.128 ! wiz 5134: <div class="sect1" title="13.1. RCS ID">
1.75 rillig 5135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5136: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 5137: <p>Be sure to add a RCS ID line as the first thing in any
5138: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5139: <pre class="programlisting">
1.100 rillig 5140: @comment $NetBSD$
1.87 wiz 5141: </pre>
1.75 rillig 5142: </div>
1.128 ! wiz 5143: <div class="sect1" title="13.2. Semi-automatic PLIST generation">
1.75 rillig 5144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5145: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 5146: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 5147: to output a PLIST that matches any new files since the package
1.110 hubertf 5148: was extracted. See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.87 wiz 5149: more information on this target.</p>
1.75 rillig 5150: </div>
1.128 ! wiz 5151: <div class="sect1" title="13.3. Tweaking output of make print-PLIST">
1.75 rillig 5152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 5153: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 5154: </h2></div></div></div>
1.87 wiz 5155: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 5156: <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, “Sharing directories between packages”</a>, you may have noticed that
5157: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 5158: <code class="varname">@comment</code>s instead of real
5159: <code class="varname">@dirrm</code> lines. You can also do this for
5160: specific directories and files, so that the results of that
5161: command are very close to reality. This helps <span class="emphasis"><em>a
5162: lot</em></span> during the update of packages.</p>
5163: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5164: of AWK patterns and actions that are used to filter the output of
5165: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5166: scripting you like to it, but be careful with quoting.</p>
5167: <p>For example, to get all files inside the
5168: <code class="filename">libdata/foo</code> directory removed from the
5169: resulting PLIST:</p>
5170: <pre class="programlisting">
1.100 rillig 5171: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5172: </pre>
5173: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5174: to a specific (shared) directory converted to
5175: <code class="varname">@comment</code>s:</p>
1.75 rillig 5176: <pre class="programlisting">
1.100 rillig 5177: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5178: </pre>
1.75 rillig 5179: </div>
1.128 ! wiz 5180: <div class="sect1" title="13.4. Variable substitution in PLIST">
1.75 rillig 5181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5182: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5183: <p>A number of variables are substituted automatically in
5184: PLISTs when a package is installed on a system. This includes the
5185: following variables:</p>
1.75 rillig 5186: <div class="variablelist"><dl>
5187: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5188: <dd>
5189: <p>Some packages like emacs and perl embed information
1.87 wiz 5190: about which architecture they were built on into the
5191: pathnames where they install their files. To handle this
5192: case, PLIST will be preprocessed before actually used, and
5193: the symbol
1.128 ! wiz 5194: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 5195: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 5196: same is done if the string
5197: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5198: PLIST somewhere - use this on packages that have GNU
5199: autoconf-created configure scripts.</p>
1.128 ! wiz 5200: <div class="note" title="Legacy note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 5201: <h3 class="title">Legacy note</h3>
5202: <p>There used to be a symbol
1.128 ! wiz 5203: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 5204: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 5205: -m</strong></span>, but that's no longer supported and has
5206: been removed.</p>
1.75 rillig 5207: </div>
5208: </dd>
5209: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5210: <dd>
5211: <p>Some packages want to embed the OS name and version
1.87 wiz 5212: into some paths. To do this, use these variables in the
5213: <code class="filename">PLIST</code>:
5214: </p>
1.128 ! wiz 5215: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 5216: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">“<span class="quote"><span class="command"><strong>uname -s</strong></span></span>”</span></p></li>
! 5217: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">“<span class="quote">solaris</span>”</span>)</p></li>
! 5218: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.75 rillig 5219: </ul></div>
5220: </dd>
5221: </dl></div>
1.87 wiz 5222: <p>For a complete list of values which are replaced by
5223: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5224: search for <code class="varname">PLIST_SUBST</code>).</p>
5225: <p>If you want to change other variables not listed above, you
5226: can add variables and their expansions to this variable in the
1.110 hubertf 5227: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.75 rillig 5228: <pre class="programlisting">
1.100 rillig 5229: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5230: </pre>
1.128 ! wiz 5231: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 5232: in the <code class="filename">PLIST</code> with
1.128 ! wiz 5233: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 5234: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 5235: the common case of conditionally including some
5236: <code class="filename">PLIST</code> entries. It can be done by adding
5237: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 5238: setting the corresponding <code class="varname">PLIST.foo</code> variable
5239: to <code class="literal">yes</code> if the entry should be included.
1.128 ! wiz 5240: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 5241: in the <code class="filename">PLIST</code> with either
1.128 ! wiz 5242: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
! 5243: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 5244: For example, in <code class="filename">Makefile</code>:</p>
5245: <pre class="programlisting">
5246: PLIST_VARS+= foo
5247: .if <em class="replaceable"><code>condition</code></em>
5248: PLIST.foo= yes
5249: .else
5250: </pre>
5251: <p>And then in <code class="filename">PLIST</code>:</p>
5252: <pre class="programlisting">
5253: @comment $NetBSD$
5254: bin/bar
5255: man/man1/bar.1
5256: ${PLIST.foo}bin/foo
5257: ${PLIST.foo}man/man1/foo.1
5258: ${PLIST.foo}share/bar/foo.data
5259: ${PLIST.foo}@dirrm share/bar
5260: </pre>
1.75 rillig 5261: </div>
1.128 ! wiz 5262: <div class="sect1" title="13.5. Man page compression">
1.75 rillig 5263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5264: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5265: <p>Man pages should be installed in compressed form if
1.87 wiz 5266: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5267: and uncompressed otherwise. To handle this in the
1.128 ! wiz 5268: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5269: appended/removed automatically for man pages according to
5270: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5271: or not, see above for details. This modification of the
5272: <code class="filename">PLIST</code> file is done on a copy of it, not
5273: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5274: </div>
1.128 ! wiz 5275: <div class="sect1" title="13.6. Changing PLIST source with PLIST_SRC">
1.75 rillig 5276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5277: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5278: </h2></div></div></div>
1.76 rillig 5279: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5280: in generating the binary package, set the variable
5281: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110 hubertf 5282: The files are later concatenated using <a class="citerefentry" 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
1.87 wiz 5283: important. The default for <code class="varname">PLIST_SRC</code> is
5284: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5285: </div>
1.128 ! wiz 5286: <div class="sect1" title="13.7. Platform-specific and differing PLISTs">
1.75 rillig 5287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5288: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5289: <p>Some packages decide to install a different set of files based on
1.87 wiz 5290: the operating system being used. These differences can be
5291: automatically handled by using the following files:</p>
1.128 ! wiz 5292: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 5293: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
! 5294: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
! 5295: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
! 5296: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
! 5297: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5298: </ul></div>
5299: </div>
1.128 ! wiz 5300: <div class="sect1" title="13.8. Sharing directories between packages">
1.75 rillig 5301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5302: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.128 ! wiz 5303: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5304: multiple (and unrelated) packages install files. These
1.125 wiz 5305: directories were problematic because you had to add special
5306: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5307: centralized package handle them.</p>
1.125 wiz 5308: <p>In pkgsrc, it is now easy: Each package should create
5309: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5310: will remove any directories left empty after uninstalling a
5311: package.</p>
5312: <p>If a package needs an empty directory to work, create
5313: the directory during installation as usual, and also add an
5314: entry to the PLIST:
5315: </p>
1.87 wiz 5316: <pre class="programlisting">
1.125 wiz 5317: @pkgdir path/to/empty/directory
1.87 wiz 5318: </pre>
1.125 wiz 5319: <p>
5320: </p>
1.75 rillig 5321: </div>
5322: </div>
1.128 ! wiz 5323: <div class="chapter" title="Chapter 14. Buildlink methodology">
1.75 rillig 5324: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5325: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5326: <div class="toc">
5327: <p><b>Table of Contents</b></p>
5328: <dl>
1.106 rillig 5329: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 ! wiz 5330: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5331: <dd><dl>
1.106 rillig 5332: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.128 ! wiz 5333: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.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 5334: </dl></dd>
1.128 ! wiz 5335: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75 rillig 5336: <dd><dl>
1.128 ! wiz 5337: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106 rillig 5338: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75 rillig 5339: </dl></dd>
5340: </dl>
5341: </div>
5342: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5343: are seen by a package's configure and build processes. This is implemented
5344: in a two step process:</p>
1.128 ! wiz 5345: <div class="orderedlist"><ol class="orderedlist" type="1">
! 5346: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5347: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5348: of <code class="varname">WRKDIR</code>.</p></li>
1.128 ! wiz 5349: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5350: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5351: <code class="option">-L${LOCALBASE}/lib</code> into references to
5352: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5353: native compiler on some operating systems look like GCC, so that
5354: packages that expect GCC won't require modifications to build with
5355: those native compilers.</p></li>
1.75 rillig 5356: </ol></div>
5357: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5358: package may be built consistently despite what other software may be
5359: installed. Please note that the normal system header and library paths,
5360: e.g. <code class="filename">/usr/include</code>,
5361: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5362: designed to insulate the package build from non-system-supplied
5363: software.</p>
1.128 ! wiz 5364: <div class="sect1" title="14.1. Converting packages to use buildlink3">
1.75 rillig 5365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5366: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5367: <p>The process of converting packages to use the buildlink3
1.128 ! wiz 5368: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5369: The things to keep in mind are:</p>
1.128 ! wiz 5370: <div class="orderedlist"><ol class="orderedlist" type="1">
! 5371: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5372: instead of the actual toolchain. Some packages are tricky,
5373: and the only way to know for sure is the check
5374: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5375: wrappers are being invoked.</p></li>
1.128 ! wiz 5376: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5377: the package Makefile, e.g. Java VMs, standalone shells,
5378: etc., because the code to symlink files into
5379: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 ! wiz 5380: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5381: </p></li>
1.128 ! wiz 5382: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5383: <code class="filename">buildlink3.mk</code> files that you list in a
5384: package's Makefile are added as dependencies for that package.
5385: </p></li>
1.75 rillig 5386: </ol></div>
1.87 wiz 5387: <p>If a dependency on a particular package is required for its libraries and
5388: headers, then we replace:</p>
1.75 rillig 5389: <pre class="programlisting">
1.100 rillig 5390: DEPENDS+= foo>=1.1.0:../../category/foo
5391: </pre>
1.75 rillig 5392: <p>with</p>
5393: <pre class="programlisting">
1.100 rillig 5394: .include "../../category/foo/buildlink3.mk"
5395: </pre>
1.75 rillig 5396: <p>The buildlink3.mk files usually define the required dependencies.
5397: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5398: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5399: <pre class="programlisting">
1.100 rillig 5400: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5401: .include "../../category/foo/buildlink3.mk"
5402: </pre>
1.76 rillig 5403: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5404: files in <code class="filename">pkgsrc/mk</code>
5405: that handle special package issues:</p>
1.128 ! wiz 5406: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 5407: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5408: the native or a pkgsrc Berkeley DB implementation based on
5409: the values of <code class="varname">BDB_ACCEPTED</code> and
5410: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 ! wiz 5411: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5412: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5413: 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.128 ! wiz 5414: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5415: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5416: adding a dependency on Heimdal or MIT-krb5 for packages that
5417: require a Kerberos 5 implementation.</p></li>
1.128 ! wiz 5418: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5419: system-provided Motif installation or adds a dependency on
1.91 rillig 5420: <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.128 ! wiz 5421: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
! 5422: <span class="quote">“<span class="quote">lesstif</span>”</span>, or <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5423: which Motif version will be used.</p></li>
1.128 ! wiz 5424: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5425: variables that may be used by packages that use the
5426: Open Sound System (OSS) API.</p></li>
1.128 ! wiz 5427: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5428: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5429: the file for more information.</p></li>
1.128 ! wiz 5430: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5431: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5432: 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.128 ! wiz 5433: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5434: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5435: library.</p></li>
1.75 rillig 5436: </ul></div>
1.76 rillig 5437: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5438: files provide a more complete
5439: description of how to use them properly.</p>
1.75 rillig 5440: </div>
1.128 ! wiz 5441: <div class="sect1" title="14.2. Writing buildlink3.mk files">
1.75 rillig 5442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5443: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5444: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5445: included by Makefiles to indicate the need to compile and link
5446: against header files and libraries provided by the package. A
5447: <code class="filename">buildlink3.mk</code> file should always provide
5448: enough information to add the correct type of dependency
5449: relationship and include any other
5450: <code class="filename">buildlink3.mk</code> files that it needs to find
5451: headers and libraries that it needs in turn.</p>
5452: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5453: 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 5454: package is highly recommended. For most packages, the following
5455: command will generate a good starting point for
5456: <code class="filename">buildlink3.mk</code> files:</p>
5457: <pre class="screen">
5458: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5459: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5460: </pre>
1.128 ! wiz 5461: <div class="sect2" title="14.2.1. Anatomy of a buildlink3.mk file">
1.75 rillig 5462: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5463: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5464: <p>The following real-life example
1.87 wiz 5465: <code class="filename">buildlink3.mk</code> is taken
5466: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5467: <pre class="programlisting">
1.120 snj 5468: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5469:
1.120 snj 5470: BUILDLINK_TREE+= tiff
1.1 grant 5471:
1.120 snj 5472: .if !defined(TIFF_BUILDLINK3_MK)
5473: TIFF_BUILDLINK3_MK:=
1.87 wiz 5474:
1.120 snj 5475: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5476: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5477: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5478:
1.100 rillig 5479: .include "../../devel/zlib/buildlink3.mk"
5480: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5481: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5482:
1.120 snj 5483: BUILDLINK_TREE+= -tiff
1.100 rillig 5484: </pre>
1.87 wiz 5485: <p>The header and footer manipulate
1.120 snj 5486: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5487: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5488: the dependency tree.</p>
5489: <p>The main section is protected from multiple inclusion
1.87 wiz 5490: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5491: added. Several important variables are set in the section:</p>
1.128 ! wiz 5492: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 5493: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5494: is the actual dependency recorded in the installed
5495: package; this should always be set using
1.110 hubertf 5496: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5497: we're appending to any pre-existing list of values. This
5498: variable should be set to the first version of the
5499: package that had an API change.
5500: </p></li>
1.128 ! wiz 5501: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5502: is the location of the <em class="replaceable"><code>pkg</code></em>
5503: pkgsrc directory.</p></li>
1.128 ! wiz 5504: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5505: (not shown above) controls whether we use
5506: <code class="varname">BUILD_DEPENDS</code> or
5507: <code class="varname">DEPENDS</code> to add the dependency on
5508: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5509: selected by setting
5510: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 ! wiz 5511: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5512: used.</p></li>
1.128 ! wiz 5513: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5514: and
5515: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5516: (not shown above) are lists of subdirectories of
1.76 rillig 5517: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5518: to add to the header and library search paths. These
1.128 ! wiz 5519: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5520: respectively.</p></li>
1.128 ! wiz 5521: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5522: (not shown above) is the list of preprocessor flags to add
5523: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 ! wiz 5524: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5525: should be avoided and instead be handled using
5526: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5527: above.</p></li>
1.75 rillig 5528: </ul></div>
1.87 wiz 5529: <p>The following variables are all optionally defined within
5530: this second section (protected against multiple inclusion) and
5531: control which package files are symlinked into
5532: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5533: transformed during the symlinking:</p>
1.128 ! wiz 5534: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 5535: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5536: (not shown above) is a shell glob pattern relative to
1.76 rillig 5537: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5538: to be symlinked into
1.76 rillig 5539: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5540: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 ! wiz 5541: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5542: (not shown above) is a shell pipeline that
5543: outputs to stdout a list of files relative to
5544: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5545: The resulting files are to be symlinked
5546: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5547: this takes the <code class="filename">+CONTENTS</code> of a
5548: <em class="replaceable"><code>pkg</code></em> and filters it through
5549: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 ! wiz 5550: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5551: (not shown above) is a filter command that filters
1.76 rillig 5552: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5553: relative to
1.76 rillig 5554: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5555: on stdout. By default for overwrite packages,
5556: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5557: outputs the contents of the <code class="filename">include</code>
5558: and <code class="filename">lib</code> directories in the package
5559: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5560: it outputs any libtool archives in
1.87 wiz 5561: <code class="filename">lib</code> directories.</p></li>
1.128 ! wiz 5562: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5563: (not shown above) is a list of sed arguments used to
5564: transform the name of the source filename into a
1.110 hubertf 5565: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5566: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5567: </ul></div>
1.120 snj 5568: <p>This section can additionally include any
1.87 wiz 5569: <code class="filename">buildlink3.mk</code> needed for
5570: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5571: Including these <code class="filename">buildlink3.mk</code> files
5572: means that the headers and libraries for these
5573: dependencies are also symlinked into
5574: <code class="filename">${BUILDLINK_DIR}</code>
5575: whenever the <em class="replaceable"><code>pkg</code></em>
5576: <code class="filename">buildlink3.mk</code>
1.120 snj 5577: file is included. Dependencies are only added for directly
5578: include <code class="filename">buildlink3.mk</code> files.</p>
1.75 rillig 5579: </div>
1.128 ! wiz 5580: <div class="sect2" title="14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files">
1.75 rillig 5581: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5582: <a name="updating-buildlink-depends"></a>14.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 5583: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5584: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5585: after a package update is when the API or interface to the
1.87 wiz 5586: header files change.</p>
5587: <p>In this case,
5588: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5589: should be adjusted to require at least the new package
5590: version. In some cases, the packages that depend on this new
5591: version may need their <code class="varname">PKGREVISION</code>s
5592: increased and, if they have <code class="filename">buildlink3.mk</code>
5593: files, their
5594: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5595: adjusted, too. This is needed so pkgsrc will require the
5596: correct package dependency and not settle for an older one
5597: when building the source.</p>
5598: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5599: should be increased when the binary interface or sonames
5600: (major number of the library version) of any installed
5601: shared libraries change. This is needed so that binary
5602: packages made using it will require the correct package
5603: dependency and not settle for an older one which will not
1.87 wiz 5604: contain the necessary shared libraries.</p>
1.110 hubertf 5605: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.75 rillig 5606: more information about dependencies on other packages,
5607: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5608: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5609: <p>Please take careful consideration before adjusting
5610: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5611: or
5612: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5613: as we don't want to cause unneeded package deletions and
5614: rebuilds. In many cases, new versions of packages work just
5615: fine with older dependencies.</p>
5616: <p>Also it is not needed to set
1.75 rillig 5617: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5618: when it is identical to
1.87 wiz 5619: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5620: </div>
5621: </div>
1.128 ! wiz 5622: <div class="sect1" title="14.3. Writing builtin.mk files">
1.75 rillig 5623: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5624: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5625: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5626: coincide with headers and libraries present in the base system.
1.76 rillig 5627: Aside from a <code class="filename">buildlink3.mk</code> file, these
5628: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5629: file that includes the necessary checks to decide whether using
5630: the built-in software or the pkgsrc software is
1.87 wiz 5631: appropriate.</p>
5632: <p>The only requirements of a builtin.mk file for
5633: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 ! wiz 5634: <div class="orderedlist"><ol class="orderedlist" type="1">
! 5635: <li class="listitem"><p>It should set
1.87 wiz 5636: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 ! wiz 5637: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5638: after it is included.</p></li>
1.128 ! wiz 5639: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5640: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5641: which is already set before the
5642: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 ! wiz 5643: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5644: is <span class="emphasis"><em>very</em></span> important and takes careful
5645: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5646: </ol></div>
1.128 ! wiz 5647: <div class="sect2" title="14.3.1. Anatomy of a builtin.mk file">
1.75 rillig 5648: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5649: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75 rillig 5650: <p>The following is the recommended template for builtin.mk
1.87 wiz 5651: files:</p>
1.75 rillig 5652: <pre class="programlisting">
1.100 rillig 5653: .if !defined(IS_BUILTIN.foo)
5654: #
5655: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5656: # genuinely exists in the system or not.
5657: #
5658: IS_BUILTIN.foo?= no
5659:
5660: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5661: # version can be determined.
5662: #
5663: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5664: BUILTIN_PKG.foo?= foo-1.0
5665: . endif
5666: .endif # IS_BUILTIN.foo
5667:
5668: .if !defined(USE_BUILTIN.foo)
5669: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5670: . if defined(BUILTIN_PKG.foo)
5671: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5672: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5673: USE_BUILTIN.foo!= \
5674: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5675: && ${ECHO} "yes" || ${ECHO} "no"
5676: . endif
5677: . endfor
5678: . endif
5679: .endif # USE_BUILTIN.foo
5680:
5681: CHECK_BUILTIN.foo?= no
5682: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5683: #
5684: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5685: # "yes" or "no".
5686: #
5687: .endif # CHECK_BUILTIN.foo
5688: </pre>
1.87 wiz 5689: <p>The first section sets
5690: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5691: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5692: in the base system. This should not be a base system software
5693: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 ! wiz 5694: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5695: included as part of the base system. This variable is only
5696: used internally within the <code class="filename">builtin.mk</code>
5697: file.</p>
5698: <p>The second section sets
5699: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5700: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5701: system if it exists (if
5702: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 ! wiz 5703: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5704: within the <code class="filename">builtin.mk</code> file.</p>
5705: <p>The third section sets
5706: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5707: and is <span class="emphasis"><em>required</em></span> in all
5708: <code class="filename">builtin.mk</code> files. The code in this
5709: section must make the determination whether the built-in
5710: software is adequate to satisfy the dependencies listed in
5711: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5712: This is typically done by comparing
5713: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5714: against each of the dependencies in
5715: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5716: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5717: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5718: end of the <code class="filename">builtin.mk</code> file. Note that
5719: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 ! wiz 5720: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5721: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 ! wiz 5722: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5723: that the built-in version of the software is similar enough to
5724: be used as a replacement.</p>
5725: <p>The last section is guarded by
5726: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5727: and includes code that uses the value of
5728: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5729: set in the previous section. This typically includes, e.g.,
5730: adding additional dependency restrictions and listing additional
5731: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5732: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5733: </div>
1.128 ! wiz 5734: <div class="sect2" title="14.3.2. Global preferences for native or pkgsrc software">
1.75 rillig 5735: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5736: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5737: <p>When building packages, it's possible to choose whether to set
5738: a global preference for using either the built-in (native)
5739: version or the pkgsrc version of software to satisfy a
5740: dependency. This is controlled by setting
5741: <code class="varname">PREFER_PKGSRC</code> and
5742: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 ! wiz 5743: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
1.87 wiz 5744: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5745: use the pkgsrc versions of software, while
5746: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5747: built-in versions. Preferences are determined by the most
5748: specific instance of the package in either
5749: <code class="varname">PREFER_PKGSRC</code> or
5750: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5751: in neither or in both variables, then
5752: <code class="varname">PREFER_PKGSRC</code> has precedence over
5753: <code class="varname">PREFER_NATIVE</code>. For example, to require
5754: using pkgsrc versions of software for all but the most basic
5755: bits on a NetBSD system, you can set:</p>
5756: <pre class="programlisting">
1.100 rillig 5757: PREFER_PKGSRC= yes
5758: PREFER_NATIVE= getopt skey tcp_wrappers
5759: </pre>
1.87 wiz 5760: <p>A package <span class="emphasis"><em>must</em></span> have a
5761: <code class="filename">builtin.mk</code>
5762: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5763: otherwise it is simply ignored in that list.</p>
1.75 rillig 5764: </div>
5765: </div>
5766: </div>
1.128 ! wiz 5767: <div class="chapter" title="Chapter 15. The pkginstall framework">
1.75 rillig 5768: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5769: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5770: <div class="toc">
5771: <p><b>Table of Contents</b></p>
5772: <dl>
1.106 rillig 5773: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75 rillig 5774: <dd><dl>
1.106 rillig 5775: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5776: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5777: </dl></dd>
1.106 rillig 5778: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5779: <dd><dl>
1.128 ! wiz 5780: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106 rillig 5781: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5782: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5783: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5784: </dl></dd>
5785: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5786: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
5787: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5788: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5789: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5790: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5791: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75 rillig 5792: </dl>
5793: </div>
5794: <p>This chapter describes the framework known as
5795: <code class="literal">pkginstall</code>, whose key features are:</p>
1.128 ! wiz 5796: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 5797: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5798: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 ! wiz 5799: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5800: provided that packages are correctly designed.</p></li>
1.128 ! wiz 5801: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
! 5802: <li class="listitem"><p>Registration of system users and groups.</p></li>
! 5803: <li class="listitem"><p>Registration of system shells.</p></li>
! 5804: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5805: </ul></div>
5806: <p>The following sections inspect each of the above points in detail.</p>
5807: <p>You may be thinking that many of the things described here could be
5808: easily done with simple code in the package's post-installation target
5809: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5810: as the code in them is only executed when building from source. Machines
5811: using binary packages could not benefit from it at all (as the code itself
5812: could be unavailable). Therefore, the only way to achieve any of the items
5813: described above is by means of the installation scripts, which are
5814: automatically generated by pkginstall.</p>
1.128 ! wiz 5815: <div class="sect1" title="15.1. Files and directories outside the installation prefix">
1.75 rillig 5816: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5817: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5818: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5819: of files and directories that belong to a package. The names used in it
1.76 rillig 5820: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5821: which means that it cannot register files outside this directory (absolute
5822: path names are not allowed). Despite this restriction, some packages need
5823: to install files outside this location; e.g., under
1.76 rillig 5824: <code class="filename">${VARBASE}</code> or
1.87 wiz 5825: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5826: is to create such files during installation time by using
5827: installation scripts.</p>
5828: <p>The generic installation scripts are shell scripts that can
5829: contain arbitrary code. The list of scripts to execute is taken from
5830: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5831: <code class="filename">INSTALL</code>. A similar variable exists for package
5832: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5833: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5834: commands, so they have the potential to create and manage files
5835: anywhere in the file system.</p>
5836: <p>Using these general installation files is not recommended, but
5837: may be needed in some special cases. One reason for avoiding them is
5838: that the user has to trust the packager that there is no unwanted or
5839: simply erroneous code included in the installation script. Also,
5840: previously there were many similar scripts for the same functionality,
5841: and fixing a common error involved finding and changing all of
5842: them.</p>
5843: <p>The pkginstall framework offers another, standardized way. It
5844: provides generic scripts to abstract the manipulation of such files
5845: and directories based on variables set in the package's
5846: <code class="filename">Makefile</code>. The rest of this section describes
5847: these variables.</p>
1.128 ! wiz 5848: <div class="sect2" title="15.1.1. Directory manipulation">
1.75 rillig 5849: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5850: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5851: <p>The following variables can be set to request the creation of
5852: directories anywhere in the file system:</p>
1.128 ! wiz 5853: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 5854: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5855: contain a list of directories that should be created and should attempt
5856: to be destroyed by the installation scripts. The difference between
5857: the two is that the latter prompts the administrator to remove any
5858: directories that may be left after deinstallation (because they were
5859: not empty), while the former does not.</p></li>
1.128 ! wiz 5860: <li class="listitem">
1.75 rillig 5861: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5862: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5863: which directories should be created and should attempt to be destroyed
5864: by the installation scripts. Each tuple holds the following values,
5865: separated by spaces: the directory name, its owner, its group and its
5866: numerical mode. For example:</p>
5867: <pre class="programlisting">
1.100 rillig 5868: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5869: </pre>
1.75 rillig 5870: <p>The difference between the two is exactly the same as their
5871: non-<code class="varname">PERMS</code> counterparts.</p>
5872: </li>
5873: </ul></div>
5874: </div>
1.128 ! wiz 5875: <div class="sect2" title="15.1.2. File manipulation">
1.75 rillig 5876: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5877: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5878: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5879: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5880: To overcome this problem, the only solution is to extract the file in the
5881: known place (i.e., inside the installation prefix) and copy it to the
5882: appropriate location during installation (done by the installation scripts
5883: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5884: file</em></span> in the following paragraphs, which describe the variables
5885: that can be used to automatically and consistently handle files outside the
5886: installation prefix:</p>
1.128 ! wiz 5887: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 5888: <li class="listitem">
1.75 rillig 5889: <p><code class="varname">CONF_FILES</code> and
5890: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5891: During installation time, the master file is copied to the target one
5892: if and only if the latter does not exist. Upon deinstallation, the
5893: target file is removed provided that it was not modified by the
5894: installation.</p>
5895: <p>The difference between the two is that the latter prompts the
5896: administrator to remove any files that may be left after
5897: deinstallation (because they were not empty), while the former does
5898: not.</p>
5899: </li>
1.128 ! wiz 5900: <li class="listitem">
1.75 rillig 5901: <p><code class="varname">CONF_FILES_PERMS</code> and
5902: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5903: files as well as their target locations. For each of them, it also
5904: specifies their owner, their group and their numeric permissions, in
5905: this order. For example:</p>
5906: <pre class="programlisting">
1.100 rillig 5907: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5908: </pre>
1.75 rillig 5909: <p>The difference between the two is exactly the same as their
5910: non-<code class="varname">PERMS</code> counterparts.</p>
5911: </li>
5912: </ul></div>
5913: </div>
5914: </div>
1.128 ! wiz 5915: <div class="sect1" title="15.2. Configuration files">
1.75 rillig 5916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5917: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5918: <p>Configuration files are special in the sense that they are installed
5919: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5920: need special treatment during installation (most of which is automated by
5921: pkginstall). The main concept you must bear in mind is that files marked
5922: as configuration files are automatically copied to the right place (somewhere
5923: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5924: and only if</em></span> they didn't exist before. Similarly, they will not
5925: be removed if they have local modifications. This ensures that
5926: administrators never lose any custom changes they may have made.</p>
1.128 ! wiz 5927: <div class="sect2" title="15.2.1. How PKG_SYSCONFDIR is set">
1.75 rillig 5928: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5929: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75 rillig 5930: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5931: specifies where configuration files shall be installed. Its contents are
5932: set based upon the following variables:</p>
1.128 ! wiz 5933: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 5934: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5935: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5936: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5937: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5938: Packages must not use it directly.</p></li>
1.128 ! wiz 5939: <li class="listitem">
1.75 rillig 5940: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5941: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5942: for the package being built shall be installed. The definition of this
5943: variable only makes sense in the package's
1.76 rillig 5944: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5945: <p>As an example, consider the Apache package,
1.91 rillig 5946: <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 5947: configuration files under the
1.76 rillig 5948: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5949: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5950: Makefile.</p>
5951: </li>
1.128 ! wiz 5952: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5953: variable that holds this package's configuration directory (if
5954: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5955: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5956: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 ! wiz 5957: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5958: directory where the configuration files for the package identified by
5959: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5960: </ul></div>
5961: <p>Based on the above variables, pkginstall determines the value of
5962: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5963: variable that can be used within a package to refer to its configuration
5964: directory. The algorithm used to set its value is basically the
5965: following:</p>
1.128 ! wiz 5966: <div class="orderedlist"><ol class="orderedlist" type="1">
! 5967: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5968: its value is used.</p></li>
1.128 ! wiz 5969: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5970: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5971: <code class="filename">Makefile</code>, the resulting value is
5972: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 ! wiz 5973: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5974: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5975: </ol></div>
1.76 rillig 5976: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5977: automatically added to <code class="filename">OWN_DIRS</code>. See <a class="xref" href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, “Directory manipulation”</a> what this means. This does not apply to
5978: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5979: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5980: </div>
1.128 ! wiz 5981: <div class="sect2" title="15.2.2. Telling the software where configuration files are">
1.75 rillig 5982: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5983: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5984: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5985: known place, you need to teach each package where it shall install its
5986: files. In some cases you will have to patch the package Makefiles to
5987: achieve it. If you are lucky, though, it may be as easy as passing an
5988: extra flag to the configuration script; this is the case of GNU Autoconf-
5989: generated files:</p>
5990: <pre class="programlisting">
1.100 rillig 5991: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5992: </pre>
1.75 rillig 5993: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5994: for</em></span> its configuration files, not where they will be originally
5995: installed (although the difference is never explicit,
5996: unfortunately).</p>
5997: </div>
1.128 ! wiz 5998: <div class="sect2" title="15.2.3. Patching installations">
1.75 rillig 5999: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6000: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6001: <p>As said before, pkginstall automatically handles configuration files.
6002: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6003: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6004: directly</strong></span>. Bad news is that many software installation scripts
6005: will, out of the box, mess with the contents of that directory. So what is
6006: the correct procedure to fix this issue?</p>
6007: <p>You must teach the package (usually by manually patching it) to
6008: install any configuration files under the examples hierarchy,
1.76 rillig 6009: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6010: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6011: has the original copies available.</p>
6012: <p>Once the required configuration files are in place (i.e., under the
6013: examples hierarchy), the pkginstall framework can use them as master copies
6014: during the package installation to update what is in
1.76 rillig 6015: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6016: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 6017: used. Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, “File manipulation”</a> for information
1.75 rillig 6018: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6019: <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 6020: <pre class="programlisting">
1.100 rillig 6021: EGDIR= ${PREFIX}/share/doc/mutt/samples
6022: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6023: </pre>
1.75 rillig 6024: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6025: package and has no meaning outside it.</p>
6026: </div>
1.128 ! wiz 6027: <div class="sect2" title="15.2.4. Disabling handling of configuration files">
1.75 rillig 6028: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6029: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6030: <p>The automatic copying of config files can be toggled by setting the
6031: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6032: installation.</p>
6033: </div>
6034: </div>
1.128 ! wiz 6035: <div class="sect1" title="15.3. System startup scripts">
1.75 rillig 6036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6037: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 6038: <p>System startup scripts are special files because they must be
6039: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 6040: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.75 rillig 6041: can be used. However, pkginstall provides a special mechanism to handle
6042: these files.</p>
6043: <p>In order to provide system startup scripts, the package has
6044: to:</p>
1.128 ! wiz 6045: <div class="orderedlist"><ol class="orderedlist" type="1">
! 6046: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6047: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6048: <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 6049: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 ! wiz 6050: <li class="listitem">
1.75 rillig 6051: <p>Tell pkginstall to handle it, appending the name of the script,
6052: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6053: Continuing the previous example:</p>
6054: <pre class="programlisting">
1.100 rillig 6055: RCD_SCRIPTS+= cupsd
1.1 grant 6056: </pre>
1.75 rillig 6057: </li>
6058: </ol></div>
6059: <p>Once this is done, pkginstall will do the following steps for each
6060: script in an automated fashion:</p>
1.128 ! wiz 6061: <div class="orderedlist"><ol class="orderedlist" type="1">
! 6062: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 6063: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6064: variable.</p></li>
1.128 ! wiz 6065: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 6066: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6067: that this master file must be explicitly registered in the
1.76 rillig 6068: <code class="filename">PLIST</code>.</p></li>
1.128 ! wiz 6069: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 6070: from the examples hierarchy into the system-wide startup scripts
6071: directory.</p></li>
6072: </ol></div>
1.128 ! wiz 6073: <div class="sect2" title="15.3.1. Disabling handling of system startup scripts">
1.75 rillig 6074: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6075: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6076: <p>The automatic copying of config files can be toggled by setting the
6077: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6078: installation. Note that the scripts will be always copied inside the
1.76 rillig 6079: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6080: matter what the value of this variable is.</p>
6081: </div>
6082: </div>
1.128 ! wiz 6083: <div class="sect1" title="15.4. System users and groups">
1.75 rillig 6084: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6085: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 6086: <p>If a package needs to create special users and/or groups during
6087: installation, it can do so by using the pkginstall framework.</p>
6088: <p>Users can be created by adding entries to the
6089: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6090: syntax:</p>
6091: <pre class="programlisting">
1.100 rillig 6092: user:group
1.1 grant 6093: </pre>
1.87 wiz 6094: <p>Further specification of user details may be done by setting
6095: per-user variables.
6096: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6097: numeric UID for the user.
6098: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6099: user's description or comment.
6100: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6101: user's home directory, and defaults to
6102: <code class="filename">/nonexistent</code> if not specified.
6103: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6104: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6105: not specified.</p>
1.75 rillig 6106: <p>Similarly, groups can be created by adding entries to the
6107: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6108: <pre class="programlisting">
1.100 rillig 6109: group
1.1 grant 6110: </pre>
1.93 rillig 6111: <p>The numeric GID of the group may be set by defining
1.75 rillig 6112: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6113: <p>If a package needs to create the users and groups at an earlier
6114: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6115: either <code class="literal">configure</code> or <code class="literal">build</code> to
6116: indicate the phase before which the users and groups are created. In
6117: this case, the numeric UIDs and GIDs of the created users and groups
6118: are automatically hardcoded into the final installation scripts.</p>
6119: </div>
1.128 ! wiz 6120: <div class="sect1" title="15.5. System shells">
1.75 rillig 6121: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6122: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 6123: <p>Packages that install system shells should register them in the shell
1.76 rillig 6124: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6125: administrator. This must be done from the installation scripts to keep
6126: binary packages working on any system. pkginstall provides an easy way to
6127: accomplish this task.</p>
6128: <p>When a package provides a shell interpreter, it has to set the
6129: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6130: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6131: 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 6132: <pre class="programlisting">
1.100 rillig 6133: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6134: </pre>
1.128 ! wiz 6135: <div class="sect2" title="15.5.1. Disabling shell registration">
1.75 rillig 6136: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6137: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6138: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6139: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6140: environment variable to <code class="literal">NO</code>.</p>
6141: </div>
6142: </div>
1.128 ! wiz 6143: <div class="sect1" title="15.6. Fonts">
1.75 rillig 6144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6145: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 6146: <p>Packages that install X11 fonts should update the database files
6147: that index the fonts within each fonts directory. This can easily be
6148: accomplished within the pkginstall framework.</p>
6149: <p>When a package installs X11 fonts, it must list the directories in
6150: which fonts are installed in the
6151: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 ! wiz 6152: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
! 6153: <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>. This will add hooks to the
1.75 rillig 6154: installation scripts to run the appropriate commands to update the fonts
6155: database files within each of those directories. For convenience, if the
6156: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6157: 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 6158: <pre class="programlisting">
1.100 rillig 6159: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6160: </pre>
1.128 ! wiz 6161: <div class="sect2" title="15.6.1. Disabling automatic update of the fonts databases">
1.75 rillig 6162: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6163: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6164: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6165: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6166: environment variable to <code class="literal">NO</code>.</p>
6167: </div>
6168: </div>
6169: </div>
1.128 ! wiz 6170: <div class="chapter" title="Chapter 16. Options handling">
1.75 rillig 6171: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6172: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 6173: <div class="toc">
6174: <p><b>Table of Contents</b></p>
6175: <dl>
1.106 rillig 6176: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 ! wiz 6177: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106 rillig 6178: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 6179: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6180: </dl>
6181: </div>
6182: <p>Many packages have the ability to be built to support different
1.76 rillig 6183: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6184: in pkgsrc that provides generic handling of those options that
6185: determine different ways in which the packages can be built. It's
6186: possible for the user to specify exactly which sets of options will be
6187: built into a package or to allow a set of global default options
6188: apply.</p>
1.107 rillig 6189: <p>There are two broad classes of behaviors that one might want to
6190: control via options. One is whether some particular feature is
6191: enabled in a program that will be built anyway, often by including or
6192: not including a dependency on some other package. The other is
6193: whether or not an additional program will be built as part of the
6194: package. Generally, it is better to make a split package for such
6195: additional programs instead of using options, because it enables
6196: binary packages to be built which can then be added separately. For
6197: example, the foo package might have minimal dependencies (those
6198: packages without which foo doesn't make sense), and then the foo-gfoo
6199: package might include the GTK frontend program gfoo. This is better
6200: than including a gtk option to foo that adds gfoo, because either that
6201: option is default, in which case binary users can't get foo without
6202: gfoo, or not default, in which case they can't get gfoo. With split
6203: packages, they can install foo without having GTK, and later decide to
6204: install gfoo (pulling in GTK at that time). This is an advantage to
6205: source users too, avoiding the need for rebuilds.</p>
6206: <p>Plugins with widely varying dependencies should usually be split
6207: instead of options.</p>
6208: <p>It is often more work to maintain split packages, especially if
6209: the upstream package does not support this. The decision of split
6210: vs. option should be made based on the likelihood that users will want
6211: or object to the various pieces, the size of the dependencies that are
6212: included, and the amount of work.</p>
6213: <p>A further consideration is licensing. Non-free parts, or parts
6214: that depend on non-free dependencies (especially plugins) should
6215: almost always be split if feasible.</p>
1.128 ! wiz 6216: <div class="sect1" title="16.1. Global default options">
1.75 rillig 6217: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6218: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6219: <p>Global default options are listed in
6220: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6221: that should be built into every package if that option is supported.
1.110 hubertf 6222: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6223: </div>
1.128 ! wiz 6224: <div class="sect1" title="16.2. Converting packages to use bsd.options.mk">
1.75 rillig 6225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6226: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6227: </h2></div></div></div>
1.75 rillig 6228: <p>The following example shows how
1.76 rillig 6229: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6230: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6231: <code class="filename">Makefile</code>, or in a file,
6232: e.g. <code class="filename">options.mk</code>, that is included by the
6233: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6234: <pre class="programlisting">
1.100 rillig 6235: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6236: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6237: PKG_OPTIONS_OPTIONAL_GROUPS= database
6238: PKG_OPTIONS_GROUP.database= mysql pgsql
6239: PKG_SUGGESTED_OPTIONS= wibble-foo
6240: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6241: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6242:
6243: .include "../../mk/bsd.prefs.mk"
6244:
6245: # this package was previously named wibble2
6246: .if defined(PKG_OPTIONS.wibble2)
6247: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6248: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6249: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6250: .endif
6251:
6252: .include "../../mk/bsd.options.mk"
6253:
6254: # Package-specific option-handling
6255:
6256: ###
6257: ### FOO support
6258: ###
6259: .if !empty(PKG_OPTIONS:Mwibble-foo)
6260: CONFIGURE_ARGS+= --enable-foo
6261: .endif
6262:
6263: ###
6264: ### LDAP support
6265: ###
6266: .if !empty(PKG_OPTIONS:Mldap)
6267: . include "../../databases/openldap-client/buildlink3.mk"
6268: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6269: .endif
6270:
6271: ###
6272: ### database support
6273: ###
6274: .if !empty(PKG_OPTIONS:Mmysql)
6275: . include "../../mk/mysql.buildlink3.mk"
6276: .endif
6277: .if !empty(PKG_OPTIONS:Mpgsql)
6278: . include "../../mk/pgsql.buildlink3.mk"
6279: .endif
1.75 rillig 6280: </pre>
6281: <p>The first section contains the information about which build
6282: options are supported by the package, and any default options settings
6283: if needed.</p>
1.128 ! wiz 6284: <div class="orderedlist"><ol class="orderedlist" type="1">
! 6285: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110 hubertf 6286: <a class="citerefentry" 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
1.75 rillig 6287: options. It should be set to
1.78 rillig 6288: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6289: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6290: at the point where the options are processed.</p></li>
1.128 ! wiz 6291: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6292: build options supported by the package.</p></li>
1.128 ! wiz 6293: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6294: list of names of groups of mutually exclusive options. The options in
6295: each group are listed in
6296: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6297: The most specific setting of any option from the group takes
6298: precedence over all other options in the group. Options from the
6299: groups will be automatically added to
6300: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 ! wiz 6301: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6302: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6303: packages will fail if no option from the group is
6304: selected.</p></li>
1.128 ! wiz 6305: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6306: of names of sets of options. At least one option from each set must
6307: be selected. The options in each set are listed in
6308: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6309: Options from the sets will be automatically added to
6310: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6311: fail if no option from the set is selected.</p></li>
1.128 ! wiz 6312: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6313: build options which are enabled by default.</p></li>
1.128 ! wiz 6314: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6315: of
1.128 ! wiz 6316: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.110 hubertf 6317: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6318: their option counterparts. Pairs should be added with
1.128 ! wiz 6319: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6320: warning will be issued if the user uses a legacy
6321: variable.</p></li>
1.128 ! wiz 6322: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6323: of
1.128 ! wiz 6324: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.75 rillig 6325: pairs that map options that have been renamed to their new
1.128 ! wiz 6326: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6327: the listing of global legacy options. A warning will be issued if
6328: the user uses a legacy option.</p></li>
1.128 ! wiz 6329: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6330: options implied by deprecated variables used. This can be used for
6331: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6332: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6333: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 ! wiz 6334: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6335: a list of warnings about deprecated variables or options used, and
6336: what to use instead.</p></li>
6337: </ol></div>
6338: <p>A package should never modify
6339: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6340: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6341: To suggest a default set of options, use
6342: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6343: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6344: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6345: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6346: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6347: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6348: happen with platform-specific options if none of them is supported on
6349: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6350: empty list and the package is otherwise treated as not using the
6351: options framework.</p>
1.76 rillig 6352: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6353: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6354: build options, properly filtered to remove unsupported and duplicate
6355: options.</p>
6356: <p>The remaining sections contain the logic that is specific to
6357: each option. The correct way to check for an option is to check
6358: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6359: <pre class="programlisting">
1.100 rillig 6360: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6361: </pre>
6362: </div>
1.128 ! wiz 6363: <div class="sect1" title="16.3. Option Names">
1.75 rillig 6364: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6365: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6366: <p>Options that enable similar features in different packages (like
6367: optional support for a library) should use a common name in all
6368: packages that support it (like the name of the library). If another
6369: package already has an option with the same meaning, use the same
6370: name.</p>
6371: <p>Options that enable features specific to one package, where it's
6372: unlikely that another (unrelated) package has the same (or a similar)
6373: optional feature, should use a name prefixed with
6374: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6375: <p>If a group of related packages share an optional feature
6376: specific to that group, prefix it with the name of the
1.128 ! wiz 6377: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6378: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6379: <p>For new options, add a line to
1.76 rillig 6380: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6381: fields, separated by tab. The first field is the option name, the
6382: second its description. The description should be a whole sentence
6383: (starting with an uppercase letter and ending with a period) that
1.128 ! wiz 6384: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
! 6385: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6386: </div>
1.128 ! wiz 6387: <div class="sect1" title="16.4. Determining the options of dependencies">
1.107 rillig 6388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6389: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6390: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107 rillig 6391: different dependencies based on the options with which the package was
6392: built. For querying these options, the file
6393: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6394: typical example looks like this:</p>
6395: <pre class="programlisting">
6396: pkgbase := libpurple
6397: .include "../../mk/pkg-build-options.mk"
6398:
6399: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6400: ...
6401: .endif
6402: </pre>
6403: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6404: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6405: options of the libpurple package, which can then be queried like
6406: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6407: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6408: details.</p>
6409: </div>
1.75 rillig 6410: </div>
1.128 ! wiz 6411: <div class="chapter" title="Chapter 17. The build process">
1.75 rillig 6412: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6413: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6414: <div class="toc">
6415: <p><b>Table of Contents</b></p>
6416: <dl>
1.106 rillig 6417: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6418: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6419: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6420: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 ! wiz 6421: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 6422: <dd><dl>
6423: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6424: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6425: </dl></dd>
1.128 ! wiz 6426: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
! 6427: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
! 6428: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
! 6429: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
! 6430: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
! 6431: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
! 6432: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
! 6433: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
! 6434: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
! 6435: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 6436: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6437: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6438: </dl>
6439: </div>
1.128 ! wiz 6440: <div class="sect1" title="17.1. Introduction">
1.75 rillig 6441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6442: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6443: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6444: built. Building a package is separated into different
6445: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6446: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6447: described in the following sections. Each phase is split into
1.87 wiz 6448: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6449: containing phase, prefixed by one of <code class="varname">pre-</code>,
6450: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6451: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6452: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6453: <p>Never override the regular targets (like
6454: <code class="varname">fetch</code>), if you have to, override the
6455: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6456: <p>The basic steps for building a program are always the same. First
1.87 wiz 6457: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6458: the local system and then extracted. After any pkgsrc-specific patches
6459: to compile properly are applied, the software can be configured, then
6460: built (usually by compiling), and finally the generated binaries, etc.
6461: can be put into place on the system.</p>
1.97 rillig 6462: <p>To get more details about what is happening at each step,
6463: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6464: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6465: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6466: </div>
1.128 ! wiz 6467: <div class="sect1" title="17.2. Program location">
1.75 rillig 6468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6469: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6470: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6471: the next section, here's a brief discussion on where programs are
6472: installed, and which variables influence this.</p>
1.75 rillig 6473: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6474: where all files of the final program shall be installed. It is
6475: usually set to <code class="varname">LOCALBASE</code>
6476: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6477: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6478: <code class="varname">PREFIX</code> needs to be put
6479: into the various places in the program's source where paths to
1.110 hubertf 6480: these files are encoded. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.75 rillig 6481: <p>When choosing which of these variables to use,
1.87 wiz 6482: follow the following rules:</p>
1.128 ! wiz 6483: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 6484: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6485: where the current pkg will be installed. When referring to a
6486: pkg's own installation path, use
1.128 ! wiz 6487: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
! 6488: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6489: are installed. If you need to construct a -I or -L argument
6490: to the compiler to find includes and libraries installed by
1.128 ! wiz 6491: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6492: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6493: installed all packages in <code class="filename">/usr/local</code>. As
6494: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6495: administrator, this variable is a misnomer.</p></li>
1.128 ! wiz 6496: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6497: distribution (from xsrc, etc.) is installed. When looking for
6498: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 ! wiz 6499: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
! 6500: <li class="listitem">
1.88 wiz 6501: <p>X11-based packages are special in that they may be
6502: installed in either <code class="varname">X11BASE</code> or
6503: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6504: <p>Usually, X11 packages should be installed under
1.88 wiz 6505: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6506: will need to include
6507: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6508: request the presence of X11 and to get the right compilation
6509: flags.</p>
1.75 rillig 6510: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6511: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6512: files. These packages are special and they must be placed under
6513: <code class="varname">X11BASE</code>. To accomplish this, set either
6514: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6515: your package.</p>
1.75 rillig 6516: <p>Some notes: If you need
1.87 wiz 6517: to find includes or libraries installed by a pkg that has
6518: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6519: its pkg <code class="filename">Makefile</code>, you need to look in
6520: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6521: <code class="filename">${LOCALBASE}</code>. To force installation of
6522: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6523: <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 6524: is enabled by default.</p>
1.75 rillig 6525: </li>
1.128 ! wiz 6526: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6527: the installed location of an X11
6528: package. <code class="varname">X11PREFIX</code> will be set to
6529: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6530: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6531: installed.</p></li>
1.128 ! wiz 6532: <li class="listitem">
1.88 wiz 6533: <p>If xpkgwedge is installed, it is possible to have some
6534: packages installed in <code class="varname">X11BASE</code> and some in
6535: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6536: installed package, the <code class="varname">EVAL_PREFIX</code>
6537: definition can be used. It takes pairs in the format
1.128 ! wiz 6538: <span class="quote">“<span class="quote">DIRNAME=<package></span>”</span>, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 6539: variable <code class="varname">DIRNAME</code> will be set to the prefix
6540: of the installed package <package>, or
1.128 ! wiz 6541: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6542: installed.</p>
1.75 rillig 6543: <p>This is best illustrated by example.</p>
6544: <p>The following lines are taken from
1.87 wiz 6545: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6546: <pre class="programlisting">
1.100 rillig 6547: EVAL_PREFIX+= GTKDIR=gtk+
6548: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6549: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6550: CONFIGURE_ARGS+= --enable-multibyte
6551: </pre>
1.88 wiz 6552: <p>Specific defaults can be defined for the packages
6553: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6554: definition of the form:</p>
1.75 rillig 6555: <pre class="programlisting">
1.100 rillig 6556: GTKDIR_DEFAULT= ${LOCALBASE}
6557: </pre>
1.75 rillig 6558: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6559: to the first definition in
6560: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6561: </li>
1.128 ! wiz 6562: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110 hubertf 6563: install files according to <a class="citerefentry" 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
1.87 wiz 6564: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6565: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6566: </ul></div>
6567: </div>
1.128 ! wiz 6568: <div class="sect1" title="17.3. Directories used during the build process">
1.75 rillig 6569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6570: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6571: <p>When building a package, various directories are used to store
1.87 wiz 6572: source files, temporary files, pkgsrc-internal files, and so on. These
6573: directories are explained here.</p>
1.75 rillig 6574: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6575: are two common base directories for these relative directories:
6576: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6577: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6578: inside the package itself.</p>
1.75 rillig 6579: <div class="variablelist"><dl>
6580: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6581: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6582: root directory. Generally, you don't need
6583: it.</p></dd>
1.97 rillig 6584: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6585: <dd><p>This is an absolute pathname that points to the
6586: current package.</p></dd>
1.75 rillig 6587: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6588: <dd><p>This is a pathname relative to
1.87 wiz 6589: <code class="varname">PKGSRCDIR</code> that points to the current
6590: package.</p></dd>
1.75 rillig 6591: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6592: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6593: where all work takes place. The distfiles are extracted to this
1.87 wiz 6594: directory. It also contains temporary directories and log files used by
6595: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6596: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6597: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6598: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6599: where the distfiles are extracted. It is usually a direct subdirectory
6600: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6601: that isn't hidden. This variable may be changed by a package
6602: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6603: </dl></div>
1.114 jmcneill 6604: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6605: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6606: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6607: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6608: If users would like to have their pkgsrc trees behave in a
6609: read-only manner, then the value of
6610: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6611: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6612: </div>
1.128 ! wiz 6613: <div class="sect1" title="17.4. Running a phase">
1.75 rillig 6614: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6615: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6616: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6617: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6618: phase. This will automatically run all phases that are required for this
6619: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6620: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6621: the package will be built, but not installed.</p>
1.75 rillig 6622: </div>
1.128 ! wiz 6623: <div class="sect1" title="17.5. The fetch phase">
1.75 rillig 6624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6625: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6626: <p>The first step in building a package is to fetch the
1.88 wiz 6627: distribution files (distfiles) from the sites that are providing
6628: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6629: phase.</p>
1.128 ! wiz 6630: <div class="sect2" title="17.5.1. What to fetch and where to get it from">
1.81 rillig 6631: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6632: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88 wiz 6633: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6634: defines all URLs from where the distfile, whose name is
6635: derived from the <code class="varname">DISTNAME</code> variable, is
6636: fetched. The more complicated cases are described
6637: below.</p>
6638: <p>The variable <code class="varname">DISTFILES</code> specifies
6639: the list of distfiles that have to be fetched. Its value
6640: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6641: so that most packages don't need to define it at all.
6642: <code class="varname">EXTRACT_SUFX</code> is
6643: <code class="literal">.tar.gz</code> by default, but can be changed
6644: freely. Note that if your package requires additional
6645: distfiles to the default one, you cannot just append the
6646: additional filenames using the <code class="literal">+=</code>
6647: operator, but you have write for example:</p>
1.81 rillig 6648: <pre class="programlisting">
1.100 rillig 6649: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6650: </pre>
1.88 wiz 6651: <p>Each distfile is fetched from a list of sites, usually
6652: <code class="varname">MASTER_SITES</code>. If the package has multiple
6653: <code class="varname">DISTFILES</code> or multiple
6654: <code class="varname">PATCHFILES</code> from different sites, you can
6655: set
6656: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6657: to the list of URLs where the file
6658: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6659: (including the suffix) can be found.</p>
6660: <pre class="programlisting">
1.100 rillig 6661: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6662: DISTFILES+= foo-file.tar.gz
6663: SITES.foo-file.tar.gz= \
6664: http://www.somewhere.com/somehow/ \
6665: http://www.somewhereelse.com/mirror/somehow/
6666: </pre>
1.81 rillig 6667: <p>When actually fetching the distfiles, each item from
1.88 wiz 6668: <code class="varname">MASTER_SITES</code> or
6669: <code class="varname">SITES.*</code> gets the name of each distfile
6670: appended to it, without an intermediate slash. Therefore,
6671: all site values have to end with a slash or other separator
6672: character. This allows for example to set
6673: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6674: that gets the name of the distfile as a parameter. In this
6675: case, the definition would look like:</p>
1.81 rillig 6676: <pre class="programlisting">
1.100 rillig 6677: MASTER_SITES= http://www.example.com/download.cgi?file=
6678: </pre>
1.125 wiz 6679: <p> The exception to this rule are URLs starting with a dash.
6680: In that case the URL is taken as is, fetched and the result stored
6681: under the name of the distfile.</p>
1.81 rillig 6682: <p>There are some predefined values for
1.88 wiz 6683: <code class="varname">MASTER_SITES</code>, which can be used in
6684: packages. The names of the variables should speak for
6685: themselves.</p>
6686: <pre class="programlisting">
1.100 rillig 6687: ${MASTER_SITE_APACHE}
6688: ${MASTER_SITE_BACKUP}
6689: ${MASTER_SITE_CYGWIN}
6690: ${MASTER_SITE_DEBIAN}
6691: ${MASTER_SITE_FREEBSD}
6692: ${MASTER_SITE_FREEBSD_LOCAL}
6693: ${MASTER_SITE_GENTOO}
6694: ${MASTER_SITE_GNOME}
6695: ${MASTER_SITE_GNU}
6696: ${MASTER_SITE_GNUSTEP}
6697: ${MASTER_SITE_IFARCHIVE}
6698: ${MASTER_SITE_KDE}
6699: ${MASTER_SITE_MOZILLA}
6700: ${MASTER_SITE_MYSQL}
6701: ${MASTER_SITE_OPENOFFICE}
6702: ${MASTER_SITE_PERL_CPAN}
6703: ${MASTER_SITE_PGSQL}
6704: ${MASTER_SITE_R_CRAN}
6705: ${MASTER_SITE_SOURCEFORGE}
6706: ${MASTER_SITE_SOURCEFORGE_JP}
6707: ${MASTER_SITE_SUNSITE}
6708: ${MASTER_SITE_SUSE}
6709: ${MASTER_SITE_TEX_CTAN}
6710: ${MASTER_SITE_XCONTRIB}
6711: ${MASTER_SITE_XEMACS}
6712: </pre>
1.88 wiz 6713: <p>Some explanations for the less self-explaining ones:
6714: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110 hubertf 6715: for packages that are maintained in <a class="ulink" 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
6716: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/</a>.</p>
1.88 wiz 6717: <p>If you choose one of these predefined sites, you may
6718: want to specify a subdirectory of that site. Since these
6719: macros may expand to more than one actual site, you
6720: <span class="emphasis"><em>must</em></span> use the following construct to
6721: specify a subdirectory:</p>
1.81 rillig 6722: <pre class="programlisting">
1.100 rillig 6723: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6724: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6725: </pre>
1.81 rillig 6726: <p>Note the trailing slash after the subdirectory
1.88 wiz 6727: name.</p>
1.81 rillig 6728: </div>
1.128 ! wiz 6729: <div class="sect2" title="17.5.2. How are the files fetched?">
1.81 rillig 6730: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6731: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6732: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6733: all the distfiles exist in a local directory
1.93 rillig 6734: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6735: user). If the files do not exist, they are fetched using
6736: commands of the form</p>
1.75 rillig 6737: <pre class="programlisting">
1.100 rillig 6738: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6739: </pre>
1.88 wiz 6740: <p>where <code class="literal">${site}</code> varies through
6741: several possibilities in turn: first,
6742: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6743: sites specified in either <code class="varname">SITES.file</code> if
6744: defined, else <code class="varname">MASTER_SITES</code> or
6745: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6746: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6747: all except the first and the last can be optionally sorted
6748: by the user, via setting either
6749: <code class="varname">MASTER_SORT_RANDOM</code>, and
6750: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6751: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6752: <p> The specific command and arguments used depend on the
6753: <code class="varname">FETCH_USING</code> parameter. The example above is
6754: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6755: <p>The distfiles mirror run by the NetBSD Foundation uses the
6756: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6757: distfiles, if they are freely distributable. Packages setting
6758: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 ! wiz 6759: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6760: mirrored.</p>
1.81 rillig 6761: </div>
1.75 rillig 6762: </div>
1.128 ! wiz 6763: <div class="sect1" title="17.6. The checksum phase">
1.75 rillig 6764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6765: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6766: <p>After the distfile(s) are fetched, their checksum is
6767: generated and compared with the checksums stored in the
6768: distinfo file. If the checksums don't match, the build is
6769: aborted. This is to ensure the same distfile is used for
6770: building, and that the distfile wasn't changed, e.g. by some
6771: malign force, deliberately changed distfiles on the master
6772: distribution site or network lossage.</p>
1.75 rillig 6773: </div>
1.128 ! wiz 6774: <div class="sect1" title="17.7. The extract phase">
1.75 rillig 6775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6776: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6777: <p>When the distfiles are present on the local system, they
1.88 wiz 6778: need to be extracted, as they usually come in the form of some
6779: compressed archive format.</p>
1.75 rillig 6780: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6781: extracted. If you only need some of them, you can set the
6782: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6783: files.</p>
6784: <p>Extracting the files is usually done by a little
1.93 rillig 6785: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6786: already knows how to extract various archive formats, so most
6787: likely you will not need to change anything here. But if you
6788: need, the following variables may help you:</p>
1.75 rillig 6789: <div class="variablelist"><dl>
6790: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6791: <dd><p>Use these variables to override the default
1.88 wiz 6792: options for an extract command, which are defined in
1.93 rillig 6793: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6794: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6795: <dd><p>This variable can be set to
1.114 jmcneill 6796: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6797: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6798: absolute pathname pointing to the command with which tar
1.114 jmcneill 6799: archives should be extracted. It is preferred to choose bsdtar over gtar
6800: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6801: </dl></div>
1.88 wiz 6802: <p>If the <code class="filename">extract</code> program doesn't
6803: serve your needs, you can also override the
6804: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6805: command used for extracting the files. This command is
6806: executed in the <code class="filename">${WRKSRC}</code>
6807: directory. During execution of this command, the shell
6808: variable <code class="varname">extract_file</code> holds the absolute
6809: pathname of the file that is going to be extracted.</p>
1.75 rillig 6810: <p>And if that still does not suffice, you can override the
1.88 wiz 6811: <code class="varname">do-extract</code> target in the package
6812: Makefile.</p>
1.75 rillig 6813: </div>
1.128 ! wiz 6814: <div class="sect1" title="17.8. The patch phase">
1.75 rillig 6815: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6816: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6817: <p>After extraction, all the patches named by the
1.88 wiz 6818: <code class="varname">PATCHFILES</code>, those present in the patches
6819: subdirectory of the package as well as in
6820: $LOCALPATCHES/$PKGPATH (e.g.
6821: <code class="filename">/usr/local/patches/graphics/png</code>) are
6822: applied. Patchfiles ending in <code class="filename">.Z</code> or
6823: <code class="filename">.gz</code> are uncompressed before they are
6824: applied, files ending in <code class="filename">.orig</code> or
6825: <code class="filename">.rej</code> are ignored. Any special options to
1.110 hubertf 6826: <a class="citerefentry" 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
6827: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more details.</p>
6828: <p>By default <a class="citerefentry" 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
1.88 wiz 6829: it fail if the patches apply with some lines of fuzz. Please
6830: fix (regen) the patches so that they apply cleanly. The
6831: rationale behind this is that patches that don't apply cleanly
6832: may end up being applied in the wrong place, and cause severe
6833: harm there.</p>
1.75 rillig 6834: </div>
1.128 ! wiz 6835: <div class="sect1" title="17.9. The tools phase">
1.75 rillig 6836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6837: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6838: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.88 wiz 6839: </p>
1.75 rillig 6840: </div>
1.128 ! wiz 6841: <div class="sect1" title="17.10. The wrapper phase">
1.75 rillig 6842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6843: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6844: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6845: linkers. The following variables can be used to tweak the
6846: wrappers.</p>
1.75 rillig 6847: <div class="variablelist"><dl>
6848: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6849: <dd><p>The command used to print progress
1.88 wiz 6850: messages. Does nothing by default. Set to
6851: <code class="literal">${ECHO}</code> to see the progress
6852: messages.</p></dd>
1.75 rillig 6853: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6854: <dd><p>This variable can be set to
1.88 wiz 6855: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6856: depending on whether you want additional information in the
6857: wrapper log file.</p></dd>
1.75 rillig 6858: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6859: <dd><p>This variable can be set to
1.88 wiz 6860: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6861: on whether the wrapper should use its cache, which will
6862: improve the speed. The default value is
6863: <code class="literal">yes</code>, but is forced to
6864: <code class="literal">no</code> if the platform does not support
6865: it.</p></dd>
1.75 rillig 6866: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6867: <dd><p>A list of reordering commands. A reordering
6868: command has the form
6869: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6870: It ensures that that
6871: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6872: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6873: </p></dd>
1.75 rillig 6874: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6875: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6876: investigate further]</p></dd>
1.75 rillig 6877: </dl></div>
6878: </div>
1.128 ! wiz 6879: <div class="sect1" title="17.11. The configure phase">
1.75 rillig 6880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6881: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6882: <p>Most pieces of software need information on the header
6883: files, system calls, and library routines which are available
6884: on the platform they run on. The process of determining this
6885: information is known as configuration, and is usually
6886: automated. In most cases, a script is supplied with the
6887: distfiles, and its invocation results in generation of header
6888: files, Makefiles, etc.</p>
6889: <p>If the package contains a configure script, this can be
6890: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 ! wiz 6891: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6892: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 ! wiz 6893: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6894: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6895: <pre class="programlisting">
1.100 rillig 6896: .for d in ${CONFIGURE_DIRS}
6897: cd ${WRKSRC} \
6898: && cd ${d} \
6899: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6900: .endfor
6901: </pre>
1.88 wiz 6902: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 ! wiz 6903: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6904: <code class="varname">WRKSRC</code>. In each of these directories, the
6905: configure script is run with the environment
6906: <code class="varname">CONFIGURE_ENV</code> and arguments
6907: <code class="varname">CONFIGURE_ARGS</code>. The variables
6908: <code class="varname">CONFIGURE_ENV</code>,
6909: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 ! wiz 6910: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6911: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6912: package.</p>
6913: <p>If the program uses an <code class="filename">Imakefile</code>
6914: for configuration, the appropriate steps can be invoked by
6915: setting <code class="varname">USE_IMAKE</code> to
1.128 ! wiz 6916: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 6917: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6918: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6919: xmkmf's environment by adding them to the
6920: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6921: <p>If the program uses <code class="filename">cmake</code>
6922: for configuration, the appropriate steps can be invoked by
1.128 ! wiz 6923: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6924: You can add variables to cmake's environment by adding them to the
6925: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6926: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6927: The top directory argument is given by the
6928: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 ! wiz 6929: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6930: <p>If there is no configure step at all, set
1.128 ! wiz 6931: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6932: </div>
1.128 ! wiz 6933: <div class="sect1" title="17.12. The build phase">
1.75 rillig 6934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6935: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6936: <p>For building a package, a rough equivalent of the
6937: following code is executed.</p>
1.75 rillig 6938: <pre class="programlisting">
1.100 rillig 6939: .for d in ${BUILD_DIRS}
6940: cd ${WRKSRC} \
6941: && cd ${d} \
6942: && env ${MAKE_ENV} \
6943: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6944: -f ${MAKE_FILE} \
6945: ${BUILD_TARGET}
6946: .endfor
6947: </pre>
1.88 wiz 6948: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 ! wiz 6949: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6950: <code class="varname">WRKSRC</code>. In each of these directories,
6951: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6952: <code class="varname">MAKE_ENV</code> and arguments
6953: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6954: <code class="varname">MAKE_ENV</code>,
6955: <code class="varname">BUILD_MAKE_FLAGS</code>,
6956: <code class="varname">MAKE_FILE</code> and
6957: <code class="varname">BUILD_TARGET</code> may all be changed by the
6958: package.</p>
1.75 rillig 6959: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 ! wiz 6960: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
! 6961: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6962: default value of <code class="varname">MAKE_FILE</code> is
1.128 ! wiz 6963: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
! 6964: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6965: <p>If there is no build step at all, set
1.128 ! wiz 6966: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6967: </div>
1.128 ! wiz 6968: <div class="sect1" title="17.13. The test phase">
1.75 rillig 6969: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6970: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6971: <p>[TODO]</p>
6972: </div>
1.128 ! wiz 6973: <div class="sect1" title="17.14. The install phase">
1.75 rillig 6974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6975: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6976: <p>Once the build stage has completed, the final step is to
1.88 wiz 6977: install the software in public directories, so users can
6978: access the programs and files.</p>
1.75 rillig 6979: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6980: equivalent of the following code is executed. Additionally,
6981: before and after this code, much magic is performed to do
6982: consistency checks, registering the package, and so on.</p>
6983: <pre class="programlisting">
1.100 rillig 6984: .for d in ${INSTALL_DIRS}
6985: cd ${WRKSRC} \
6986: && cd ${d} \
6987: && env ${MAKE_ENV} \
6988: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6989: -f ${MAKE_FILE} \
6990: ${INSTALL_TARGET}
6991: .endfor
6992: </pre>
1.75 rillig 6993: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6994: <span class="emphasis"><em>build</em></span> phase.
6995: <code class="varname">INSTALL_DIRS</code> defaults to
6996: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 ! wiz 6997: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
! 6998: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6999: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7000: defined.</p>
1.75 rillig 7001: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 7002: variables are useful. They are all variations of the
1.110 hubertf 7003: <a class="citerefentry" 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
1.88 wiz 7004: permissions preset. <code class="varname">INSTALL</code> is the plain
7005: install command. The specialized variants, together with their
7006: intended use, are:</p>
1.75 rillig 7007: <div class="variablelist"><dl>
7008: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 7009: <dd><p>directories that contain
7010: binaries</p></dd>
1.75 rillig 7011: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 7012: <dd><p>directories that contain
7013: scripts</p></dd>
1.75 rillig 7014: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 7015: <dd><p>directories that contain shared and static
7016: libraries</p></dd>
1.75 rillig 7017: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 7018: <dd><p>directories that contain data
7019: files</p></dd>
1.75 rillig 7020: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 7021: <dd><p>directories that contain man
7022: pages</p></dd>
1.75 rillig 7023: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 7024: <dd><p>binaries that can be stripped from debugging
7025: symbols</p></dd>
1.75 rillig 7026: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 7027: <dd><p>binaries that cannot be
7028: stripped</p></dd>
1.75 rillig 7029: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 7030: <dd><p>game
7031: binaries</p></dd>
1.75 rillig 7032: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 7033: <dd><p>shared and static
7034: libraries</p></dd>
1.75 rillig 7035: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7036: <dd><p>data files</p></dd>
7037: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 7038: <dd><p>data files for
7039: games</p></dd>
1.75 rillig 7040: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7041: <dd><p>man pages</p></dd>
7042: </dl></div>
7043: <p>Some other variables are:</p>
7044: <div class="variablelist"><dl>
7045: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7046: <dd><p>A list of directories relative to
1.88 wiz 7047: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 7048: beginning of the <span class="emphasis"><em>install</em></span> phase.
7049: The package is supposed to create all needed directories itself
7050: before installing files to it and list all other directories here.
7051: </p></dd>
1.75 rillig 7052: </dl></div>
1.97 rillig 7053: <p>In the rare cases that a package shouldn't install anything,
1.128 ! wiz 7054: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 7055: mostly relevant for packages in the <code class="filename">regress</code>
7056: category.</p>
1.75 rillig 7057: </div>
1.128 ! wiz 7058: <div class="sect1" title="17.15. The package phase">
1.75 rillig 7059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7060: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7061: <p>Once the install stage has completed, a binary package of
7062: the installed files can be built. These binary packages can be
7063: used for quick installation without previous compilation, e.g. by
1.110 hubertf 7064: the <span class="command"><strong>make bin-install</strong></span> or by using
7065: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 7066: <p>By default, the binary packages are created in
7067: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7068: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7069: one for each category in the <code class="varname">CATEGORIES</code>
7070: variable. <code class="varname">PACKAGES</code> defaults to
7071: <code class="filename">pkgsrc/packages</code>.</p>
7072: </div>
1.128 ! wiz 7073: <div class="sect1" title="17.16. Cleaning up">
1.88 wiz 7074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7075: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 7076: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 7077: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 7078: to clean the work directories of all dependencies too, use
1.110 hubertf 7079: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 7080: </div>
1.128 ! wiz 7081: <div class="sect1" title="17.17. Other helpful targets">
1.75 rillig 7082: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7083: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75 rillig 7084: <div class="variablelist"><dl>
7085: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7086: <dd><p>For any of the main targets described in the
7087: previous section, two auxiliary targets exist with
1.128 ! wiz 7088: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.87 wiz 7089: prefix for the main target's name. These targets are
1.88 wiz 7090: invoked before and after the main target is called,
7091: allowing extra configuration or installation steps be
7092: performed from a package's Makefile, for example, which
7093: a program's configure script or install target
7094: omitted.</p></dd>
1.75 rillig 7095: <dt><span class="term">do-*</span></dt>
1.88 wiz 7096: <dd><p>Should one of the main targets do the wrong thing,
7097: and should there be no variable to fix this, you can
7098: redefine it with the do-* target. (Note that redefining
7099: the target itself instead of the do-* target is a bad
7100: idea, as the pre-* and post-* targets won't be called
7101: anymore, etc.) You will not usually need to do
7102: this.</p></dd>
1.75 rillig 7103: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7104: <dd>
1.110 hubertf 7105: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 7106: you noticed some file was not installed properly, you
7107: can repeat the installation with this target, which will
1.128 ! wiz 7108: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 7109: <p>This is the default value of
7110: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 7111: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 7112: package</strong></span>, where the defaults are
1.128 ! wiz 7113: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 7114: respectively.</p>
7115: </dd>
1.75 rillig 7116: <dt><span class="term">deinstall</span></dt>
7117: <dd>
1.110 hubertf 7118: <p>This target does a <a class="citerefentry" 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
1.88 wiz 7119: current directory, effectively de-installing the
7120: package. The following variables can be used to tune the
7121: behaviour:</p>
1.75 rillig 7122: <div class="variablelist"><dl>
7123: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110 hubertf 7124: <dd><p>Add a "-v" to the <a class="citerefentry" 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>
1.75 rillig 7125: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7126: <dd><p>Remove all packages that require (depend on)
7127: the given package. This can be used to remove any
7128: packages that may have been pulled in by a given
1.110 hubertf 7129: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 7130: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7131: <code class="filename">pkgsrc/x11/kde</code>, this is
7132: likely to remove whole KDE. Works by adding
1.128 ! wiz 7133: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" 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>
1.88 wiz 7134: command line.</p></dd>
1.75 rillig 7135: </dl></div>
7136: </dd>
1.88 wiz 7137: <dt><span class="term">bin-install</span></dt>
7138: <dd><p>Install a binary package from local disk and via FTP
7139: from a list of sites (see the
7140: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 7141: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 7142: available anywhere. The arguments given to
1.110 hubertf 7143: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 7144: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7145: operation, etc.</p></dd>
1.75 rillig 7146: <dt><span class="term">update</span></dt>
7147: <dd>
1.88 wiz 7148: <p>This target causes the current package to be
7149: updated to the latest version. The package and all
7150: depending packages first get de-installed, then current
7151: versions of the corresponding packages get compiled and
7152: installed. This is similar to manually noting which
7153: packages are currently installed, then performing a
1.110 hubertf 7154: series of <span class="command"><strong>make deinstall</strong></span> and
7155: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7156: <code class="varname">UPDATE_TARGET</code> is set to) for these
7157: packages.</p>
1.128 ! wiz 7158: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 7159: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7160: update</strong></span> was interrupted for some reason.
7161: However, in this case, make sure you don't call
1.110 hubertf 7162: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7163: list of dependent packages in <code class="varname">WRKDIR</code>.
7164: Otherwise, you lose the ability to automatically update
7165: the current package along with the dependent packages
7166: you have installed.</p>
1.110 hubertf 7167: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7168: update</strong></span> will only work as long as the package
7169: tree remains unchanged. If the source code for one of
7170: the packages to be updated has been changed, resuming
1.110 hubertf 7171: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7172: fail!</p>
7173: <p>The following variables can be used either on the
1.110 hubertf 7174: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7175: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7176: update</strong></span>:</p>
1.75 rillig 7177: <div class="variablelist"><dl>
7178: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7179: <dd><p>Install target to recursively use for the
7180: updated package and the dependent packages.
7181: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 ! wiz 7182: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7183: <span class="command"><strong>make update</strong></span>. Other good
1.128 ! wiz 7184: targets are <span class="quote">“<span class="quote">package</span>”</span> or
! 7185: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
! 7186: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7187: endless loop!</p></dd>
1.75 rillig 7188: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7189: <dd><p>Don't clean up after updating. Useful if
7190: you want to leave the work sources of the updated
7191: packages around for inspection or other purposes.
7192: Be sure you eventually clean up the source tree
1.128 ! wiz 7193: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7194: or you may run into troubles with old source code
7195: still lying around on your next
1.110 hubertf 7196: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7197: update</strong></span>.</p></dd>
1.75 rillig 7198: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7199: <dd><p>Deinstall each package before installing
7200: (making <code class="varname">DEPENDS_TARGET</code>). This
7201: may be necessary if the
1.128 ! wiz 7202: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7203: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7204: update</strong></span>.</p></dd>
1.75 rillig 7205: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7206: <dd><p>Allows you to disable recursion and hardcode
7207: the target for packages. The default is
1.128 ! wiz 7208: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7209: facilitating a recursive update of prerequisite
7210: packages. Only set
7211: <code class="varname">DEPENDS_TARGET</code> if you want to
7212: disable recursive updates. Use
7213: <code class="varname">UPDATE_TARGET</code> instead to just
7214: set a specific target for each package to be
1.110 hubertf 7215: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7216: (see above).</p></dd>
1.75 rillig 7217: </dl></div>
7218: </dd>
7219: <dt><span class="term">clean-update</span></dt>
7220: <dd>
1.88 wiz 7221: <p>Clean the source tree for all packages that would
1.110 hubertf 7222: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7223: from the current directory. This target should not be
7224: used if the current package (or any of its depending
7225: packages) have already been de-installed (e.g., after
1.110 hubertf 7226: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7227: some packages you intended to update. As a rule of
7228: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7229: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7230: and only if you have a dirty package tree (e.g., if you
7231: used <code class="varname">NOCLEAN</code>).</p>
7232: <p>If you are unsure about whether your tree is
1.110 hubertf 7233: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7234: clean</strong></span> at the top of the tree, or use the
7235: following sequence of commands from the directory of the
7236: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7237: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7238: time, otherwise you lose all the packages you wanted to
7239: update!):</p>
1.87 wiz 7240: <pre class="screen">
7241: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7242: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7243: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7244: </pre>
1.88 wiz 7245: <p>The following variables can be used either on the
1.110 hubertf 7246: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7247: <span class="command"><strong>make clean-update</strong></span>:</p>
1.75 rillig 7248: <div class="variablelist"><dl>
7249: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7250: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7251: reconstruct the list of directories to update for
1.110 hubertf 7252: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7253: update</strong></span> successfully installed all
7254: packages you wanted to update. Normally, this is
1.110 hubertf 7255: done automatically on <span class="command"><strong>make
1.88 wiz 7256: update</strong></span>, but may have been suppressed by
7257: the <code class="varname">NOCLEAN</code> variable (see
7258: above).</p></dd>
1.75 rillig 7259: </dl></div>
7260: </dd>
1.88 wiz 7261: <dt><span class="term">replace</span></dt>
7262: <dd>
7263: <p>Update the installation of the current package. This
7264: differs from update in that it does not replace dependent
1.93 rillig 7265: packages. You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88 wiz 7266: target to work.</p>
7267: <p><span class="emphasis"><em>Be careful when using this
7268: target!</em></span> There are no guarantees that dependent
7269: packages will still work, in particular they will most
1.110 hubertf 7270: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7271: library package whose shared library major version changed
7272: between your installed version and the new one. For this
7273: reason, this target is not officially supported and only
7274: recommended for advanced users.</p>
7275: </dd>
1.75 rillig 7276: <dt><span class="term">info</span></dt>
1.110 hubertf 7277: <dd><p>This target invokes <a class="citerefentry" 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 7278: package. You can use this to check which version of a
7279: package is installed.</p></dd>
7280: <dt><span class="term">index</span></dt>
7281: <dd>
7282: <p>This is a top-level command, i.e. it should be used in
7283: the <code class="filename">pkgsrc</code> directory. It creates a
7284: database of all packages in the local pkgsrc tree, including
7285: dependencies, comment, maintainer, and some other useful
7286: information. Individual entries are created by running
1.110 hubertf 7287: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7288: directories. This index file is saved as
7289: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7290: verbose format by running <span class="command"><strong>make
1.88 wiz 7291: print-index</strong></span>. You can search in it with
1.110 hubertf 7292: <span class="command"><strong>make search
1.88 wiz 7293: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7294: extract a list of all packages that depend on a particular
1.110 hubertf 7295: one by running <span class="command"><strong>make show-deps
1.88 wiz 7296: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7297: <p>Running this command takes a very long time, some
7298: hours even on fast machines!</p>
7299: </dd>
1.75 rillig 7300: <dt><span class="term">readme</span></dt>
1.88 wiz 7301: <dd>
7302: <p>This target generates a
7303: <code class="filename">README.html</code> file, which can be
1.91 rillig 7304: 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 7305: contain references to any packages which are in the
7306: <code class="varname">PACKAGES</code> directory on the local
7307: host. The generated files can be made to refer to URLs
7308: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7309: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7310: wanted to generate <code class="filename">README.html</code>
7311: files which pointed to binary packages on the local
7312: machine, in the directory
7313: <code class="filename">/usr/packages</code>, set
7314: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7315: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7316: <code class="varname">${PACKAGES}</code> directory and its
7317: subdirectories will be searched for all the binary
7318: packages.</p>
7319: <p>The target can be run at the toplevel or in category
7320: directories, in which case it descends recursively.</p>
7321: </dd>
1.75 rillig 7322: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7323: <dd><p>This is a top-level command, run it in
7324: <code class="filename">pkgsrc</code>. Use this target to create a
7325: file <code class="filename">README-all.html</code> which contains a
7326: list of all packages currently available in the NetBSD
7327: Packages Collection, together with the category they belong
7328: to and a short description. This file is compiled from the
7329: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7330: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7331: readme</strong></span>.</p></dd>
1.75 rillig 7332: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7333: <dd><p>This is very much the same as the
1.128 ! wiz 7334: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7335: used when generating a pkgsrc tree to be written to a
7336: CD-ROM. This target also produces
7337: <code class="filename">README.html</code> files, and can be made
7338: to refer to URLs based on
7339: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7340: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7341: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7342: <dd><p>This target shows which distfiles and patchfiles
7343: are needed to build the package
7344: (<code class="varname">ALLFILES</code>, which contains all
7345: <code class="varname">DISTFILES</code> and
1.87 wiz 7346: <code class="varname">PATCHFILES</code>, but not
7347: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7348: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7349: <dd><p>This target shows nothing if the package is not
7350: installed. If a version of this package is installed,
7351: but is not the version provided in this version of
7352: pkgsrc, then a warning message is displayed. This target
7353: can be used to show which of your installed packages are
7354: downlevel, and so the old versions can be deleted, and
7355: the current ones added.</p></dd>
1.75 rillig 7356: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7357: <dd><p>This target shows the directory in the pkgsrc
7358: hierarchy from which the package can be built and
7359: installed. This may not be the same directory as the one
7360: from which the package was installed. This target is
7361: intended to be used by people who may wish to upgrade
7362: many packages on a single host, and can be invoked from
7363: the top-level pkgsrc Makefile by using the
1.128 ! wiz 7364: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7365: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7366: <dd><p>This target shows which installed packages match
7367: the current package's <code class="varname">DEPENDS</code>. Useful
7368: if out of date dependencies are causing build
7369: problems.</p></dd>
1.75 rillig 7370: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7371: <dd><p>After a package is installed, check all its
7372: binaries and (on ELF platforms) shared libraries to see
7373: if they find the shared libs they need. Run by default
1.110 hubertf 7374: if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75 rillig 7375: <dt><span class="term">print-PLIST</span></dt>
7376: <dd>
1.128 ! wiz 7377: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7378: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7379: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7380: -newer work/.extract_done</strong></span>. An attempt is made
7381: to care for shared libs etc., but it is
1.87 wiz 7382: <span class="emphasis"><em>strongly</em></span> recommended to review the
7383: result before putting it into
7384: <code class="filename">PLIST</code>. On upgrades, it's useful to
7385: diff the output of this command against an already
7386: existing <code class="filename">PLIST</code> file.</p>
1.110 hubertf 7387: <p>If the package installs files via <a class="citerefentry" 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
1.88 wiz 7388: other methods that don't update file access times, be
7389: sure to add these files manually to your
1.128 ! wiz 7390: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
! 7391: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7392: them!</p>
1.128 ! wiz 7393: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.87 wiz 7394: information on this target.</p>
1.75 rillig 7395: </dd>
7396: <dt><span class="term">bulk-package</span></dt>
7397: <dd>
1.88 wiz 7398: <p>Used to do bulk builds. If an appropriate binary
7399: package already exists, no action is taken. If not, this
7400: target will compile, install and package it (and its
7401: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110 hubertf 7402: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.88 wiz 7403: After creating the binary package, the sources, the
7404: just-installed package and its required packages are
7405: removed, preserving free disk space.</p>
7406: <p><span class="emphasis"><em>Beware that this target may deinstall
7407: all packages installed on a system!</em></span></p>
1.75 rillig 7408: </dd>
7409: <dt><span class="term">bulk-install</span></dt>
7410: <dd>
1.88 wiz 7411: <p>Used during bulk-installs to install required
7412: packages. If an up-to-date binary package is available,
1.110 hubertf 7413: it will be installed via <a class="citerefentry" 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,
7414: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7415: but the installed binary won't be removed.</p>
1.88 wiz 7416: <p>A binary package is considered
1.128 ! wiz 7417: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.110 hubertf 7418: <a class="citerefentry" 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>
1.128 ! wiz 7419: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 7420: <li class="listitem"><p>None of the package's files
1.88 wiz 7421: (<code class="filename">Makefile</code>, ...) were modified
7422: since it was built.</p></li>
1.128 ! wiz 7423: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7424: packages were modified since it was built.</p></li>
1.75 rillig 7425: </ul></div>
1.88 wiz 7426: <p><span class="emphasis"><em>Beware that this target may deinstall
7427: all packages installed on a system!</em></span></p>
1.75 rillig 7428: </dd>
7429: </dl></div>
7430: </div>
7431: </div>
1.128 ! wiz 7432: <div class="chapter" title="Chapter 18. Tools needed for building or running">
1.75 rillig 7433: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7434: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7435: <div class="toc">
7436: <p><b>Table of Contents</b></p>
7437: <dl>
1.106 rillig 7438: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7439: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7440: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7441: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7442: </dl>
7443: </div>
1.87 wiz 7444: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7445: by pkgsrc and also for individual packages to define what commands
7446: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7447: or for later run-time of an installed packaged (such as
7448: <code class="varname">DEPENDS</code>).
7449: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7450: package will not be used.</p>
7451: <p>When building a package, the replacement tools are
1.75 rillig 7452: made available in a directory (as symlinks or wrapper scripts)
7453: that is early in the executable search path. Just like the buildlink
1.87 wiz 7454: system, this helps with consistent builds.</p>
7455: <p>A tool may be needed to help build a specific package. For example,
7456: perl, GNU make (gmake) or yacc may be needed.</p>
7457: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7458: tool may be inefficient for building a package with pkgsrc.
7459: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7460: yacc) or a better sed.</p>
7461: <p>The tools used by a package can be listed by running
1.110 hubertf 7462: <span class="command"><strong>make show-tools</strong></span>.</p>
1.128 ! wiz 7463: <div class="sect1" title="18.1. Tools for pkgsrc builds">
1.75 rillig 7464: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7465: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7466: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7467: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7468: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7469: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7470: These can be seen by running:
1.110 hubertf 7471: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7472: <p>If a package needs a specific program to build
1.75 rillig 7473: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7474: to define the tools needed.</p>
1.75 rillig 7475: </div>
1.128 ! wiz 7476: <div class="sect1" title="18.2. Tools needed by packages">
1.75 rillig 7477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7478: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7479: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7480: and not the native version for a build dependency.
7481: And the :run means that it is used for a
7482: run-time dependencies also (and becomes a DEPENDS).
7483: The default is a build dependency which can be set with
7484: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7485: and pkg-config:build.)</p>
1.75 rillig 7486: <pre class="programlisting">
7487: USE_TOOLS+= mktemp:pkgsrc
7488: USE_TOOLS+= gmake perl:run pkg-config
7489: </pre>
1.87 wiz 7490: <p>When using the tools framework, a
1.75 rillig 7491: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7492: which contains the full path to the appropriate tool. For example,
1.128 ! wiz 7493: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7494: on Linux systems.</p>
7495: <p>If you always need a pkgsrc version of the
1.75 rillig 7496: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7497: </p>
7498: </div>
1.128 ! wiz 7499: <div class="sect1" title="18.3. Tools provided by platforms">
1.75 rillig 7500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7501: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7502: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7503: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7504: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7505: the name of the common tools. For example:</p>
7506: <pre class="programlisting">
7507: .if exists(/usr/bin/bzcat)
7508: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7509: .elif exists(/usr/bin/bzip2)
7510: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7511: .endif
1.69 rillig 7512:
1.75 rillig 7513: TOOLS_PLATFORM.true?= true # shell builtin
7514: </pre>
7515: </div>
1.128 ! wiz 7516: <div class="sect1" title="18.4. Questions regarding the tools">
1.97 rillig 7517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7518: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.128 ! wiz 7519: <div class="qandaset" title="Frequently Asked Questions">
! 7520: <a name="id1168230185607"></a><dl>
1.106 rillig 7521: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7522: </dt>
1.106 rillig 7523: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7524: tools?</a>
7525: </dt>
1.106 rillig 7526: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7527: package is using while being built? I want to know whether it
7528: uses sed or not.</a>
7529: </dt>
7530: </dl>
1.128 ! wiz 7531: <table border="0" width="100%" summary="Q and A Set">
1.97 rillig 7532: <col align="left" width="1%">
1.128 ! wiz 7533: <col>
1.97 rillig 7534: <tbody>
1.128 ! wiz 7535: <tr class="question" title="18.4.1.">
1.97 rillig 7536: <td align="left" valign="top">
1.128 ! wiz 7537: <a name="tools.new"></a><a name="id1168230185611"></a><p><b>18.4.1.</b></p>
1.97 rillig 7538: </td>
7539: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7540: </tr>
7541: <tr class="answer">
7542: <td align="left" valign="top"></td>
7543: <td align="left" valign="top"><p>TODO</p></td>
7544: </tr>
1.128 ! wiz 7545: <tr class="question" title="18.4.2.">
1.97 rillig 7546: <td align="left" valign="top">
1.128 ! wiz 7547: <a name="tools.listall"></a><a name="id1168230185620"></a><p><b>18.4.2.</b></p>
1.97 rillig 7548: </td>
7549: <td align="left" valign="top"><p>How do I get a list of all available
7550: tools?</p></td>
7551: </tr>
7552: <tr class="answer">
7553: <td align="left" valign="top"></td>
7554: <td align="left" valign="top"><p>TODO</p></td>
7555: </tr>
1.128 ! wiz 7556: <tr class="question" title="18.4.3.">
1.97 rillig 7557: <td align="left" valign="top">
1.128 ! wiz 7558: <a name="tools.used"></a><a name="id1168230185628"></a><p><b>18.4.3.</b></p>
1.97 rillig 7559: </td>
7560: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7561: package is using while being built? I want to know whether it
7562: uses sed or not.</p></td>
7563: </tr>
7564: <tr class="answer">
7565: <td align="left" valign="top"></td>
7566: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7567: to do it.)</p></td>
7568: </tr>
7569: </tbody>
7570: </table>
7571: </div>
7572: </div>
1.75 rillig 7573: </div>
1.128 ! wiz 7574: <div class="chapter" title="Chapter 19. Making your package work">
1.75 rillig 7575: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7576: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7577: <div class="toc">
7578: <p><b>Table of Contents</b></p>
7579: <dl>
1.106 rillig 7580: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7581: <dd><dl>
1.106 rillig 7582: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 ! wiz 7583: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106 rillig 7584: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7585: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7586: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7587: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7588: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7589: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7590: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7591: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7592: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7593: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7594: </dl></dd>
1.128 ! wiz 7595: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 7596: <dd><dl>
7597: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7598: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
7599: </dl></dd>
1.128 ! wiz 7600: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106 rillig 7601: <dd><dl>
7602: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7603: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7604: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7605: </dl></dd>
7606: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7607: <dd><dl>
7608: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7609: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7610: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7611: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7612: </dl></dd>
1.128 ! wiz 7613: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106 rillig 7614: <dd><dl>
7615: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7616: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 ! wiz 7617: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.106 rillig 7618: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7619: </dl></dd>
1.128 ! wiz 7620: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106 rillig 7621: <dd><dl>
7622: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7623: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7624: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7625: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7626: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7627: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7628: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7629: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7630: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7631: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7632: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7633: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7634: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7635: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7636: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7637: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7638: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7639: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7640: emulation</a></span></dt>
1.106 rillig 7641: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7642: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7643: </dl></dd>
1.106 rillig 7644: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7645: </dl>
7646: </div>
1.128 ! wiz 7647: <div class="sect1" title="19.1. General operation">
1.75 rillig 7648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7649: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.128 ! wiz 7650: <div class="sect2" title="19.1.1. Portability of packages">
1.75 rillig 7651: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7652: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7653: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7654: different platforms. As a result, it is important to ensure,
7655: where possible, that packages in pkgsrc are portable. This
7656: chapter mentions some particular details you should pay
7657: attention to while working on pkgsrc.</p>
1.78 rillig 7658: </div>
1.128 ! wiz 7659: <div class="sect2" title="19.1.2. How to pull in user-settable variables from mk.conf">
1.78 rillig 7660: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7661: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93 rillig 7662: </h3></div></div></div>
1.78 rillig 7663: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7664: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7665: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7666: want to use those variables in the preprocessor directives of
1.110 hubertf 7667: <a class="citerefentry" 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
1.87 wiz 7668: <code class="literal">.for</code>), you need to include the file
7669: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7670: loads the user preferences.</p>
1.78 rillig 7671: <p>But note that some variables may not be completely defined
1.87 wiz 7672: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7673: included, as they may contain references to variables that are
7674: not yet defined. In shell commands this is no problem, since
7675: variables are actually macros, which are only expanded when they
7676: are used. But in the preprocessor directives mentioned above and
7677: in dependency lines (of the form <code class="literal">target:
7678: dependencies</code>) the variables are expanded at load
7679: time.</p>
1.128 ! wiz 7680: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7681: <h3 class="title">Note</h3>
7682: <p>Currently there is no exhaustive list of all
1.87 wiz 7683: variables that tells you whether they can be used at load time
7684: or only at run time, but it is in preparation.</p>
1.78 rillig 7685: </div>
7686: </div>
1.128 ! wiz 7687: <div class="sect2" title="19.1.3. User interaction">
1.78 rillig 7688: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7689: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7690: <p>Occasionally, packages require interaction from the user,
7691: and this can be in a number of ways:</p>
1.128 ! wiz 7692: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 7693: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7694: interaction such as entering username/password or accepting a
7695: license on a web page.</p></li>
1.128 ! wiz 7696: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7697: passwords.</p></li>
1.128 ! wiz 7698: <li class="listitem"><p>help to configure the package before it is built</p></li>
! 7699: <li class="listitem"><p>help during the build process</p></li>
! 7700: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7701: </ul></div>
1.88 wiz 7702: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7703: provided to notify the pkgsrc mechanism of an interactive stage
7704: which will be needed, and this should be set in the package's
7705: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7706: <pre class="programlisting">
1.100 rillig 7707: INTERACTIVE_STAGE= build
1.87 wiz 7708: </pre>
1.78 rillig 7709: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7710: <pre class="programlisting">
1.100 rillig 7711: INTERACTIVE_STAGE= configure install
1.87 wiz 7712: </pre>
1.88 wiz 7713: <p>The user can then decide to skip this package by setting the
7714: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7715: </div>
1.128 ! wiz 7716: <div class="sect2" title="19.1.4. Handling licenses">
1.75 rillig 7717: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7718: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7719: <p>Authors of software can choose the licence under which
7720: software can be copied. This is due to copyright law, and reasons
7721: for license choices are outside the scope of pkgsrc. The pkgsrc
7722: system recognizes that there are a number of licenses which some
7723: users may find objectionable or difficult or impossible to comply
7724: with. The Free Software Foundation has declared some licenses
7725: "Free", and the Open Source Initiative has a definition of "Open
7726: Source". The pkgsrc system, as a policy choice, does not label
7727: packages which have licenses that are Free or Open Source.
7728: However, packages without a license meeting either of those tests
7729: are labeled with a license tag denoting the license. Note that a
7730: package with no license to copy trivially does not meet either the
7731: Free or Open Source test.</p>
7732: <p>For packages which are not Free or Open Source, pkgsrc will
7733: not build the package unless the user has indicated to pkgsrc that
7734: packages with that particular license may be built. Note that
7735: this documentation avoids the term "accepted the license". The
7736: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7737: accidentally building a package with a non-free license;
1.98 wiz 7738: judgement and responsibility remain with the user. (Installation
7739: of binary packages are not currently subject to this mechanism;
7740: this is a bug.)</p>
7741: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7742: or the GPL, and not the other. The free licenses are added to the
7743: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7744: user can override the default by setting the
7745: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7746: of "+=". The licenses accepted by default are:
7747: </p>
7748: <pre class="programlisting">
7749: public-domain
7750: gnu-gpl-v2 gnu-lgpl-v2
7751: gnu-gpl-v3 gnu-lgpl-v3
7752: original-bsd modified-bsd
7753: x11
7754: apache-2.0
7755: cddl-1.0
7756: open-font-license
7757: </pre>
7758: <p>
7759: </p>
1.78 rillig 7760: <p>The license tag mechanism is intended to address
1.87 wiz 7761: copyright-related issues surrounding building, installing and
7762: using a package, and not to address redistribution issues (see
7763: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7764: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7765: Packages with redistribution restrictions should set these
7766: tags.</p>
1.98 wiz 7767: <p>Denoting that a package may be copied according to a
7768: particular license is done by placing the license in
1.87 wiz 7769: <code class="filename">pkgsrc/licenses</code> and setting the
7770: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7771: 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 7772: <pre class="programlisting">
1.100 rillig 7773: LICENSE= xv-license
1.87 wiz 7774: </pre>
7775: <p>When trying to build, the user will get a notice that the
1.98 wiz 7776: package is covered by a license which has not been placed in the
7777: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7778: <pre class="programlisting">
1.100 rillig 7779: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7780: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7781: ===> To view the license, enter "/usr/bin/make show-license".
7782: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7783: ===> ACCEPTABLE_LICENSES+=xv-license
7784: *** Error code 1
1.87 wiz 7785: </pre>
1.110 hubertf 7786: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7787: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7788: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7789: convey to pkgsrc that it should not in the future fail because of
7790: that license:</p>
1.78 rillig 7791: <pre class="programlisting">
1.100 rillig 7792: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7793: </pre>
1.98 wiz 7794: <p>When adding a package with a new license, the license text
7795: should be added to <code class="filename">pkgsrc/licenses</code> for
7796: displaying. A list of known licenses can be seen in this
1.91 rillig 7797: directory.</p>
1.98 wiz 7798: <p>When the license changes (in a way other than formatting),
7799: please make sure that the new license has a different name (e.g.,
7800: append the version number if it exists, or the date). Just
7801: because a user told pkgsrc to build programs under a previous
7802: version of a license does not mean that pkgsrc should build
1.99 rillig 7803: programs under the new licenses. The higher-level point is that
1.98 wiz 7804: pkgsrc does not evaluate licenses for reasonableness; the only
7805: test is a mechanistic test of whether a particular text has been
7806: approved by either of two bodies.</p>
1.78 rillig 7807: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7808: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7809: is deprecated because it does not crisply refer to a particular
7810: license text. Another problem with such usage is that it does not
7811: enable a user to tell pkgsrc to proceed for a single package
7812: without also telling pkgsrc to proceed for all packages with that
7813: tag.</p>
1.75 rillig 7814: </div>
1.128 ! wiz 7815: <div class="sect2" title="19.1.5. Restricted packages">
1.75 rillig 7816: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7817: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7818: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7819: Because a license tag is required unless the package is Free or
7820: Open Source, all packages with restrictions should have license
7821: tags. By declaring the restrictions, package tools can
7822: automatically refrain from e.g. placing binary packages on FTP
7823: sites.</p>
7824: <p>There are four restrictions that may be encoded, which are
7825: the cross product of sources (distfiles) and binaries not being
7826: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7827: language in any license, and because non-Free licenses tend to be
7828: different from each other, pkgsrc adopts a definition of FTP and
7829: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7830: should not be made available over the Internet at no charge.
7831: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7832: made available on some kind of media, together with other source
7833: and binary packages, and which is sold for a distribution charge.
7834: </p>
7835: <p>In order to encode these restrictions, the package system
1.87 wiz 7836: defines five make variables that can be set to note these
7837: restrictions:</p>
1.128 ! wiz 7838: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 7839: <li class="listitem">
1.75 rillig 7840: <p><code class="varname">RESTRICTED</code></p>
7841: <p>This variable should be set whenever a restriction
1.87 wiz 7842: exists (regardless of its kind). Set this variable to a
1.98 wiz 7843: string containing the reason for the restriction. It should
7844: be understood that those wanting to understand the restriction
7845: will have to read the license, and perhaps seek advice of
7846: counsel.</p>
1.75 rillig 7847: </li>
1.128 ! wiz 7848: <li class="listitem">
1.75 rillig 7849: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7850: <p>Binaries may not be placed on CD-ROM containing other
7851: binary packages, for which a distribution charge may be made.
7852: In this case, set this variable to
7853: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7854: </li>
1.128 ! wiz 7855: <li class="listitem">
1.75 rillig 7856: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7857: <p>Binaries may not made available on the Internet without
7858: charge. In this case, set this variable to
7859: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7860: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7861: </li>
1.128 ! wiz 7862: <li class="listitem">
1.75 rillig 7863: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7864: <p>Distfiles may not be placed on CD-ROM, together with
7865: other distfiles, for which a fee may be charged. In this
7866: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7867: </p>
1.75 rillig 7868: </li>
1.128 ! wiz 7869: <li class="listitem">
1.75 rillig 7870: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7871: <p>Distfiles may not made available via FTP at no charge.
7872: In this case, set this variable to
7873: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7874: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7875: </li>
7876: </ul></div>
7877: </div>
1.128 ! wiz 7878: <div class="sect2" title="19.1.6. Handling dependencies">
1.75 rillig 7879: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7880: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7881: <p>Your package may depend on some other package being present
1.88 wiz 7882: - and there are various ways of expressing this dependency.
7883: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7884: <code class="varname">DEPENDS</code> definitions, the
7885: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7886: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7887: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7888: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7889: <p>The basic difference between the two variables is as
1.87 wiz 7890: follows: The <code class="varname">DEPENDS</code> definition registers
7891: that pre-requisite in the binary package so it will be pulled in
7892: when the binary package is later installed, whilst the
7893: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7894: dependency that is only needed for building the package.</p>
1.75 rillig 7895: <p>This means that if you only need a package present whilst
1.87 wiz 7896: you are building, it should be noted as a
7897: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7898: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7899: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7900: <pre class="programlisting">
1.100 rillig 7901: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7902: </pre>
1.128 ! wiz 7903: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7904: may include any of the wildcard version numbers recognized by
1.110 hubertf 7905: <a class="citerefentry" 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.128 ! wiz 7906: <div class="orderedlist"><ol class="orderedlist" type="1">
! 7907: <li class="listitem">
1.75 rillig 7908: <p>If your package needs another package's binaries or
1.87 wiz 7909: libraries to build or run, and if that package has a
7910: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7911: <pre class="programlisting">
1.100 rillig 7912: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7913: </pre>
1.75 rillig 7914: </li>
1.128 ! wiz 7915: <li class="listitem">
1.75 rillig 7916: <p>If your package needs to use another package to build
1.87 wiz 7917: itself and there is no <code class="filename">buildlink3.mk</code>
7918: file available, use the <code class="varname">BUILD_DEPENDS</code>
7919: definition:</p>
1.75 rillig 7920: <pre class="programlisting">
1.100 rillig 7921: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87 wiz 7922: </pre>
1.75 rillig 7923: </li>
1.128 ! wiz 7924: <li class="listitem">
1.75 rillig 7925: <p>If your package needs a library with which to link and
1.76 rillig 7926: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7927: available, this is specified using the
7928: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7929: <pre class="programlisting">
1.100 rillig 7930: DEPENDS+= xpm-3.4j:../../graphics/xpm
1.87 wiz 7931: </pre>
1.109 rillig 7932: <p>You can also use wildcards in package dependencies:</p>
1.75 rillig 7933: <pre class="programlisting">
1.100 rillig 7934: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
1.87 wiz 7935: </pre>
1.75 rillig 7936: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7937: creating binary packages. The dependency is checked when
7938: installing the binary package and any package which matches
7939: the pattern will be used. Wildcard dependencies should be
7940: used with care.</p>
1.128 ! wiz 7941: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
! 7942: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
! 7943: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
! 7944: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7945: <p>Wildcards can also be used to specify that a package
1.87 wiz 7946: will only build against a certain minimum version of a
7947: pre-requisite:</p>
1.75 rillig 7948: <pre class="programlisting">
1.100 rillig 7949: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
1.87 wiz 7950: </pre>
1.75 rillig 7951: <p>This means that the package will build against version
1.87 wiz 7952: 3.5.4 of the tiff library or newer. Such a dependency may
7953: be warranted if, for example, the API of the library has
7954: changed with version 3.5.4 and a package would not compile
7955: against an earlier version of tiff.</p>
1.75 rillig 7956: <p>Please note that such dependencies should only be
1.87 wiz 7957: updated if a package requires a newer pre-requisite, but
1.93 rillig 7958: not to denote recommendations such as
1.87 wiz 7959: ABI changes that do not prevent a package from building
7960: correctly. Such recommendations can be expressed using
7961: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7962: <pre class="programlisting">
1.100 rillig 7963: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
1.87 wiz 7964: </pre>
1.75 rillig 7965: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7966: line, this denotes that while a package will build against
7967: tiff>=3.5.4, at least version 3.6.1 is recommended.
7968: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7969: dependencies unless explicitly ignored (in which case a
7970: warning will be printed).</p>
1.75 rillig 7971: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7972: use the required <code class="varname">DEPENDS</code>, set
7973: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7974: it easier and faster to update packages built using pkgsrc,
7975: since older compatible dependencies can continue to be
7976: used. This is useful for people who watch their rebuilds
7977: very carefully; it is not very good as a general-purpose
7978: hammer. If you use it, you need to be mindful of possible
7979: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7980: <p>Packages that are built with recommendations ignored
1.87 wiz 7981: may not be uploaded to ftp.NetBSD.org by developers and
7982: should not be used across different systems that may have
7983: different versions of binary packages installed.</p>
1.75 rillig 7984: <p>For security fixes, please update the package
1.110 hubertf 7985: vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, “Handling packages with security problems”</a> for more
1.87 wiz 7986: information.</p>
1.75 rillig 7987: </li>
1.128 ! wiz 7988: <li class="listitem">
1.75 rillig 7989: <p>If your package needs some executable to be able to run
1.87 wiz 7990: correctly and if there's no
7991: <code class="filename">buildlink3.mk</code> file, this is specified
7992: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 7993: <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 7994: be able to execute the latex binary from the teTeX package
7995: when it runs, and that is specified:</p>
1.75 rillig 7996: <pre class="programlisting">
1.100 rillig 7997: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7998: </pre>
1.75 rillig 7999: <p>The comment about wildcard dependencies from previous
1.87 wiz 8000: paragraph applies here, too.</p>
1.75 rillig 8001: </li>
8002: </ol></div>
8003: <p>If your package needs files from another package to build,
1.87 wiz 8004: add the relevant distribution files to
8005: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 8006: 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 8007: (It relies on the jpeg sources being present in source form
8008: during the build.)</p>
1.75 rillig 8009: </div>
1.128 ! wiz 8010: <div class="sect2" title="19.1.7. Handling conflicts with other packages">
1.75 rillig 8011: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8012: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 8013: <p>Your package may conflict with other packages a user might
1.87 wiz 8014: already have installed on his system, e.g. if your package
1.88 wiz 8015: installs the same set of files as another package in the pkgsrc
8016: tree.</p>
1.75 rillig 8017: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 8018: space-separated list of packages (including version string) your
8019: package conflicts with.</p>
1.91 rillig 8020: <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>
8021: 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 8022: install the same shared library, thus you set in
8023: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8024: <pre class="programlisting">
1.100 rillig 8025: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 8026: </pre>
8027: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 8028: <pre class="programlisting">
1.100 rillig 8029: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 8030: </pre>
1.75 rillig 8031: <p>Packages will automatically conflict with other packages
1.87 wiz 8032: with the name prefix and a different version
1.128 ! wiz 8033: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
! 8034: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.75 rillig 8035: </div>
1.128 ! wiz 8036: <div class="sect2" title="19.1.8. Packages that cannot or should not be built">
1.75 rillig 8037: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8038: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 8039: <p>There are several reasons why a package might be
1.88 wiz 8040: instructed to not build under certain circumstances. If the
1.87 wiz 8041: package builds and runs on most platforms, the exceptions
8042: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8043: the package builds and runs on a small handful of platforms,
8044: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8045: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8046: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8047: (OS-version-platform) that can use glob-style
8048: wildcards.</p>
1.88 wiz 8049: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8050: 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 8051: backwards compatible with other versions of the OS, and should be
8052: uploaded to a version specific directory on the FTP server. Mark
8053: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 ! wiz 8054: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 8055: the package system internals, but may be used in the
8056: future.</p>
1.75 rillig 8057: <p>If the package should be skipped (for example, because it
1.87 wiz 8058: provides functionality already provided by the system), set
1.88 wiz 8059: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8060: the package should fail because some preconditions are not met,
8061: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8062: message.</p>
1.75 rillig 8063: </div>
1.128 ! wiz 8064: <div class="sect2" title="19.1.9. Packages which should not be deleted, once installed">
1.75 rillig 8065: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8066: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8067: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8068: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8069: be set in the package Makefile. This will be carried into any
8070: binary package that is made from this pkgsrc entry. A
1.128 ! wiz 8071: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.110 hubertf 8072: not be deleted using <a class="citerefentry" 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
1.128 ! wiz 8073: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 8074: </div>
1.128 ! wiz 8075: <div class="sect2" title="19.1.10. Handling packages with security problems">
1.75 rillig 8076: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8077: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8078: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8079: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110 hubertf 8080: and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87 wiz 8081: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 8082: <p>After fixing the vulnerability by a patch, its
1.87 wiz 8083: <code class="varname">PKGREVISION</code> should be increased (this
8084: is of course not necessary if the problem is fixed by using
8085: a newer release of the software).</p>
1.75 rillig 8086: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8087: branch, be sure to submit a pullup request!</p>
1.75 rillig 8088: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8089: semi-automatically by a weekly cron job.</p>
1.75 rillig 8090: </div>
1.128 ! wiz 8091: <div class="sect2" title="19.1.11. How to handle incrementing versions when fixing an existing package">
1.75 rillig 8092: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8093: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 8094: <p>When making fixes to an existing package it can be useful
1.87 wiz 8095: to change the version number in <code class="varname">PKGNAME</code>. To
8096: avoid conflicting with future versions by the original author, a
1.128 ! wiz 8097: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.87 wiz 8098: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 ! wiz 8099: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
! 8100: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 8101: <pre class="programlisting">
1.100 rillig 8102: DISTNAME= foo-17.42
8103: PKGREVISION= 9
1.87 wiz 8104: </pre>
1.75 rillig 8105: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 ! wiz 8106: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
! 8107: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 8108: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8109: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8110: <p>When a new release of the package is released, the
1.87 wiz 8111: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8112: minor release of the above package, things should be like:</p>
1.75 rillig 8113: <pre class="programlisting">
1.100 rillig 8114: DISTNAME= foo-17.43
1.87 wiz 8115: </pre>
8116: <p><code class="varname">PKGREVISION</code> should be incremented for any
8117: non-trivial change in the resulting binary package. Without a
8118: <code class="varname">PKGREVISION</code> bump, someone with the previous
8119: version installed has no way of knowing that their package is out
8120: of date. Thus, changes without increasing
8121: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8122: trivial that no reasonable person would want to upgrade", and this
8123: is the rough test for when increasing
8124: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8125: changes that do not merit increasing
8126: <code class="varname">PKGREVISION</code> are:</p>
1.128 ! wiz 8127: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 8128: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 8129: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8130: or comments in Makefile.</p></li>
1.128 ! wiz 8131: <li class="listitem"><p>
1.100 rillig 8132: Changing build variables if the resulting binary package is the same.</p></li>
1.128 ! wiz 8133: <li class="listitem"><p>
1.100 rillig 8134: Changing <code class="filename">DESCR</code>.</p></li>
1.128 ! wiz 8135: <li class="listitem"><p>
1.100 rillig 8136: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8137: </ul></div>
1.87 wiz 8138: <p>Examples of changes that do merit an increase to
8139: <code class="varname">PKGREVISION</code> include:</p>
1.128 ! wiz 8140: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 8141: <li class="listitem"><p>
1.100 rillig 8142: Security fixes</p></li>
1.128 ! wiz 8143: <li class="listitem"><p>
1.100 rillig 8144: Changes or additions to a patch file</p></li>
1.128 ! wiz 8145: <li class="listitem"><p>
1.100 rillig 8146: Changes to the <code class="filename">PLIST</code></p></li>
1.128 ! wiz 8147: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8148: </ul></div>
1.78 rillig 8149: <p>PKGREVISION must also be incremented when dependencies have ABI
8150: changes.</p>
1.75 rillig 8151: </div>
1.128 ! wiz 8152: <div class="sect2" title="19.1.12. Substituting variable text in the package files (the SUBST framework)">
1.79 rillig 8153: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8154: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79 rillig 8155: <p>When you want to replace the same text in multiple files
1.87 wiz 8156: or when the replacement text varies, patches alone cannot help.
8157: This is where the SUBST framework comes in. It provides an
8158: easy-to-use interface for replacing text in files.
8159: Example:</p>
8160: <pre class="programlisting">
1.100 rillig 8161: SUBST_CLASSES+= fix-paths
8162: SUBST_STAGE.fix-paths= pre-configure
8163: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8164: SUBST_FILES.fix-paths= src/*.c
8165: SUBST_FILES.fix-paths+= scripts/*.sh
8166: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8167: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8168: </pre>
1.79 rillig 8169: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8170: that are used to identify the different SUBST blocks that are
8171: defined. The SUBST framework is heavily used by pkgsrc, so it is
8172: important to always use the <code class="literal">+=</code> operator with
8173: this variable. Otherwise some substitutions may be
8174: skipped.</p>
1.79 rillig 8175: <p>The remaining variables of each SUBST block are
1.87 wiz 8176: parameterized with the identifier from the first line
8177: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8178: parameters to a function call.</p>
1.79 rillig 8179: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8180: which the replacement will take place. All combinations of
8181: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8182: <code class="literal">post-</code> together with a phase name are
8183: possible, though only few are actually used. Most commonly used
8184: are <code class="literal">post-patch</code> and
8185: <code class="literal">pre-configure</code>. Of these two,
8186: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8187: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8188: have the state after applying the patches but before making any
8189: other changes. This is especially useful when you are debugging
8190: a package in order to create new patches for it. Similarly,
8191: <code class="literal">post-build</code> is preferred over
8192: <code class="literal">pre-install</code>, because the install phase should
8193: generally be kept as simple as possible. When you use
8194: <code class="literal">post-build</code>, you have the same files in the
8195: working directory that will be installed later, so you can check
8196: if the substitution has succeeded.</p>
1.79 rillig 8197: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8198: that is printed just before the substitution is done.</p>
1.79 rillig 8199: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8200: globbing patterns that specifies the files in which the
8201: substitution will take place. The patterns are interpreted
8202: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8203: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110 hubertf 8204: <a class="citerefentry" 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
1.87 wiz 8205: command should be prefixed with <code class="literal">-e</code>, so that
8206: all SUBST blocks look uniform.</p>
1.79 rillig 8207: <p>There are some more variables, but they are so seldomly
1.87 wiz 8208: used that they are only documented in the
8209: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8210: </div>
1.75 rillig 8211: </div>
1.128 ! wiz 8212: <div class="sect1" title="19.2. Fixing problems in the fetch phase">
1.75 rillig 8213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8214: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.128 ! wiz 8215: <div class="sect2" title="19.2.1. Packages whose distfiles aren't available for plain downloading">
1.75 rillig 8216: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8217: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 8218: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8219: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8220: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8221: with the name of each file to download as an argument, expecting
8222: it to output the URL of the directory from which to download
1.91 rillig 8223: 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 8224: example of this usage.</p>
1.75 rillig 8225: <p>If the download can't be automated, because the user must
1.87 wiz 8226: submit personal information to apply for a password, or must pay
8227: for the source, or whatever, you can set
8228: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8229: displayed to the user before aborting the build. Example:</p>
8230: <pre class="programlisting">
1.100 rillig 8231: FETCH_MESSAGE= "Please download the files"
8232: FETCH_MESSAGE+= " "${DISTFILES:Q}
8233: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8234: </pre>
1.75 rillig 8235: </div>
1.128 ! wiz 8236: <div class="sect2" title="19.2.2. How to handle modified distfiles with the 'old' name">
1.75 rillig 8237: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8238: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 8239: <p>Sometimes authors of a software package make some
1.87 wiz 8240: modifications after the software was released, and they put up a
8241: new distfile without changing the package's version number. If a
8242: package is already in pkgsrc at that time, the checksum will
8243: no longer match. The contents of the new distfile should be
8244: compared against the old one before changing anything, to make
8245: sure the distfile was really updated on purpose, and that
8246: no trojan horse or so crept in.
1.97 rillig 8247: Please mention that the distfiles were compared and what was found
8248: in your commit message.
1.87 wiz 8249: Then, the correct way to work around this is to
8250: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8251: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8252: <code class="varname">DISTFILES</code> and
1.93 rillig 8253: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8254: subdirectory of the local distfiles directory.
1.110 hubertf 8255: (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, “How to handle incrementing versions when fixing an existing package”</a> for more details.)
1.97 rillig 8256: In case this
1.87 wiz 8257: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8258: including the <code class="filename">nbX</code> suffix) or a date stamp
8259: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8260: Do not forget regenerating the <code class="filename">distinfo</code> file
8261: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8262: path in the filenames.
1.97 rillig 8263: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8264: Furthermore, a mail to the package's authors seems appropriate
8265: telling them that changing distfiles after releases without
8266: changing the file names is not good practice.</p>
1.75 rillig 8267: </div>
8268: </div>
1.128 ! wiz 8269: <div class="sect1" title="19.3. Fixing problems in the configure phase">
1.75 rillig 8270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8271: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.128 ! wiz 8272: <div class="sect2" title="19.3.1. Shared libraries - libtool">
1.75 rillig 8273: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8274: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8275: <p>pkgsrc supports many different machines, with different
1.87 wiz 8276: object formats like a.out and ELF, and varying abilities to do
8277: shared library and dynamic loading at all. To accompany this,
8278: varying commands and options have to be passed to the
8279: compiler, linker, etc. to get the Right Thing, which can be
8280: pretty annoying especially if you don't have all the machines
8281: at your hand to test things. The
1.91 rillig 8282: <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.128 ! wiz 8283: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8284: both static and dynamic libraries from a set of source files,
8285: thus being platform-independent.</p>
8286: <p>Here's how to use libtool in a package in seven simple
8287: steps:</p>
1.128 ! wiz 8288: <div class="orderedlist"><ol class="orderedlist" type="1">
! 8289: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8290: Makefile.</p></li>
1.128 ! wiz 8291: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
! 8292: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8293: add it to the definition of <code class="varname">CC</code>, if only
8294: libraries are being built in a given Makefile. This one command
8295: will build both PIC and non-PIC library objects, so you need not
8296: have separate shared and non-shared library rules.</p></li>
1.128 ! wiz 8297: <li class="listitem">
1.75 rillig 8298: <p>For the linking of the library, remove any
1.128 ! wiz 8299: <span class="quote">“<span class="quote">ar</span>”</span>, <span class="quote">“<span class="quote">ranlib</span>”</span>, and <span class="quote">“<span class="quote">ld
! 8300: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8301: <pre class="programlisting">
1.100 rillig 8302: ${LIBTOOL} --mode=link \
8303: ${CC} -o ${.TARGET:.a=.la} \
8304: ${OBJS:.o=.lo} \
8305: -rpath ${PREFIX}/lib \
8306: -version-info major:minor
1.87 wiz 8307: </pre>
1.75 rillig 8308: <p>Note that the library is changed to have a
1.87 wiz 8309: <code class="filename">.la</code> extension, and the objects are
8310: changed to have a <code class="filename">.lo</code>
8311: extension. Change <code class="varname">OBJS</code> as
8312: necessary. This automatically creates all of the
8313: <code class="filename">.a</code>,
8314: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8315: necessary) in the build directory. Be sure to include
1.128 ! wiz 8316: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8317: minor are zero, as libtool will otherwise strip off the
8318: shared library version.</p>
1.75 rillig 8319: <p>From the libtool manual:</p>
8320: <pre class="programlisting">
1.100 rillig 8321: So, libtool library versions are described by three integers:
1.69 rillig 8322:
1.100 rillig 8323: CURRENT
8324: The most recent interface number that this library implements.
1.69 rillig 8325:
1.100 rillig 8326: REVISION
8327: The implementation number of the CURRENT interface.
1.69 rillig 8328:
1.100 rillig 8329: AGE
8330: The difference between the newest and oldest interfaces that
8331: this library implements. In other words, the library implements
8332: all the interface numbers in the range from number `CURRENT -
8333: AGE' to `CURRENT'.
1.1 grant 8334:
1.100 rillig 8335: If two libraries have identical CURRENT and AGE numbers, then the
8336: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8337: </pre>
1.128 ! wiz 8338: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8339: different results for a.out and ELF (excluding symlinks)
8340: in only one case. An ELF library of the form
1.128 ! wiz 8341: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 8342: will have a symlink of
1.128 ! wiz 8343: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 8344: on an a.out platform. This is handled
8345: automatically.</p>
1.128 ! wiz 8346: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8347: directory of the library being built.</p>
1.76 rillig 8348: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8349: <code class="filename">.la</code> file, the other files will be
8350: added automatically.</p>
1.75 rillig 8351: </li>
1.128 ! wiz 8352: <li class="listitem">
1.76 rillig 8353: <p>When linking shared object (<code class="filename">.so</code>)
1.110 hubertf 8354: files, i.e. files that are loaded via <a class="citerefentry" 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
1.128 ! wiz 8355: shared libraries, use <span class="quote">“<span class="quote">-module
! 8356: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8357: tacked on.</p>
1.76 rillig 8358: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8359: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8360: </li>
1.128 ! wiz 8361: <li class="listitem">
1.75 rillig 8362: <p>When linking programs that depend on these libraries
1.87 wiz 8363: <span class="emphasis"><em>before</em></span> they are installed, preface
1.128 ! wiz 8364: the <a class="citerefentry" 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 class="citerefentry" 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">“<span class="quote">${LIBTOOL}
! 8365: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8366: libraries (static or shared), but please be aware that
8367: libtool will not allow you to specify a relative path in
1.128 ! wiz 8368: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8369: expects you to change that argument to be the
8370: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8371: <pre class="programlisting">
1.100 rillig 8372: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8373: </pre>
1.75 rillig 8374: <p>should be changed to:</p>
8375: <pre class="programlisting">
1.100 rillig 8376: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8377: </pre>
1.75 rillig 8378: <p>and it will do the right thing with the libraries.</p>
8379: </li>
1.128 ! wiz 8380: <li class="listitem">
1.110 hubertf 8381: <p>When installing libraries, preface the <a class="citerefentry" 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.128 ! wiz 8382: or <a class="citerefentry" 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">“<span class="quote">${LIBTOOL}
! 8383: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8384: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8385: <pre class="programlisting">
1.126 jakllsch 8386: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8387: </pre>
1.76 rillig 8388: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8389: shared library, any needed symlinks, and run
1.110 hubertf 8390: <a class="citerefentry" 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 8391: </li>
1.128 ! wiz 8392: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8393: the <code class="filename">.la</code>
8394: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8395: </ol></div>
8396: </div>
1.128 ! wiz 8397: <div class="sect2" title="19.3.2. Using libtool on GNU packages that already support libtool">
1.75 rillig 8398: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8399: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8400: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8401: package Makefile. This will override the package's own libtool
8402: in most cases. For older libtool using packages, libtool is
8403: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8404: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8405: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8406: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8407: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 ! wiz 8408: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
! 8409: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8410: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8411: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8412: libraries built and installed, then use
8413: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8414: <p>If your package makes use of the platform-independent library
1.87 wiz 8415: for loading dynamic shared objects, that comes with libtool
8416: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8417: <p>Some packages use libtool incorrectly so that the package
8418: may not work or build in some circumstances. Some of the more
8419: common errors are:</p>
1.128 ! wiz 8420: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 8421: <li class="listitem">
1.75 rillig 8422: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8423: executable or library. This in itself isn't a problem if one of two things
8424: has been done:</p>
1.128 ! wiz 8425: <div class="orderedlist"><ol class="orderedlist" type="1">
! 8426: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8427: <code class="filename">libfoo.la</code>, not
8428: <code class="filename">foo.la</code></p></li>
1.128 ! wiz 8429: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8430: </ol></div>
8431: </li>
1.128 ! wiz 8432: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8433: The function lt_dlinit() should be called and the macro
8434: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8435: executables.</p></li>
1.75 rillig 8436: </ul></div>
8437: </div>
1.128 ! wiz 8438: <div class="sect2" title="19.3.3. GNU Autoconf/Automake">
1.75 rillig 8439: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8440: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8441: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8442: to regenerate the configure script and Makefile.in makefile
8443: templates, then they should be executed in a pre-configure
8444: target.</p>
1.75 rillig 8445: <p>For packages that need only autoconf:</p>
8446: <pre class="programlisting">
1.100 rillig 8447: AUTOCONF_REQD= 2.50 # if default version is not good enough
8448: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8449: ...
1.1 grant 8450:
1.100 rillig 8451: pre-configure:
8452: cd ${WRKSRC} && autoconf
1.1 grant 8453:
1.100 rillig 8454: ...
1.87 wiz 8455: </pre>
1.75 rillig 8456: <p>and for packages that need automake and autoconf:</p>
8457: <pre class="programlisting">
1.100 rillig 8458: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8459: USE_TOOLS+= automake # use "automake14" for automake-1.4
8460: ...
8461:
8462: pre-configure:
8463: set -e; cd ${WRKSRC}; \
8464: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8465:
1.100 rillig 8466: ...
1.87 wiz 8467: </pre>
1.75 rillig 8468: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8469: require GNU Make.</p>
1.75 rillig 8470: <p>There are times when the configure process makes
1.87 wiz 8471: additional changes to the generated files, which then causes
8472: the build process to try to re-execute the automake sequence.
8473: This is prevented by touching various files in the configure
8474: stage. If this causes problems with your package you can set
8475: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8476: Makefile.</p>
1.75 rillig 8477: </div>
8478: </div>
1.128 ! wiz 8479: <div class="sect1" title="19.4. Programming languages">
1.75 rillig 8480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8481: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.128 ! wiz 8482: <div class="sect2" title="19.4.1. C, C++, and Fortran">
1.87 wiz 8483: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8484: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8485: <p>Compilers for the C, C++, and Fortran languages comes with
8486: the NetBSD base system. By default, pkgsrc assumes that a package
8487: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8488: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8489: <p>To declare which language's compiler a package needs, set
8490: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 ! wiz 8491: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
! 8492: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
! 8493: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8494: written in C++, usually need a C compiler for the configure
8495: phase.</p>
8496: </div>
1.128 ! wiz 8497: <div class="sect2" title="19.4.2. Java">
1.87 wiz 8498: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8499: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8500: <p>If a program is written in Java, use the Java framework in
8501: pkgsrc. The package must include
8502: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8503: provides the following variables:</p>
1.128 ! wiz 8504: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 8505: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8506: dependency on the JDK is added. If
1.128 ! wiz 8507: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8508: there is only a runtime dependency on the JDK. The default is
1.128 ! wiz 8509: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8510: JDK.</p></li>
1.128 ! wiz 8511: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8512: a package needs a Java2 implementation. The supported values
1.128 ! wiz 8513: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
! 8514: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
! 8515: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
! 8516: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8517: above. This variable is not set by default.</p></li>
8518: </ul></div>
8519: </div>
1.128 ! wiz 8520: <div class="sect2" title="19.4.3. Packages containing perl scripts">
1.87 wiz 8521: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8522: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8523: <p>If your package contains interpreted perl scripts, add
1.128 ! wiz 8524: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8525: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8526: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8527: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8528: that you want adjusted. Every occurrence of
8529: <code class="filename">*/bin/perl</code> will be replaced with the full
8530: path to the perl executable.</p>
8531: <p>If a particular version of perl is needed, set the
8532: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 ! wiz 8533: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8534: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, “Packages installing perl modules”</a> for information
1.87 wiz 8535: about handling perl modules.</p>
8536: </div>
1.128 ! wiz 8537: <div class="sect2" title="19.4.4. Other programming languages">
1.87 wiz 8538: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8539: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8540: <p>Currently, there is no special handling for other languages
8541: in pkgsrc. If a compiler package provides a
8542: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8543: just add a (build) dependency on the appropriate compiler
8544: package.</p>
8545: </div>
8546: </div>
1.128 ! wiz 8547: <div class="sect1" title="19.5. Fixing problems in the build phase">
1.87 wiz 8548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8549: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8550: <p>The most common failures when building a package are that
8551: some platforms do not provide certain header files, functions or
8552: libraries, or they provide the functions in a library that the
8553: original package author didn't know. To work around this, you
8554: can rewrite the source code in most cases so that it does not
8555: use the missing functions or provides a replacement function.</p>
1.128 ! wiz 8556: <div class="sect2" title="19.5.1. Compiling C and C++ code conditionally">
1.77 rillig 8557: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8558: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8559: <p>If a package already comes with a GNU configure script, the
8560: preferred way to fix the build failure is to change the
8561: configure script, not the code. In the other cases, you can
8562: utilize the C preprocessor, which defines certain macros
8563: depending on the operating system and hardware architecture it
8564: compiles for. These macros can be queried using for example
8565: <code class="varname">#if defined(__i386)</code>. Almost every operating
8566: system, hardware architecture and compiler has its own macro.
8567: For example, if the macros <code class="varname">__GNUC__</code>,
8568: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8569: are all defined, you know that you are using NetBSD on an i386
8570: compatible CPU, and your compiler is GCC.</p>
8571: <p>The list of the following macros for hardware and
8572: operating system depends on the compiler that is used. For
8573: example, if you want to conditionally compile code on Solaris,
8574: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8575: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.128 ! wiz 8576: <div class="sect3" title="19.5.1.1. C preprocessor macros to identify the operating system">
1.75 rillig 8577: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8578: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 8579: <p>To distinguish between 4.4 BSD-derived systems and the
8580: rest of the world, you should use the following code.</p>
8581: <pre class="programlisting">
1.100 rillig 8582: #include <sys/param.h>
8583: #if (defined(BSD) && BSD >= 199306)
8584: /* BSD-specific code goes here */
8585: #else
8586: /* non-BSD-specific code goes here */
8587: #endif
1.75 rillig 8588: </pre>
1.77 rillig 8589: <p>If this distinction is not fine enough, you can also test
8590: for the following macros.</p>
1.75 rillig 8591: <pre class="programlisting">
1.100 rillig 8592: FreeBSD __FreeBSD__
8593: DragonFly __DragonFly__
8594: Interix __INTERIX
8595: IRIX __sgi (TODO: get a definite source for this)
8596: Linux linux, __linux, __linux__
8597: NetBSD __NetBSD__
8598: OpenBSD __OpenBSD__
8599: Solaris sun, __sun
1.75 rillig 8600: </pre>
8601: </div>
1.128 ! wiz 8602: <div class="sect3" title="19.5.1.2. C preprocessor macros to identify the hardware architecture">
1.75 rillig 8603: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8604: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 8605: <pre class="programlisting">
1.100 rillig 8606: i386 i386, __i386, __i386__
8607: MIPS __mips
8608: SPARC sparc, __sparc
1.75 rillig 8609: </pre>
8610: </div>
1.128 ! wiz 8611: <div class="sect3" title="19.5.1.3. C preprocessor macros to identify the compiler">
1.75 rillig 8612: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8613: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 8614: <pre class="programlisting">
1.100 rillig 8615: GCC __GNUC__ (major version), __GNUC_MINOR__
8616: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8617: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8618: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8619: </pre>
8620: </div>
8621: </div>
1.128 ! wiz 8622: <div class="sect2" title="19.5.2. How to handle compiler bugs">
1.78 rillig 8623: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8624: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8625: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8626: combinations of compiler version and architecture and almost
8627: always relation to optimisation being enabled. Common symptoms
8628: are gcc internal errors or never finishing compiling a
1.78 rillig 8629: file.</p>
8630: <p>Typically, a workaround involves testing the
8631: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8632: optimisation for that combination of file,
8633: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8634: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8635: number of examples.</p>
8636: </div>
1.128 ! wiz 8637: <div class="sect2" title="19.5.3. Undefined reference to “...”">
1.78 rillig 8638: <div class="titlepage"><div><div><h3 class="title">
1.128 ! wiz 8639: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
! 8640: </h3></div></div></div>
1.92 rillig 8641: <p>This error message often means that a package did not
1.78 rillig 8642: link to a shared library it needs. The following functions are
8643: known to cause this error message over and over.</p>
8644: <div class="informaltable">
8645: <a name="undefined-reference-functions"></a><table border="1">
8646: <colgroup>
8647: <col>
8648: <col>
8649: <col>
8650: </colgroup>
8651: <thead><tr>
8652: <th>Function</th>
8653: <th>Library</th>
8654: <th>Affected platforms</th>
8655: </tr></thead>
8656: <tbody>
8657: <tr>
8658: <td>accept, bind, connect</td>
8659: <td>-lsocket</td>
8660: <td>Solaris</td>
8661: </tr>
8662: <tr>
8663: <td>crypt</td>
8664: <td>-lcrypt</td>
8665: <td>DragonFly, NetBSD</td>
8666: </tr>
8667: <tr>
8668: <td>dlopen, dlsym</td>
8669: <td>-ldl</td>
8670: <td>Linux</td>
8671: </tr>
8672: <tr>
8673: <td>gethost*</td>
8674: <td>-lnsl</td>
8675: <td>Solaris</td>
8676: </tr>
8677: <tr>
8678: <td>inet_aton</td>
8679: <td>-lresolv</td>
8680: <td>Solaris</td>
8681: </tr>
8682: <tr>
8683: <td>nanosleep, sem_*, timer_*</td>
8684: <td>-lrt</td>
8685: <td>Solaris</td>
8686: </tr>
8687: <tr>
8688: <td>openpty</td>
8689: <td>-lutil</td>
8690: <td>Linux</td>
8691: </tr>
8692: </tbody>
8693: </table>
8694: </div>
8695: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8696: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8697: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8698: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8699: bmake</strong></span>.</p>
1.128 ! wiz 8700: <div class="sect3" title="19.5.3.1. Special issue: The SunPro compiler">
1.92 rillig 8701: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8702: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8703: <p>When you are using the SunPro compiler, there is another
8704: possibility. That compiler cannot handle the following code:</p>
8705: <pre class="programlisting">
1.100 rillig 8706: extern int extern_func(int);
1.93 rillig 8707:
1.100 rillig 8708: static inline int
8709: inline_func(int x)
8710: {
1.92 rillig 8711: return extern_func(x);
1.100 rillig 8712: }
1.93 rillig 8713:
1.100 rillig 8714: int main(void)
8715: {
1.92 rillig 8716: return 0;
1.100 rillig 8717: }
1.92 rillig 8718: </pre>
8719: <p>It generates the code for <code class="function">inline_func</code> even if
8720: that function is never used. This code then refers to
8721: <code class="function">extern_func</code>, which can usually not be resolved. To
8722: solve this problem you can try to tell the package to disable inlining
8723: of functions.</p>
8724: </div>
1.87 wiz 8725: </div>
1.128 ! wiz 8726: <div class="sect2" title="19.5.4. Running out of memory">
1.87 wiz 8727: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8728: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8729: <p>Sometimes packages fail to build because the compiler runs
8730: into an operating system specific soft limit. With the
8731: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8732: to unlimit the resources. Currently, the allowed values are
1.128 ! wiz 8733: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8734: Setting this variable is similar to running the shell builtin
1.110 hubertf 8735: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8736: segment size or maximum stack size of a process, respectively, to
8737: their hard limits.</p>
1.78 rillig 8738: </div>
1.75 rillig 8739: </div>
1.128 ! wiz 8740: <div class="sect1" title="19.6. Fixing problems in the install phase">
1.75 rillig 8741: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8742: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.128 ! wiz 8743: <div class="sect2" title="19.6.1. Creating needed directories">
1.75 rillig 8744: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8745: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8746: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8747: with some operating systems cannot create more than one
8748: directory at a time. As such, you should call
8749: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8750: <pre class="programlisting">
1.100 rillig 8751: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8752: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8753: </pre>
1.128 ! wiz 8754: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
! 8755: dir2</code></span>”</span> to the
1.87 wiz 8756: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8757: automatically do the right thing.</p>
1.75 rillig 8758: </div>
1.128 ! wiz 8759: <div class="sect2" title="19.6.2. Where to install documentation">
1.75 rillig 8760: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8761: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8762: <p>In general, documentation should be installed into
1.87 wiz 8763: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8764: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8765: includes the version number of the package).</p>
1.84 wiz 8766: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8767: directory where HTML documentation is installed with the
1.128 ! wiz 8768: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8769: is needed because otherwise the documentation ends up in
8770: <code class="filename">${PREFIX}/share/doc/html</code> or other
8771: places.</p>
8772: <p>An exception to the above is that library API documentation
1.91 rillig 8773: 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 8774: browsers (devhelp) should be left at their default location, which
8775: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8776: documentation can be recognized from files ending in
8777: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8778: (It is also acceptable to install such files in
8779: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8780: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8781: <code class="filename">.devhelp*</code> file must be directly in that
8782: directory then, no additional subdirectory level is allowed in
8783: this case. This is usually achieved by using
1.128 ! wiz 8784: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8785: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8786: though.)</p>
1.75 rillig 8787: </div>
1.128 ! wiz 8788: <div class="sect2" title="19.6.3. Installing highscore files">
1.75 rillig 8789: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8790: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8791: <p>Certain packages, most of them in the games category, install
1.87 wiz 8792: a score file that allows all users on the system to record their
8793: highscores. In order for this to work, the binaries need to be
8794: installed setgid and the score files owned by the appropriate
8795: group and/or owner (traditionally the "games" user/group). The
8796: following variables, documented in more detail in
8797: <code class="filename">mk/defaults/mk.conf</code>, control this
8798: behaviour: <code class="varname">SETGIDGAME</code>,
8799: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8800: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8801: <p>Note that per default, setgid installation of games is
1.87 wiz 8802: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8803: the other variables accordingly.</p>
1.114 jmcneill 8804: <p>A package should therefore never hard code file ownership or
1.87 wiz 8805: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8806: <code class="varname">INSTALL_GAME_DATA</code> to set these
8807: correctly.</p>
1.75 rillig 8808: </div>
1.128 ! wiz 8809: <div class="sect2" title="19.6.4. Adding DESTDIR support to packages">
1.75 rillig 8810: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8811: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8812: <p><code class="varname">DESTDIR</code> support means that a package
8813: installs into a staging directory, not the final location of the
8814: files. Then a binary package is created which can be used for
8815: installation as usual. There are two ways: Either the package must
1.128 ! wiz 8816: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
! 8817: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
! 8818: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 8819: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
! 8820: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>. If
1.114 jmcneill 8821: bsd.prefs.mk is included in the Makefile,
8822: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8823: the inclusion.</p></li>
1.128 ! wiz 8824: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8825: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 ! wiz 8826: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8827: automatically. Many manual rules and pre/post-install often are
8828: incorrect; fix them.</p></li>
1.128 ! wiz 8829: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8830: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 ! wiz 8831: <li class="listitem"><p>In general, packages should support
1.103 wiz 8832: <code class="varname">UNPRIVILEGED</code> to be able to use
8833: DESTDIR.</p></li>
8834: </ul></div>
8835: </div>
1.128 ! wiz 8836: <div class="sect2" title="19.6.5. Packages with hardcoded paths to other interpreters">
1.103 wiz 8837: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8838: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8839: <p>Your package may also contain scripts with hardcoded paths to
8840: other interpreters besides (or as well as) perl. To correct the
8841: full pathname to the script interpreter, you need to set the
8842: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8843: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8844: <pre class="programlisting">
1.100 rillig 8845: REPLACE_INTERPRETER+= tcl
8846: REPLACE.tcl.old= .*/bin/tclsh
8847: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8848: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8849: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8850: </pre>
1.128 ! wiz 8851: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8852: <h3 class="title">Note</h3>
8853: <p>Before March 2006, these variables were called
1.87 wiz 8854: <code class="varname">_REPLACE.*</code> and
8855: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8856: </div>
8857: </div>
1.128 ! wiz 8858: <div class="sect2" title="19.6.6. Packages installing perl modules">
1.75 rillig 8859: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8860: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8861: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8862: the Makefile fragment
8863: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8864: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8865: configuration for such modules as well as various hooks to tune
8866: this configuration. See comments in this file for
8867: details.</p>
1.75 rillig 8868: <p>Perl5 modules will install into different places depending
1.87 wiz 8869: on the version of perl used during the build process. To
8870: address this, pkgsrc will append lines to the
8871: <code class="filename">PLIST</code> corresponding to the files listed in
8872: the installed <code class="filename">.packlist</code> file generated by
8873: most perl5 modules. This is invoked by defining
8874: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8875: paths to packlist files, e.g.:</p>
1.75 rillig 8876: <pre class="programlisting">
1.100 rillig 8877: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87 wiz 8878: </pre>
1.75 rillig 8879: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8880: <code class="varname">PERL5_SITEARCH</code>, and
8881: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8882: in which perl5 modules may be installed, and may be used by
8883: perl5 packages that don't have a packlist. These three
8884: variables are also substituted for in the
8885: <code class="filename">PLIST</code>.</p>
1.75 rillig 8886: </div>
1.128 ! wiz 8887: <div class="sect2" title="19.6.7. Packages installing info files">
1.75 rillig 8888: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8889: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8890: <p>Some packages install info files or use the
1.128 ! wiz 8891: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8892: commands. <code class="varname">INFO_FILES</code> should be defined in
8893: the package Makefile so that <code class="filename">INSTALL</code> and
8894: <code class="filename">DEINSTALL</code> scripts will be generated to
8895: handle registration of the info files in the Info directory
1.128 ! wiz 8896: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8897: files registration is either provided by the system, or by a
8898: special purpose package automatically added as dependency if
8899: needed.</p>
1.75 rillig 8900: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8901: <code class="filename">${PREFIX}</code> where info files are primarily
8902: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 ! wiz 8903: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8904: <p>The info files for the package should be listed in the
1.87 wiz 8905: package <code class="filename">PLIST</code>; however any split info files
8906: need not be listed.</p>
1.128 ! wiz 8907: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
! 8908: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8909: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 ! wiz 8910: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8911: should be noted with the <code class="varname">TEXINFO_REQD</code>
8912: variable in the package <code class="filename">Makefile</code>. By
8913: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8914: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8915: does not match the required minimum, a build dependency on the
1.91 rillig 8916: <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 8917: be added automatically.</p>
1.75 rillig 8918: <p>The build and installation process of the software provided
1.87 wiz 8919: by the package should not use the
1.110 hubertf 8920: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8921: info files is the task of the package
8922: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8923: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8924: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8925: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8926: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8927: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8928: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8929: no effect except the logging of a message. The script overriding
1.110 hubertf 8930: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8931: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8932: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8933: </div>
1.128 ! wiz 8934: <div class="sect2" title="19.6.8. Packages installing man pages">
1.75 rillig 8935: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8936: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8937: <p>All packages that install manual pages should install them
1.87 wiz 8938: into the same directory, so that there is one common place to look
8939: for them. In pkgsrc, this place is
8940: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8941: should be used in packages. The default for
8942: <code class="varname">PKGMANDIR</code> is
1.128 ! wiz 8943: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
! 8944: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
! 8945: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8946: <h3 class="title">Note</h3>
1.87 wiz 8947: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8948: is far from complete.</p>
1.75 rillig 8949: </div>
1.81 rillig 8950: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8951: <code class="filename">man/</code> as the top level directory for the man
8952: page file entries, and the pkgsrc framework will convert as
8953: needed. In all other places, the correct
8954: <code class="varname">PKGMANDIR</code> must be used.</p>
8955: <p>Packages that are
8956: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 ! wiz 8957: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8958: <code class="filename">./configure</code>
8959: --mandir switch to set where the man pages should be installed.
8960: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8961: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8962: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8963: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 ! wiz 8964: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8965: Or if the <code class="filename">./configure</code> script uses
8966: a non-standard use of --mandir, you can set
8967: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8968: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.87 wiz 8969: information on installation of compressed manual pages.</p>
1.75 rillig 8970: </div>
1.128 ! wiz 8971: <div class="sect2" title="19.6.9. Packages installing GConf data files">
1.75 rillig 8972: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8973: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8974: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8975: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8976: you need to take some extra steps to make sure they get registered
8977: in the database:</p>
1.128 ! wiz 8978: <div class="orderedlist"><ol class="orderedlist" type="1">
! 8979: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8980: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8981: takes care of rebuilding the GConf database at installation and
1.87 wiz 8982: deinstallation time, and tells the package where to install
1.107 rillig 8983: GConf data files using some standard configure arguments. It
1.87 wiz 8984: also disallows any access to the database directly from the
8985: package.</p></li>
1.128 ! wiz 8986: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8987: <code class="filename">.schemas</code> files under
8988: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8989: installed under <code class="filename">${PREFIX}/etc</code>, you will
8990: need to manually patch the package.</p></li>
1.128 ! wiz 8991: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8992: directory, as they will be handled automatically. See
1.110 hubertf 8993: <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.128 ! wiz 8994: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8995: your <code class="filename">Makefile</code> with a list of all
8996: <code class="filename">.schemas</code> files installed by the package, if
8997: any. Names must not contain any directories in them.</p></li>
1.128 ! wiz 8998: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8999: your <code class="filename">Makefile</code> with a
9000: list of all <code class="filename">.entries</code> files installed by the
9001: package, if any. Names must not contain any directories in
9002: them.</p></li>
1.75 rillig 9003: </ol></div>
9004: </div>
1.128 ! wiz 9005: <div class="sect2" title="19.6.10. Packages installing scrollkeeper/rarian data files">
1.75 rillig 9006: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 9007: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 9008: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 9009: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 9010: get registered in the database:</p>
1.128 ! wiz 9011: <div class="orderedlist"><ol class="orderedlist" type="1">
! 9012: <li class="listitem"><p>Include
1.119 mishka 9013: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9014: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 9015: takes care of rebuilding the scrollkeeper database at
9016: installation and deinstallation time, and disallows any access
9017: to it directly from the package.</p></li>
1.128 ! wiz 9018: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9019: <code class="filename">libdata/scrollkeeper</code> directory, as they
9020: will be handled automatically.</p></li>
1.128 ! wiz 9021: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 9022: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9023: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 9024: </ol></div>
9025: </div>
1.128 ! wiz 9026: <div class="sect2" title="19.6.11. Packages installing X11 fonts">
1.75 rillig 9027: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9028: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9029: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9030: the fonts database in the directory where they get installed at
9031: installation and deinstallation time. This can be automatically
9032: done by using the pkginstall framework.</p>
1.75 rillig 9033: <p>You can list the directories where fonts are installed in the
1.87 wiz 9034: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9035: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 ! wiz 9036: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.87 wiz 9037: Also make sure that the database file
9038: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9039: <p>Note that you should not create new directories for fonts;
1.87 wiz 9040: instead use the standard ones to avoid that the user needs to
9041: manually configure his X server to find them.</p>
1.75 rillig 9042: </div>
1.128 ! wiz 9043: <div class="sect2" title="19.6.12. Packages installing GTK2 modules">
1.75 rillig 9044: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9045: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9046: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9047: take some extra steps to get them registered in the GTK2 database
9048: properly:</p>
1.128 ! wiz 9049: <div class="orderedlist"><ol class="orderedlist" type="1">
! 9050: <li class="listitem"><p>Include
1.87 wiz 9051: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9052: <code class="filename">buildlink3.mk</code> file. This takes care of
9053: rebuilding the database at installation and deinstallation time.</p></li>
1.128 ! wiz 9054: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 9055: your package installs GTK2 immodules.</p></li>
1.128 ! wiz 9056: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 9057: GTK2 loaders.</p></li>
1.128 ! wiz 9058: <li class="listitem">
1.87 wiz 9059: <p>Patch the package to not touch any of the GTK2
9060: databases directly. These are:</p>
1.128 ! wiz 9061: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 9062: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
! 9063: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9064: </ul></div>
9065: </li>
1.128 ! wiz 9066: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 9067: any entries under the <code class="filename">libdata/gtk-2.0</code>
9068: directory, as they will be handled automatically.</p></li>
1.75 rillig 9069: </ol></div>
9070: </div>
1.128 ! wiz 9071: <div class="sect2" title="19.6.13. Packages installing SGML or XML data">
1.75 rillig 9072: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9073: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9074: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9075: registered in system-wide catalogs (like DTDs, sub-catalogs,
9076: etc.), you need to take some extra steps:</p>
1.128 ! wiz 9077: <div class="orderedlist"><ol class="orderedlist" type="1">
! 9078: <li class="listitem"><p>Include
1.87 wiz 9079: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9080: your <code class="filename">Makefile</code>, which takes care of
9081: registering those files in system-wide catalogs at
9082: installation and deinstallation time.</p></li>
1.128 ! wiz 9083: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9084: any SGML catalogs installed by the package.</p></li>
1.128 ! wiz 9085: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9086: any XML catalogs installed by the package.</p></li>
1.128 ! wiz 9087: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9088: to be added to the SGML catalog. These come in groups of
9089: three strings; see xmlcatmgr(1) for more information
9090: (specifically, arguments recognized by the 'add' action).
9091: Note that you will normally not use this variable.</p></li>
1.128 ! wiz 9092: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9093: to be added to the XML catalog. These come in groups of three
9094: strings; see xmlcatmgr(1) for more information (specifically,
9095: arguments recognized by the 'add' action). Note that you will
9096: normally not use this variable.</p></li>
1.75 rillig 9097: </ol></div>
9098: </div>
1.128 ! wiz 9099: <div class="sect2" title="19.6.14. Packages installing extensions to the MIME database">
1.75 rillig 9100: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9101: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9102: <p>If a package provides extensions to the MIME database by
1.87 wiz 9103: installing <code class="filename">.xml</code> files inside
9104: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9105: need to take some extra steps to ensure that the database is kept
9106: consistent with respect to these new files:</p>
1.128 ! wiz 9107: <div class="orderedlist"><ol class="orderedlist" type="1">
! 9108: <li class="listitem"><p>Include
1.87 wiz 9109: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9110: (avoid using the <code class="filename">buildlink3.mk</code> file from
9111: this same directory, which is reserved for inclusion from
9112: other <code class="filename">buildlink3.mk</code> files). It takes
9113: care of rebuilding the MIME database at installation and
9114: deinstallation time, and disallows any access to it directly
9115: from the package.</p></li>
1.128 ! wiz 9116: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9117: <code class="filename">share/mime</code> directory,
9118: <span class="emphasis"><em>except</em></span> for files saved under
9119: <code class="filename">share/mime/packages</code>. The former are
9120: handled automatically by
9121: the update-mime-database program, but the latter are
9122: package-dependent and must be removed by the package that
9123: installed them in the first place.</p></li>
1.128 ! wiz 9124: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9125: from the PLIST. They will be handled by the shared-mime-info
9126: package.</p></li>
1.75 rillig 9127: </ol></div>
9128: </div>
1.128 ! wiz 9129: <div class="sect2" title="19.6.15. Packages using intltool">
1.75 rillig 9130: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9131: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9132: <p>If a package uses intltool during its build, add
9133: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9134: which forces it to use the intltool package provided by pkgsrc,
9135: instead of the one bundled with the distribution file.</p>
1.75 rillig 9136: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9137: latest available version; this way, the package benefits of any
9138: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9139: </div>
1.128 ! wiz 9140: <div class="sect2" title="19.6.16. Packages installing startup scripts">
1.75 rillig 9141: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9142: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9143: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9144: the startup directory by default, but you can enable it, by adding
9145: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9146: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9147: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9148: it will automatically remove the scripts when the package is
9149: deinstalled.</p>
1.75 rillig 9150: </div>
1.128 ! wiz 9151: <div class="sect2" title="19.6.17. Packages installing TeX modules">
1.75 rillig 9152: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9153: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9154: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9155: the <code class="filename">ls-R</code> database of the tree needs to be
9156: updated.</p>
1.128 ! wiz 9157: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9158: <h3 class="title">Note</h3>
1.125 wiz 9159: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9160: packages should install files
1.125 wiz 9161: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9162: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9163: </div>
1.128 ! wiz 9164: <div class="orderedlist"><ol class="orderedlist" type="1">
! 9165: <li class="listitem"><p>Include
1.125 wiz 9166: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9167: takes care of rebuilding the <code class="filename">ls-R</code>
9168: database at installation and deinstallation time.</p></li>
1.128 ! wiz 9169: <li class="listitem">
1.75 rillig 9170: <p>If your package installs files into a texmf
1.87 wiz 9171: tree other than the one
1.125 wiz 9172: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9173: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9174: trees that need database update.</p>
1.75 rillig 9175: <p>If your package also installs font map files that need
1.110 hubertf 9176: to be registered using <span class="command"><strong>updmap</strong></span>,
1.125 wiz 9177: include <code class="filename">../../print/texlive-tetex/map.mk</code> and
9178: set <code class="varname">TEX_MAP_FILES</code> and/or
9179: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9180: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9181: be run automatically at installation/deinstallation to
9182: enable/disable font map files for TeX output
9183: drivers.</p>
1.75 rillig 9184: </li>
1.128 ! wiz 9185: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9186: databases are included in <code class="filename">PLIST</code>, as
9187: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 9188: </ol></div>
9189: </div>
1.128 ! wiz 9190: <div class="sect2" title="19.6.18. Packages supporting running binaries in emulation">
1.85 jmmv 9191: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9192: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9193: emulation</h3></div></div></div>
9194: <p>There are some packages that provide libraries and
9195: executables for running binaries from a one operating system
9196: on a different one (if the latter supports it). One example
9197: is running Linux binaries on NetBSD.</p>
1.91 rillig 9198: <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 9199: helps in extracting and packaging Linux rpm packages.</p>
9200: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9201: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9202: if all libraries for each installed executable can be found by
9203: the dynamic linker. Since the standard dynamic linker is run,
9204: this fails for emulation packages, because the libraries used
9205: by the emulation are not in the standard directories.</p>
9206: </div>
1.128 ! wiz 9207: <div class="sect2" title="19.6.19. Packages installing hicolor theme icons">
1.87 wiz 9208: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9209: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9210: <p>If a package installs images under the
1.87 wiz 9211: <code class="filename">share/icons/hicolor</code> and/or updates the
9212: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9213: database, you need to take some extra steps to make sure that the
9214: shared theme directory is handled appropriately and that the cache
9215: database is rebuilt:</p>
1.128 ! wiz 9216: <div class="orderedlist"><ol class="orderedlist" type="1">
! 9217: <li class="listitem"><p>Include
1.87 wiz 9218: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 ! wiz 9219: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9220: entry that refers to the theme cache.</p></li>
1.128 ! wiz 9221: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9222: directories from the <code class="filename">share/icons/hicolor</code>
9223: hierarchy because they will be handled automatically.</p></li>
9224: </ol></div>
9225: <p>The best way to verify that the PLIST is correct with
9226: respect to the last two points is to regenerate it using
1.110 hubertf 9227: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9228: </div>
1.128 ! wiz 9229: <div class="sect2" title="19.6.20. Packages installing desktop files">
1.85 jmmv 9230: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9231: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9232: <p>If a package installs <code class="filename">.desktop</code> files
9233: under <code class="filename">share/applications</code> and these include
9234: MIME information, you need to take extra steps to ensure that they
9235: are registered into the MIME database:</p>
1.128 ! wiz 9236: <div class="orderedlist"><ol class="orderedlist" type="1">
! 9237: <li class="listitem"><p>Include
1.85 jmmv 9238: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 ! wiz 9239: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9240: <code class="filename">share/applications/mimeinfo.cache</code> file.
9241: It will be handled automatically.</p></li>
9242: </ol></div>
9243: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9244: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9245: print-PLIST</strong></span>.</p>
1.75 rillig 9246: </div>
9247: </div>
1.128 ! wiz 9248: <div class="sect1" title="19.7. Marking packages as having problems">
1.87 wiz 9249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9250: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9251: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9252: immediately. In this case, one can plainly mark a package as broken. For
9253: this, one just sets the variable <code class="varname">BROKEN</code> to the
9254: reason why the package is broken (similar to the
9255: <code class="varname">RESTRICTED</code> variable). A user trying to build
9256: the package will immediately be shown this message, and the build
9257: will not be even tried.</p>
9258: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9259: intervals.</p>
9260: </div>
1.75 rillig 9261: </div>
1.128 ! wiz 9262: <div class="chapter" title="Chapter 20. Debugging">
1.75 rillig 9263: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9264: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9265: <p>To check out all the gotchas when building a package, here are
9266: the steps that I do in order to get a package working. Please note
9267: this is basically the same as what was explained in the previous
9268: sections, only with some debugging aids.</p>
1.128 ! wiz 9269: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 9270: <li class="listitem"><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
! 9271: <li class="listitem">
1.91 rillig 9272: <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 9273: create a directory for a new package, change into it, then run
1.110 hubertf 9274: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9275: <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>
9276: <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>
9277: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9278: </li>
1.128 ! wiz 9279: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
! 9280: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
! 9281: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
! 9282: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9283: configure step to the package's
9284: <code class="filename">Makefile</code>.</p></li>
1.128 ! wiz 9285: <li class="listitem">
1.75 rillig 9286: <p>Make the package compile, doing multiple rounds of</p>
9287: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9288: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9289: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9290: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9291: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9292: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9293: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9294: <p>Doing this step as non-root user will ensure that no files
9295: are modified that shouldn't be, especially during the build
1.110 hubertf 9296: phase. <span class="command"><strong>mkpatches</strong></span>,
9297: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91 rillig 9298: 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 9299: package.</p>
1.75 rillig 9300: </li>
1.128 ! wiz 9301: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
! 9302: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
! 9303: <li class="listitem">
1.76 rillig 9304: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9305: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9306: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9307: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9308: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9309: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9310: <p>You usually need to be <code class="username">root</code> to do
9311: this. Look if there are any files left:</p>
1.75 rillig 9312: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9313: <p>If this reveals any files that are missing in
1.88 wiz 9314: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9315: </li>
1.128 ! wiz 9316: <li class="listitem">
1.88 wiz 9317: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9318: package again and make a binary package:</p>
1.75 rillig 9319: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9320: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9321: </li>
1.128 ! wiz 9322: <li class="listitem">
1.75 rillig 9323: <p>Delete the installed package:</p>
1.88 wiz 9324: <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 9325: </li>
1.128 ! wiz 9326: <li class="listitem">
1.110 hubertf 9327: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9328: command, which shouldn't find anything now:</p>
1.75 rillig 9329: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9330: </li>
1.128 ! wiz 9331: <li class="listitem">
1.75 rillig 9332: <p>Reinstall the binary package:</p>
1.93 rillig 9333: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75 rillig 9334: </li>
1.128 ! wiz 9335: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
! 9336: <li class="listitem">
1.110 hubertf 9337: <p>Run <span class="command"><strong>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 9338: reports:</p>
1.75 rillig 9339: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9340: </li>
1.128 ! wiz 9341: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.75 rillig 9342: </ul></div>
9343: </div>
1.128 ! wiz 9344: <div class="chapter" title="Chapter 21. Submitting and Committing">
1.75 rillig 9345: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9346: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9347: <div class="toc">
9348: <p><b>Table of Contents</b></p>
9349: <dl>
1.106 rillig 9350: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9351: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9352: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9353: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9354: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9355: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9356: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9357: </dl>
9358: </div>
1.128 ! wiz 9359: <div class="sect1" title="21.1. Submitting binary packages">
1.75 rillig 9360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9361: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9362: <p>Our policy is that we accept binaries only from pkgsrc
9363: developers to guarantee that the packages don't contain any
9364: trojan horses etc. This is not to annoy anyone but rather to
9365: protect our users! You're still free to put up your home-made
9366: binary packages and tell the world where to get them. NetBSD
9367: developers doing bulk builds and wanting to upload them please
1.110 hubertf 9368: see <a class="xref" href="#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, “Uploading results of a bulk build”</a>.</p>
1.75 rillig 9369: </div>
1.128 ! wiz 9370: <div class="sect1" title="21.2. Submitting source packages (for non-NetBSD-developers)">
1.75 rillig 9371: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9372: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9373: <p>First, check that your package is complete, compiles and
1.110 hubertf 9374: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
9375: document. Next, generate an uuencoded gzipped <a class="citerefentry" 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 9376: archive that contains all files that make up the package.
1.87 wiz 9377: Finally, send this package to the pkgsrc bug tracking system,
1.110 hubertf 9378: either with the <a class="citerefentry" 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
1.87 wiz 9379: that, go to the web page
1.110 hubertf 9380: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124 snj 9381: which contains some instructions and a link to a form where you
9382: can submit packages. The
9383: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
9384: also available as a substitute for either of the above two tools.
9385: </p>
1.87 wiz 9386: <p>In the form of the problem report, the category should be
1.128 ! wiz 9387: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9388: and version number, and the description field should contain a
9389: short description of your package (contents of the COMMENT
9390: variable or DESCR file are OK). The uuencoded package data should
1.128 ! wiz 9391: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9392: <p>If you want to submit several packages, please send a
9393: separate PR for each one, it's easier for us to track things
9394: that way.</p>
9395: <p>Alternatively, you can also import new packages into
1.128 ! wiz 9396: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9397: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9398: for details.</p>
9399: </div>
1.128 ! wiz 9400: <div class="sect1" title="21.3. General notes when adding, updating, or removing packages">
1.75 rillig 9401: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9402: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9403: <p>Please note all package additions, updates, moves, and
1.93 rillig 9404: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9405: important to keep this file up to date and conforming to the
9406: existing format, because it will be used by scripts to
1.110 hubertf 9407: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9408: sites. Additionally, check the
1.76 rillig 9409: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9410: for the package you updated or removed, in case it was mentioned
9411: there.</p>
9412: <p>When the <code class="varname">PKGREVISION</code> of a package is
9413: bumped, the change should appear in
1.93 rillig 9414: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9415: related or otherwise relevant. Mass bumps that result from a
9416: dependency being updated should not be mentioned. In all other
9417: cases it's the developer's decision.</p>
9418: <p>There is a make target that helps in creating proper
1.110 hubertf 9419: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9420: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9421: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9422: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9423: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9424: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9425: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9426: For new packages, or package moves or removals, set the
9427: <code class="varname">CTYPE</code> variable on the command line to "Added",
9428: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9429: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9430: not the same as your NetBSD login name. The target also automatically
9431: removes possibly existing entries for the package in the
9432: <code class="filename">TODO</code> file. Don't forget to commit
9433: the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
1.126 jakllsch 9434: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9435: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9436: makes the cvs commands use the main repository.
9437: </p>
1.75 rillig 9438: </div>
1.128 ! wiz 9439: <div class="sect1" title="21.4. Committing: Importing a package into CVS">
1.75 rillig 9440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9441: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9442: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9443: access to the pkgsrc repository. Please remember that cvs
9444: imports files relative to the current working directory, and that
9445: the pathname that you
1.110 hubertf 9446: give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75 rillig 9447: to place the files in the repository. Newly created packages should be
1.128 ! wiz 9448: imported with a vendor tag of <span class="quote">“<span class="quote">TNF</span>”</span> and a release tag of
! 9449: <span class="quote">“<span class="quote">pkgsrc-base</span>”</span>, e.g:</p>
1.75 rillig 9450: <pre class="programlisting">
1.100 rillig 9451: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9452: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75 rillig 9453: </pre>
1.87 wiz 9454: <p>Remember to move the directory from which you imported out of
1.128 ! wiz 9455: the way, or cvs will complain the next time you <span class="quote">“<span class="quote">cvs
! 9456: update</span>”</span> your source tree. Also don't forget to add the new
1.87 wiz 9457: package to the category's <code class="filename">Makefile</code>.</p>
9458: <p>The commit message of the initial import should include part of the
1.76 rillig 9459: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9460: what the package is/does.</p>
1.128 ! wiz 9461: <p>For new packages, <span class="quote">“<span class="quote">cvs import</span>”</span> is preferred to <span class="quote">“<span class="quote">cvs
! 9462: add</span>”</span> because the former gets everything with a single command,
1.87 wiz 9463: and provides a consistent tag.</p>
1.75 rillig 9464: </div>
1.128 ! wiz 9465: <div class="sect1" title="21.5. Updating a package to a newer version">
1.75 rillig 9466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9467: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9468: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9469: changes between old and new versions into the commit log when updating
1.87 wiz 9470: a package. There are various reasons for this:</p>
1.128 ! wiz 9471: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 9472: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9473: or its information may be overwritten by newer information.</p></li>
1.128 ! wiz 9474: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9475: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 ! wiz 9476: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9477: repository is very useful for people who read the pkgsrc-changes mailing
9478: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9479: the package.</p></li>
1.75 rillig 9480: </ul></div>
1.87 wiz 9481: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9482: has been released, it should not automatically be upgraded in the CVS
9483: repository. We prefer to be conservative in the packages that are
9484: included in pkgsrc - development or beta packages are not really the
9485: best thing for most places in which pkgsrc is used. Please use your
9486: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9487: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9488: </div>
1.128 ! wiz 9489: <div class="sect1" title="21.6. Renaming a package in pkgsrc">
1.75 rillig 9490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9491: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9492: <p>Renaming packages is not recommended.</p>
9493: <p>When renaming packages, be sure to fix any references to old name
9494: in other Makefiles, options, buildlink files, etc.</p>
9495: <p>Also When renaming a package, please define
9496: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9497: pattern(s) of the previous package name.
9498: This may be repeated for multiple renames.
9499: The new package would be an exact replacement.
9500: </p>
1.128 ! wiz 9501: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9502: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9503: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9504: not be an exact replacement but is a suggestion for the replaced
9505: functionality.</p>
9506: </div>
1.128 ! wiz 9507: <div class="sect1" title="21.7. Moving a package in pkgsrc">
1.122 reed 9508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9509: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9510: <p>It is preferred that packages are not renamed or moved, but if needed
9511: please follow these steps.
9512: </p>
1.128 ! wiz 9513: <div class="orderedlist"><ol class="orderedlist" type="1">
! 9514: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
! 9515: <li class="listitem">
1.75 rillig 9516: <p>Remove all CVS dirs.</p>
1.87 wiz 9517: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9518: <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 9519: <p>and use that for further work.</p>
1.75 rillig 9520: </li>
1.128 ! wiz 9521: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
! 9522: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
! 9523: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
! 9524: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9525: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9526: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9527: for doing an update using pkgsrc building; for example, it can
9528: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
9529: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9530: new <code class="varname">PKGPATH</code> for that moved package. Note that
9531: it may have multiple matches, so the tool should also check on the
9532: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9533: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9534: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 ! wiz 9535: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9536: place.</p></li>
1.128 ! wiz 9537: <li class="listitem">
1.75 rillig 9538: <p>Check if any package depends on it:
9539: </p>
9540: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9541: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9542: </li>
1.128 ! wiz 9543: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
! 9544: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
! 9545: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
! 9546: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
! 9547: <li class="listitem">
1.75 rillig 9548: <p>Commit the changed and removed files:</p>
9549: <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 9550: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9551: </li>
9552: </ol></div>
9553: </div>
9554: </div>
1.128 ! wiz 9555: <div class="chapter" title="Chapter 22. Frequently Asked Questions">
1.75 rillig 9556: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9557: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9558: <p>This section contains the answers to questions that may
9559: arise when you are writing a package. If you don't find your
9560: question answered here, first have a look in the other chapters,
9561: and if you still don't have the answer, ask on the
9562: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.128 ! wiz 9563: <div class="qandaset" title="Frequently Asked Questions">
! 9564: <a name="id1168230172474"></a><dl>
1.106 rillig 9565: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9566: MAKEFLAGS, .MAKEFLAGS and
9567: MAKE_FLAGS?</a>
9568: </dt>
1.106 rillig 9569: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9570: MAKE, GMAKE and
9571: MAKE_PROGRAM?</a>
9572: </dt>
1.106 rillig 9573: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9574: CC, PKG_CC and
9575: PKGSRC_COMPILER?</a>
9576: </dt>
1.106 rillig 9577: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9578: BUILDLINK_LDFLAGS,
9579: BUILDLINK_LDADD and
9580: BUILDLINK_LIBS?</a>
9581: </dt>
1.106 rillig 9582: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9583: VARNAME=BUILDLINK_PREFIX.foo
9584: say it's empty?</a>
9585: </dt>
1.106 rillig 9586: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9587: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9588: don't understand the := inside
9589: it.</a>
9590: </dt>
1.106 rillig 9591: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9592: developers?</a>
9593: </dt>
1.106 rillig 9594: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9595: documentation?</a>
9596: </dt>
1.106 rillig 9597: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9598: do?</a>
9599: </dt>
1.75 rillig 9600: </dl>
1.128 ! wiz 9601: <table border="0" width="100%" summary="Q and A Set">
1.75 rillig 9602: <col align="left" width="1%">
1.128 ! wiz 9603: <col>
1.75 rillig 9604: <tbody>
1.128 ! wiz 9605: <tr class="question" title="22.1.">
1.75 rillig 9606: <td align="left" valign="top">
1.128 ! wiz 9607: <a name="devfaq.makeflags"></a><a name="id1168230172477"></a><p><b>22.1.</b></p>
1.75 rillig 9608: </td>
9609: <td align="left" valign="top"><p>What is the difference between
9610: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9611: <code class="varname">MAKE_FLAGS</code>?</p></td>
9612: </tr>
9613: <tr class="answer">
1.91 rillig 9614: <td align="left" valign="top"></td>
1.75 rillig 9615: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110 hubertf 9616: to the pkgsrc-internal invocations of <a class="citerefentry" 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
1.75 rillig 9617: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9618: the <code class="varname">MAKE_PROGRAM</code> when building the
9619: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9620: </tr>
1.128 ! wiz 9621: <tr class="question" title="22.2.">
1.75 rillig 9622: <td align="left" valign="top">
1.128 ! wiz 9623: <a name="devfaq.make"></a><a name="id1168230172512"></a><p><b>22.2.</b></p>
1.75 rillig 9624: </td>
9625: <td align="left" valign="top"><p>What is the difference between
9626: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9627: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9628: </tr>
9629: <tr class="answer">
1.91 rillig 9630: <td align="left" valign="top"></td>
1.75 rillig 9631: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110 hubertf 9632: <a class="citerefentry" 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
1.75 rillig 9633: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9634: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9635: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9636: Make program that is used for building the
9637: package.</p></td>
9638: </tr>
1.128 ! wiz 9639: <tr class="question" title="22.3.">
1.75 rillig 9640: <td align="left" valign="top">
1.128 ! wiz 9641: <a name="devfaq.cc"></a><a name="id1168230172548"></a><p><b>22.3.</b></p>
1.75 rillig 9642: </td>
9643: <td align="left" valign="top"><p>What is the difference between
9644: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9645: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9646: </tr>
9647: <tr class="answer">
1.91 rillig 9648: <td align="left" valign="top"></td>
1.75 rillig 9649: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9650: compiler, which can be configured by the pkgsrc user.
9651: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9652: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9653: path to a compiler, but the type of compiler that should be
1.76 rillig 9654: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9655: information about the latter variable.</p></td>
9656: </tr>
1.128 ! wiz 9657: <tr class="question" title="22.4.">
1.75 rillig 9658: <td align="left" valign="top">
1.128 ! wiz 9659: <a name="devfaq.bl3flags"></a><a name="id1168230172583"></a><p><b>22.4.</b></p>
1.75 rillig 9660: </td>
9661: <td align="left" valign="top"><p>What is the difference between
9662: <code class="varname">BUILDLINK_LDFLAGS</code>,
9663: <code class="varname">BUILDLINK_LDADD</code> and
9664: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9665: </tr>
9666: <tr class="answer">
1.91 rillig 9667: <td align="left" valign="top"></td>
1.75 rillig 9668: <td align="left" valign="top"><p>[FIXME]</p></td>
9669: </tr>
1.128 ! wiz 9670: <tr class="question" title="22.5.">
1.75 rillig 9671: <td align="left" valign="top">
1.128 ! wiz 9672: <a name="devfaq.bl3prefix"></a><a name="id1168230172601"></a><p><b>22.5.</b></p>
1.75 rillig 9673: </td>
1.110 hubertf 9674: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9675: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9676: say it's empty?</p></td>
9677: </tr>
9678: <tr class="answer">
1.91 rillig 9679: <td align="left" valign="top"></td>
1.75 rillig 9680: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 ! wiz 9681: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
! 9682: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9683: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9684: command.</p></td>
9685: </tr>
1.128 ! wiz 9686: <tr class="question" title="22.6.">
1.78 rillig 9687: <td align="left" valign="top">
1.128 ! wiz 9688: <a name="devfaq.master_sites"></a><a name="id1168230172627"></a><p><b>22.6.</b></p>
1.78 rillig 9689: </td>
9690: <td align="left" valign="top"><p>What does
9691: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9692: don't understand the <code class="literal">:=</code> inside
9693: it.</p></td>
9694: </tr>
9695: <tr class="answer">
1.91 rillig 9696: <td align="left" valign="top"></td>
1.78 rillig 9697: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9698: assignment operator, like you might expect at first sight.
9699: Instead, it is a degenerate form of
9700: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110 hubertf 9701: which is documented in the <a class="citerefentry" 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
1.78 rillig 9702: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9703: case of <code class="varname">MASTER_SITE_*</code>,
9704: <em class="replaceable"><code>old_string</code></em> is the empty string and
9705: <em class="replaceable"><code>new_string</code></em> is
9706: <code class="literal">package/</code>. That's where the
9707: <code class="literal">:</code> and the <code class="literal">=</code> fall
9708: together.</p></td>
9709: </tr>
1.128 ! wiz 9710: <tr class="question" title="22.7.">
1.78 rillig 9711: <td align="left" valign="top">
1.128 ! wiz 9712: <a name="devfaq.mailinglists"></a><a name="id1168230172694"></a><p><b>22.7.</b></p>
1.78 rillig 9713: </td>
9714: <td align="left" valign="top"><p>Which mailing lists are there for package
9715: developers?</p></td>
9716: </tr>
9717: <tr class="answer">
1.91 rillig 9718: <td align="left" valign="top"></td>
1.78 rillig 9719: <td align="left" valign="top"><div class="variablelist"><dl>
1.110 hubertf 9720: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78 rillig 9721: <dd><p>This is a list for technical discussions related
9722: to pkgsrc development, e.g. soliciting feedback for changes to
9723: pkgsrc infrastructure, proposed new features, questions related
9724: to porting pkgsrc to a new platform, advice for maintaining a
9725: package, patches that affect many packages, help requests moved
9726: from pkgsrc-users when an infrastructure bug is found,
9727: etc.</p></dd>
1.110 hubertf 9728: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78 rillig 9729: <dd><p>All bug reports in category "pkg" sent with
1.110 hubertf 9730: <a class="citerefentry" 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
1.78 rillig 9731: directly; use one of the other mailing
9732: lists.</p></dd>
9733: </dl></div></td>
9734: </tr>
1.128 ! wiz 9735: <tr class="question" title="22.8.">
1.80 rillig 9736: <td align="left" valign="top">
1.128 ! wiz 9737: <a name="devfaq.documentation"></a><a name="id1168230172726"></a><p><b>22.8.</b></p>
1.80 rillig 9738: </td>
9739: <td align="left" valign="top"><p>Where is the pkgsrc
9740: documentation?</p></td>
9741: </tr>
9742: <tr class="answer">
1.91 rillig 9743: <td align="left" valign="top"></td>
1.80 rillig 9744: <td align="left" valign="top">
9745: <p>There are many places where you can find
9746: documentation about pkgsrc:</p>
1.128 ! wiz 9747: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 9748: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9749: of chapters that explain large parts of pkgsrc, but some
9750: chapters tend to be outdated. Which ones they are is hard to
9751: say.</p></li>
1.128 ! wiz 9752: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.80 rillig 9753: about certain features, announcements of new parts of the pkgsrc
9754: infrastructure and sometimes even announcements that a certain
9755: feature has been marked as obsolete. The benefit here is that
9756: each message has a date appended to it.</p></li>
1.128 ! wiz 9757: <li class="listitem"><p>Many of the files in the
1.80 rillig 9758: <code class="filename">mk/</code> directory start with a comment that
9759: describes the purpose of the file and how it can be used by the
1.92 rillig 9760: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9761: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9762: help</strong></span>.</p></li>
1.128 ! wiz 9763: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9764: information, but they tend to be highly abbreviated, especially
9765: for actions that occur often. Some contain a detailed
9766: description of what has changed, but they are geared towards the
9767: other pkgsrc developers, not towards an average pkgsrc user.
9768: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9769: don't know what has been before, these messages may not be worth
9770: too much to you.</p></li>
1.128 ! wiz 9771: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
! 9772: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9773: mind of the developer who wrote the code. To get this
1.110 hubertf 9774: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9775: to see who has written it and ask on the
9776: <code class="literal">tech-pkg</code> mailing list, so that others can
9777: find your questions later (see above). To be sure that the
9778: developer in charge reads the mail, you may CC him or
9779: her.</p></li>
9780: </ul></div>
9781: </td>
9782: </tr>
1.128 ! wiz 9783: <tr class="question" title="22.9.">
1.92 rillig 9784: <td align="left" valign="top">
1.128 ! wiz 9785: <a name="devfaq.too-much-time"></a><a name="id1168230172780"></a><p><b>22.9.</b></p>
1.92 rillig 9786: </td>
9787: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9788: do?</p></td>
9789: </tr>
9790: <tr class="answer">
9791: <td align="left" valign="top"></td>
9792: <td align="left" valign="top">
1.93 rillig 9793: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9794: anyway.</p>
1.128 ! wiz 9795: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 9796: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92 rillig 9797: <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
9798: will tell you about newer versions of installed packages that are
9799: available, but not yet updated in pkgsrc.</p></li>
1.128 ! wiz 9800: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9801: — it contains a list of suggested new packages and a list of
1.92 rillig 9802: cleanups and enhancements for pkgsrc that would be nice to
9803: have.</p></li>
1.128 ! wiz 9804: <li class="listitem"><p>Review packages for which review was requested on
1.110 hubertf 9805: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92 rillig 9806: mailing list.</p></li>
9807: </ul></div>
9808: </td>
9809: </tr>
1.75 rillig 9810: </tbody>
9811: </table>
9812: </div>
9813: </div>
1.128 ! wiz 9814: <div class="chapter" title="Chapter 23. GNOME packaging and porting">
1.85 jmmv 9815: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9816: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9817: <div class="toc">
9818: <p><b>Table of Contents</b></p>
9819: <dl>
1.106 rillig 9820: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9821: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9822: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9823: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9824: </dl>
9825: </div>
1.110 hubertf 9826: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9827: site</a>:</p>
9828: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9829: environment, an intuitive and attractive desktop for users, and the
9830: GNOME development platform, an extensive framework for building
9831: applications that integrate into the rest of the desktop.</p></blockquote></div>
9832: <p>pkgsrc provides a seamless way to automatically build and install
9833: a complete GNOME environment <span class="emphasis"><em>under many different
9834: platforms</em></span>. We can say with confidence that pkgsrc is one of
9835: the most advanced build and packaging systems for GNOME due to its
9836: included technologies buildlink3, the wrappers and tools framework and
9837: automatic configuration file management. Lots of efforts are put into
9838: achieving a completely clean deinstallation of installed software
9839: components.</p>
1.110 hubertf 9840: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9841: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9842: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9843: pkgsrc as its preferred packaging system, contributing lots of
9844: portability fixes to make GNOME build and install under it.</p>
9845: <p>This chapter is aimed at pkgsrc developers and other people
9846: interested in helping our GNOME porting and packaging efforts. It
9847: provides instructions on how to manage the existing packages and some
9848: important information regarding their internals.</p>
1.128 ! wiz 9849: <div class="note" title="We need your help!" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9850: <h3 class="title">We need your help!</h3>
9851: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9852: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9853: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9854: work</a> list! There is still a long way to go to get a
9855: fully-functional GNOME desktop under NetBSD and we need your help to
9856: achieve it!</p>
9857: </div>
1.128 ! wiz 9858: <div class="sect1" title="23.1. Meta packages">
1.85 jmmv 9859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9860: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9861: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.128 ! wiz 9862: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 9863: <li class="listitem"><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 9864: the core GNOME desktop environment. It only includes the necessary
9865: bits to get it to boot correctly, although it may lack important
9866: functionality for daily operation. The idea behind this package is
9867: to let end users build their own configurations on top of this one,
9868: first installing this meta package to achieve a functional setup and
9869: then adding individual applications.</p></li>
1.128 ! wiz 9870: <li class="listitem"><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 9871: complete installation of the GNOME platform and desktop as defined
9872: by the GNOME project; this is based on the components distributed in
9873: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9874: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9875: official FTP server. Developer-only tools found in those
9876: directories are not installed unless required by some other
9877: component to work properly. Similarly, packages from the bindings
9878: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9879: in unless required as a dependency for an end-user component. This
1.91 rillig 9880: 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>
1.128 ! wiz 9881: <li class="listitem"><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 9882: Installs all the tools required to build a GNOME component when
9883: fetched from the CVS repository. These are required to let the
1.110 hubertf 9884: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9885: </ul></div>
9886: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9887: sorted in a way that eases updates: a package may depend on other
9888: packages listed before it but not on any listed after it. It is very
9889: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9890: change it to alphabetical sorting!</em></span></p>
9891: </div>
1.128 ! wiz 9892: <div class="sect1" title="23.2. Packaging a GNOME application">
1.85 jmmv 9893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9894: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9895: <p>Almost all GNOME applications are written in C and use a common
9896: set of tools as their build system. Things get different with the new
9897: bindings to other languages (such as Python), but the following will
9898: give you a general idea on the minimum required tools:</p>
1.128 ! wiz 9899: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 9900: <li class="listitem">
1.85 jmmv 9901: <p>Almost all GNOME applications use the GNU Autotools as their
9902: build system. As a general rule you will need to tell this to your
9903: package:</p>
1.100 rillig 9904: <pre class="programlisting">
9905: GNU_CONFIGURE=yes
1.85 jmmv 9906: USE_LIBTOOL=yes
1.100 rillig 9907: USE_TOOLS+=gmake
9908: </pre>
1.85 jmmv 9909: </li>
1.128 ! wiz 9910: <li class="listitem">
1.85 jmmv 9911: <p>If the package uses pkg-config to detect dependencies, add this
9912: tool to the list of required utilities:</p>
9913: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9914: <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 9915: the end of the build process to ensure that you did not miss to
9916: specify any dependency in your package and that the version
9917: requirements are all correct.</p>
9918: </li>
1.128 ! wiz 9919: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9920: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9921: to handle dependencies and to force the package to use the latest
9922: available version.</p></li>
1.128 ! wiz 9923: <li class="listitem">
1.85 jmmv 9924: <p>If the package uses gtk-doc (a documentation generation
9925: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9926: tool is rather big and the distfile should come with pregenerated
9927: documentation anyway; if it does not, it is a bug that you ought to
9928: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9929: the default):</p>
9930: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9931: <p>The default location of installed HTML files
9932: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9933: and should not be changed unless the package insists on installing
9934: them somewhere else. Otherwise programs as
1.110 hubertf 9935: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9936: do that with an entry similar to:</p>
9937: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9938: </li>
9939: </ul></div>
9940: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9941: files under the installation prefix to maintain databases. In this
9942: context, shared means that those exact same directories and files are
9943: used among several different packages, leading to conflicts in the
9944: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9945: handle the most common cases, so you have to forget about using
9946: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9947: omitting shared files from them. If you find yourself doing those,
9948: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9949: <p>The following table lists the common situations that result in
9950: using shared directories or files. For each of them, the appropriate
9951: solution is given. After applying the solution be sure to
9952: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9953: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9954: <div class="table">
1.106 rillig 9955: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9956: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9957: <colgroup>
9958: <col>
9959: <col>
9960: </colgroup>
9961: <thead><tr>
9962: <th>If the package...</th>
9963: <th>Then...</th>
9964: </tr></thead>
9965: <tbody>
9966: <tr>
9967: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9968: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
1.85 jmmv 9969: </tr>
9970: <tr>
9971: <td>Installs icons under the
9972: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9973: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9974: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.85 jmmv 9975: </tr>
9976: <tr>
9977: <td>Installs files under
9978: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9979: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.85 jmmv 9980: </tr>
9981: <tr>
9982: <td>Installs <code class="filename">.desktop</code> files under
9983: <code class="filename">share/applications</code> and these include MIME
9984: information.</td>
1.110 hubertf 9985: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, “Packages installing desktop files”</a>.</td>
1.85 jmmv 9986: </tr>
9987: </tbody>
1.91 rillig 9988: </table></div>
1.85 jmmv 9989: </div>
1.91 rillig 9990: <br class="table-break">
1.85 jmmv 9991: </div>
1.128 ! wiz 9992: <div class="sect1" title="23.3. Updating GNOME to a newer version">
1.85 jmmv 9993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9994: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9995: <p>When seeing GNOME as a whole, there are two kinds of
9996: updates:</p>
9997: <div class="variablelist"><dl>
9998: <dt><span class="term">Major update</span></dt>
9999: <dd>
10000: <p>Given that there is still a very long way for GNOME 3 (if it
10001: ever appears), we consider a major update one that goes from a
10002: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10003: where <code class="literal">Y</code> is even and greater than
10004: <code class="literal">X</code>. These are hard to achieve because they
10005: introduce lots of changes in the components' code and almost all
10006: GNOME distfiles are updated to newer versions. Some of them can
10007: even break API and ABI compatibility with the previous major
10008: version series. As a result, the update needs to be done all at
10009: once to minimize breakage.</p>
10010: <p>A major update typically consists of around 80 package
10011: updates and the addition of some new ones.</p>
10012: </dd>
10013: <dt><span class="term">Minor update</span></dt>
10014: <dd>
10015: <p>We consider a minor update one that goes from a
10016: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10017: one where <code class="literal">Y</code> is greater than
10018: <code class="literal">X</code>. These are easy to achieve because they do
10019: not update all GNOME components, can be done in an incremental way
10020: and do not break API nor ABI compatibility.</p>
10021: <p>A minor update typically consists of around 50 package
10022: updates, although the numbers here may vary a lot.</p>
10023: </dd>
10024: </dl></div>
10025: <p>In order to update the GNOME components in pkgsrc to a new stable
10026: release (either major or minor), the following steps should be
10027: followed:</p>
1.128 ! wiz 10028: <div class="orderedlist"><ol class="orderedlist" type="1">
! 10029: <li class="listitem">
1.85 jmmv 10030: <p>Get a list of all the tarballs that form the new release by
10031: using the following commands. These will leave the full list of the
1.120 snj 10032: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 10033: file:</p>
1.88 wiz 10034: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10035: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10036: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 10037: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10038: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10039: awk '{ print $9 }' >>list.txt</code></strong></pre>
10040: </li>
1.128 ! wiz 10041: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 10042: bump their version to the release you are updating them to. The
10043: three meta packages should be always consistent with versioning.
10044: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10045: in them.</p></li>
1.128 ! wiz 10046: <li class="listitem">
1.85 jmmv 10047: <p>For each meta package, update all its
10048: <code class="varname">DEPENDS</code> lines to match the latest versions as
10049: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10050: newer version (even if found in the FTP) because the meta packages
10051: are supposed to list the exact versions that form a specific GNOME
10052: release. Exceptions are permitted here if a newer version solves a
10053: serious issue in the overall desktop experience; these typically
10054: come in the form of a revision bump in pkgsrc, not in newer versions
10055: from the developers.</p>
10056: <p>Packages not listed in the <code class="filename">list.txt</code> file
10057: should be updated to the latest version available (if found in
10058: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 10059: 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 10060: </li>
1.128 ! wiz 10061: <li class="listitem">
1.85 jmmv 10062: <p>Generate a patch from the modified meta packages and extract the
10063: list of "new" lines. This will provide you an outline on what
10064: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10065: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.85 jmmv 10066: </li>
1.128 ! wiz 10067: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 10068: installed packages and start over from scratch at this point.</p></li>
1.128 ! wiz 10069: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 10070: of <code class="filename">todo.txt</code> and update the packages listed in
10071: it in order. For major desktop updates none of these should be
1.93 rillig 10072: committed until the entire set is completed because there are chances
1.85 jmmv 10073: of breaking not-yet-updated packages.</p></li>
1.128 ! wiz 10074: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 10075: the tree one by one with appropriate log messages. At the end,
10076: commit the three meta package updates and all the corresponding
10077: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10078: <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>
10079: </ol></div>
10080: </div>
1.128 ! wiz 10081: <div class="sect1" title="23.4. Patching guidelines">
1.85 jmmv 10082: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10083: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10084: <p>GNOME is a very big component in pkgsrc which approaches 100
10085: packages. Please, it is very important that you always, always,
10086: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10087: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, “Feedback to the author”</a>). This is the only way to get
1.85 jmmv 10088: their attention on portability issues and to ensure that future versions
10089: can be built out-of-the box on NetBSD. The less custom patches in
10090: pkgsrc, the easier further updates are. Those developers in charge of
10091: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10092: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85 jmmv 10093: Bugzilla</a>. Not all components use these to track bugs, but most
10094: of them do. Do not be short on your reports: always provide detailed
10095: explanations of the current failure, how it can be improved to achieve
10096: maximum portability and, if at all possible, provide a patch against CVS
10097: head. The more verbose you are, the higher chances of your patch being
10098: accepted.</p>
10099: <p>Also, please avoid using preprocessor magic to fix portability
10100: issues. While the FreeBSD GNOME people are doing a great job in porting
10101: GNOME to their operating system, the official GNOME sources are now
10102: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10103: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10104: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 10105: details.</p>
10106: </div>
10107: </div>
1.75 rillig 10108: </div>
1.128 ! wiz 10109: <div class="part" title="Part III. The pkgsrc infrastructure internals">
1.75 rillig 10110: <div class="titlepage"><div><div><h1 class="title">
10111: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.128 ! wiz 10112: <div class="partintro" title="The pkgsrc infrastructure internals">
1.75 rillig 10113: <div></div>
10114: <p>This part of the guide deals with everything
10115: from the infrastructure that is behind the interfaces described
10116: in the developer's guide. A casual package maintainer should not
10117: need anything from this part.</p>
10118: <div class="toc">
10119: <p><b>Table of Contents</b></p>
10120: <dl>
1.106 rillig 10121: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10122: <dd><dl>
1.106 rillig 10123: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10124: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10125: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10126: <dd><dl>
1.106 rillig 10127: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10128: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10129: </dl></dd>
1.106 rillig 10130: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10131: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10132: <dd><dl>
1.106 rillig 10133: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10134: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 10135: </dl></dd>
1.106 rillig 10136: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10137: <dd><dl>
1.128 ! wiz 10138: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
! 10139: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10140: </dl></dd>
10141: </dl></dd>
1.106 rillig 10142: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10143: <dd><dl>
1.106 rillig 10144: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10145: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10146: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10147: <dd><dl>
1.106 rillig 10148: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10149: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10150: </dl></dd>
10151: </dl></dd>
1.106 rillig 10152: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10153: <dd><dl>
1.106 rillig 10154: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10155: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10156: </dl></dd>
10157: </dl>
10158: </div>
10159: </div>
1.128 ! wiz 10160: <div class="chapter" title="Chapter 24. Design of the pkgsrc infrastructure">
1.75 rillig 10161: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10162: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10163: <div class="toc">
10164: <p><b>Table of Contents</b></p>
10165: <dl>
1.106 rillig 10166: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10167: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10168: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10169: <dd><dl>
1.106 rillig 10170: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10171: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10172: </dl></dd>
1.106 rillig 10173: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10174: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10175: <dd><dl>
1.106 rillig 10176: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10177: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 10178: </dl></dd>
1.106 rillig 10179: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10180: <dd><dl>
1.128 ! wiz 10181: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
! 10182: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10183: </dl></dd>
10184: </dl>
10185: </div>
10186: <p>The pkgsrc infrastructure consists of many small Makefile
10187: fragments. Each such fragment needs a properly specified
10188: interface. This chapter explains how such an interface looks
10189: like.</p>
1.128 ! wiz 10190: <div class="sect1" title="24.1. The meaning of variable definitions">
1.75 rillig 10191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10192: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10193: <p>Whenever a variable is defined in the pkgsrc
10194: infrastructure, the location and the way of definition provide
10195: much information about the intended use of that variable.
10196: Additionally, more documentation may be found in a header
10197: comment or in this pkgsrc guide.</p>
10198: <p>A special file is
10199: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10200: variables that are intended to be user-defined. They are either
10201: defined using the <code class="literal">?=</code> operator or they are
10202: left undefined because defining them to anything would
1.128 ! wiz 10203: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10204: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10205: file.</p>
10206: <p>Outside this file, the following conventions apply:
10207: Variables that are defined using the <code class="literal">?=</code>
10208: operator may be overridden by a package.</p>
10209: <p>Variables that are defined using the <code class="literal">=</code>
10210: operator may be used read-only at run-time.</p>
10211: <p>Variables whose name starts with an underscore must not be
10212: accessed outside the pkgsrc infrastructure at all. They may
10213: change without further notice.</p>
1.128 ! wiz 10214: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10215: <h3 class="title">Note</h3>
10216: <p>These conventions are currently not applied
10217: consistently to the complete pkgsrc
10218: infrastructure.</p>
10219: </div>
10220: </div>
1.128 ! wiz 10221: <div class="sect1" title="24.2. Avoiding problems before they arise">
1.81 rillig 10222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10223: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10224: <p>All variables that contain lists of things should default
10225: to being empty. Two examples that do not follow this rule are
10226: <code class="varname">USE_LANGUAGES</code> and
10227: <code class="varname">DISTFILES</code>. These variables cannot simply be
10228: modified using the <code class="literal">+=</code> operator in package
10229: <code class="filename">Makefile</code>s (or other files included by
10230: them), since there is no guarantee whether the variable is
10231: already set or not, and what its value is. In the case of
1.128 ! wiz 10232: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10233: the default value and just define it as in the following
10234: example.</p>
10235: <pre class="programlisting">
1.100 rillig 10236: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10237: </pre>
10238: <p>Because of the selection of this default value, the same
10239: value appears in many package Makefiles. Similarly for
10240: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 ! wiz 10241: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10242: doesn't stand out. Nevertheless it is mentioned in many
10243: files.</p>
10244: </div>
1.128 ! wiz 10245: <div class="sect1" title="24.3. Variable evaluation">
1.81 rillig 10246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10247: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.128 ! wiz 10248: <div class="sect2" title="24.3.1. At load time">
1.75 rillig 10249: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10250: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10251: <p>Variable evaluation takes place either at load time or at
10252: runtime, depending on the context in which they occur. The
10253: contexts where variables are evaluated at load time are:</p>
1.128 ! wiz 10254: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 10255: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10256: and <code class="literal">!=</code> operators,</p></li>
1.128 ! wiz 10257: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10258: <code class="literal">.for</code>,</p></li>
1.128 ! wiz 10259: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10260: </ul></div>
10261: <p>A special exception are references to the iteration
10262: variables of <code class="literal">.for</code> loops, which are expanded
10263: inline, no matter in which context they appear.</p>
10264: <p>As the values of variables may change during load time,
10265: care must be taken not to evaluate them by accident. Typical
10266: examples for variables that should not be evaluated at load time
10267: are <code class="varname">DEPENDS</code> and
10268: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10269: clear, here is an example:</p>
10270: <pre class="programlisting">
1.100 rillig 10271: CONFIGURE_ARGS= # none
10272: CFLAGS= -O
10273: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10274:
1.100 rillig 10275: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10276:
1.100 rillig 10277: CFLAGS+= -Wall
1.75 rillig 10278: </pre>
10279: <p>This code shows how the use of the <code class="literal">:=</code>
10280: operator can quickly lead to unexpected results. The first
10281: paragraph is fairly common code. The second paragraph evaluates
10282: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10283: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10284: <code class="literal">-Wall</code> is appended to the
10285: <code class="varname">CFLAGS</code>, but this addition will not appear in
10286: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10287: paragraphs from above typically occur in completely unrelated
10288: files.</p>
10289: </div>
1.128 ! wiz 10290: <div class="sect2" title="24.3.2. At runtime">
1.75 rillig 10291: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10292: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10293: <p>After all the files have been loaded, the values of the
10294: variables cannot be changed anymore. Variables that are used in
10295: the shell commands are expanded at this point.</p>
10296: </div>
10297: </div>
1.128 ! wiz 10298: <div class="sect1" title="24.4. How can variables be specified?">
1.75 rillig 10299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10300: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10301: <p>There are many ways in which the definition and use of a
10302: variable can be restricted in order to detect bugs and
10303: violations of the (mostly unwritten) policies. See the
10304: <code class="literal">pkglint</code> developer's documentation for further
10305: details.</p>
10306: </div>
1.128 ! wiz 10307: <div class="sect1" title="24.5. Designing interfaces for Makefile fragments">
1.78 rillig 10308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10309: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10310: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10311: of the following classes. Cases where a file falls into more
10312: than one class should be avoided as it often leads to subtle
10313: bugs.</p>
1.128 ! wiz 10314: <div class="sect2" title="24.5.1. Procedures with parameters">
1.75 rillig 10315: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10316: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10317: <p>In a traditional imperative programming language some of
1.76 rillig 10318: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10319: procedures. They take some input parameters and—after
10320: inclusion—provide a result in output parameters. Since all
1.76 rillig 10321: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10322: care must be taken not to use parameter names that have already
10323: another meaning. For example, <code class="varname">PKGNAME</code> is a
10324: bad choice for a parameter name.</p>
10325: <p>Procedures are completely evaluated at preprocessing time.
10326: That is, when calling a procedure all input parameters must be
10327: completely resolvable. For example,
10328: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10329: parameter since it is very likely that further text will be
10330: added after calling the procedure, which would effectively apply
10331: the procedure to only a part of the variable. Also, references
10332: to other variables wit will be modified after calling the
10333: procedure.</p>
10334: <p>A procedure can declare its output parameters either as
10335: suitable for use in preprocessing directives or as only
10336: available at runtime. The latter alternative is for variables
10337: that contain references to other runtime variables.</p>
10338: <p>Procedures shall be written such that it is possible to
10339: call the procedure more than once. That is, the file must not
10340: contain multiple-inclusion guards.</p>
10341: <p>Examples for procedures are
1.76 rillig 10342: <code class="filename">mk/bsd.options.mk</code> and
10343: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10344: that the parameters are evaluated at load time, they should be
10345: assigned using the <code class="literal">:=</code> operator, which should
10346: be used only for this purpose.</p>
10347: </div>
1.128 ! wiz 10348: <div class="sect2" title="24.5.2. Actions taken on behalf of parameters">
1.75 rillig 10349: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10350: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10351: <p>Action files take some input parameters and may define
10352: runtime variables. They shall not define loadtime variables.
10353: There are action files that are included implicitly by the
10354: pkgsrc infrastructure, while other must be included
10355: explicitly.</p>
10356: <p>An example for action files is
1.76 rillig 10357: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10358: </div>
10359: </div>
1.128 ! wiz 10360: <div class="sect1" title="24.6. The order in which files are loaded">
1.81 rillig 10361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10362: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10363: <p>Package <code class="filename">Makefile</code>s usually consist of
10364: a set of variable definitions, and include the file
10365: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10366: Before that, they may also include various other
10367: <code class="filename">*.mk</code> files if they need to query the
10368: availability of certain features like the type of compiler or
10369: the X11 implementation. Due to the heavy use of preprocessor
10370: directives like <code class="literal">.if</code> and
10371: <code class="literal">.for</code>, the order in which the files are loaded
10372: matters.</p>
10373: <p>This section describes at which point the various files
10374: are loaded and gives reasons for that order.</p>
1.128 ! wiz 10375: <div class="sect2" title="24.6.1. The order in bsd.prefs.mk">
1.81 rillig 10376: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10377: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10378: </h3></div></div></div>
10379: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10380: is to define some essential variables like
10381: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10382: <code class="varname">MACHINE_ARCH</code>.</p>
10383: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10384: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104 rillig 10385: After that, those variables
1.81 rillig 10386: that have not been overridden by the user are loaded from
10387: <code class="filename">mk/defaults/mk.conf</code>.</p>
10388: <p>After the user settings, the system settings and platform
10389: settings are loaded, which may override the user
10390: settings.</p>
10391: <p>Then, the tool definitions are loaded. The tool wrappers
10392: are not yet in effect. This only happens when building a
10393: package, so the proper variables must be used instead of the
10394: direct tool names.</p>
10395: <p>As the last steps, some essential variables from the
10396: wrapper and the package system flavor are loaded, as well as the
10397: variables that have been cached in earlier phases of a package
10398: build.</p>
10399: </div>
1.128 ! wiz 10400: <div class="sect2" title="24.6.2. The order in bsd.pkg.mk">
1.81 rillig 10401: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10402: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10403: </h3></div></div></div>
1.81 rillig 10404: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10405: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10406: loaded, which fill default values for those variables that have
1.93 rillig 10407: not been defined by the package. These variables may later
1.81 rillig 10408: be used even in unrelated files.</p>
10409: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10410: provides the target <code class="literal">error-check</code> that is added
10411: as a special dependency to all other targets that use
10412: <code class="varname">DELAYED_ERROR_MSG</code> or
10413: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10414: <p>Then, the package-specific hacks from
10415: <code class="filename">hacks.mk</code> are included.</p>
10416: <p>Then, various other files follow. Most of them don't have
10417: any dependencies on what they need to have included before or
10418: after them, though some do.</p>
10419: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10420: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10421: restricts the use of these variables to all the files that have
10422: been included before. Appearances in later files will be
10423: silently ignored.</p>
10424: <p>Then, the files for the main targets are included, in the
10425: order of later execution, though the actual order should not
10426: matter.</p>
10427: <p>At last, some more files are included that don't set any
10428: interesting variables but rather just define make targets to be
10429: executed.</p>
10430: </div>
10431: </div>
1.75 rillig 10432: </div>
1.128 ! wiz 10433: <div class="chapter" title="Chapter 25. Regression tests">
1.75 rillig 10434: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10435: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10436: <div class="toc">
10437: <p><b>Table of Contents</b></p>
10438: <dl>
1.106 rillig 10439: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10440: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10441: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10442: <dd><dl>
1.106 rillig 10443: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10444: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10445: </dl></dd>
10446: </dl>
10447: </div>
10448: <p>The pkgsrc infrastructure consists of a large codebase,
10449: and there are many corners where every little bit of a file is
10450: well thought out, making pkgsrc likely to fail as soon as
10451: anything is changed near those parts. To prevent most changes
10452: from breaking anything, a suite of regression tests should go
10453: along with every important part of the pkgsrc infrastructure.
10454: This chapter describes how regression tests work in pkgsrc and
10455: how you can add new tests.</p>
1.128 ! wiz 10456: <div class="sect1" title="25.1. The regression tests framework">
1.75 rillig 10457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10458: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10459: <p></p>
10460: </div>
1.128 ! wiz 10461: <div class="sect1" title="25.2. Running the regression tests">
1.75 rillig 10462: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10463: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10464: <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.110 hubertf 10465: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10466: can simply run that command, which will run all tests in the
1.76 rillig 10467: <code class="filename">regress</code> category.</p>
1.75 rillig 10468: </div>
1.128 ! wiz 10469: <div class="sect1" title="25.3. Adding a new regression test">
1.75 rillig 10470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10471: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10472: <p>Every directory in the <code class="filename">regress</code>
10473: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10474: is considered a regression test. This file is a shell program
1.110 hubertf 10475: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10476: The following functions can be overridden to suit your
10477: needs.</p>
1.128 ! wiz 10478: <div class="sect2" title="25.3.1. Overridable functions">
1.75 rillig 10479: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10480: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10481: <p>These functions do not take any parameters. They are all
1.128 ! wiz 10482: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10483: to check the exitcodes of any commands you run in the
10484: test.</p>
10485: <div class="variablelist"><dl>
10486: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10487: <dd><p>This function prepares the environment for the
10488: test. By default it does nothing.</p></dd>
10489: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10490: <dd><p>This function runs the actual test. By default,
10491: it calls <code class="varname">TEST_MAKE</code> with the arguments
10492: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10493: error messages into the file
10494: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10495: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10496: <dd><p>This function is run after the test and is
10497: typically used to compare the actual output from the one that is
10498: expected. It can make use of the various helper functions from
10499: the next section.</p></dd>
10500: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10501: <dd><p>This function cleans everything up after the
10502: test has been run. By default it does nothing.</p></dd>
10503: </dl></div>
10504: </div>
1.128 ! wiz 10505: <div class="sect2" title="25.3.2. Helper functions">
1.75 rillig 10506: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10507: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10508: <div class="variablelist"><dl>
10509: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10510: <dd><p>This function compares the exitcode of the
1.110 hubertf 10511: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10512: If they differ, the test will fail.</p></dd>
10513: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10514: <dd><p>This function checks for each of its parameters
1.110 hubertf 10515: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10516: extended regular expression. If it does not, the test will
10517: fail.</p></dd>
10518: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10519: <dd><p>This function checks for each of its parameters
1.110 hubertf 10520: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10521: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10522: If any of the regular expressions matches, the test will
10523: fail.</p></dd>
10524: </dl></div>
10525: </div>
10526: </div>
10527: </div>
1.128 ! wiz 10528: <div class="chapter" title="Chapter 26. Porting pkgsrc">
1.75 rillig 10529: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10530: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10531: <div class="toc">
10532: <p><b>Table of Contents</b></p>
10533: <dl>
1.106 rillig 10534: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10535: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10536: </dl>
10537: </div>
10538: <p>The pkgsrc system has already been ported to many
10539: operating systems, hardware architectures and compilers. This
10540: chapter explains the necessary steps to make pkgsrc even more
10541: portable.</p>
1.128 ! wiz 10542: <div class="sect1" title="26.1. Porting pkgsrc to a new operating system">
1.75 rillig 10543: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10544: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10545: <p>To port pkgsrc to a new operating system (called
10546: <code class="literal">MyOS</code> in this example), you need to touch the
10547: following files:</p>
10548: <div class="variablelist"><dl>
1.93 rillig 10549: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75 rillig 10550: <dd><p>This file contains some basic definitions, for
10551: example the name of the C
10552: compiler.</p></dd>
1.76 rillig 10553: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10554: <dd><p>Insert code that defines the variables
10555: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10556: <code class="varname">LOWER_OS_VERSION</code>,
10557: <code class="varname">LOWER_VENDOR</code>,
10558: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10559: <code class="varname">APPEND_ELF</code>, and the other variables that
10560: appear in this file.</p></dd>
1.93 rillig 10561: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10562: <dd><p>This file contains the platform-specific
10563: definitions that are used by pkgsrc. Start by copying one of the
10564: other files and edit it to your
10565: needs.</p></dd>
1.93 rillig 10566: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10567: <dd><p>This file contains a list of directories,
10568: together with their permission bits and ownership. These
10569: directories will be created automatically with every package
1.98 wiz 10570: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10571: be removed.</p></dd>
1.93 rillig 10572: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10573: <dd><p>Just copy one of the pre-existing x11.dist files
10574: to your
1.76 rillig 10575: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10576: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10577: <dd><p>On some operating systems, the tools that are
10578: provided with the base system are not good enough for pkgsrc.
1.110 hubertf 10579: For example, there are many versions of <a class="citerefentry" 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
1.75 rillig 10580: narrow limit on the line length they can process. Therefore
10581: pkgsrc brings its own tools, which can be enabled
10582: here.</p></dd>
1.93 rillig 10583: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10584: <dd><p>This file defines the paths to all the tools
10585: that are needed by one or the other package in pkgsrc, as well
10586: as by pkgsrc itself. Find out where these tools are on your
10587: platform and add them.</p></dd>
10588: </dl></div>
10589: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10590: <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 10591: </div>
1.128 ! wiz 10592: <div class="sect1" title="26.2. Adding support for a new compiler">
1.75 rillig 10593: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10594: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10595: <p>TODO</p>
10596: </div>
10597: </div>
10598: </div>
1.128 ! wiz 10599: <div class="appendix" title="Appendix A. A simple example package: bison">
1.75 rillig 10600: <div class="titlepage"><div><div><h2 class="title">
10601: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10602: <div class="toc">
10603: <p><b>Table of Contents</b></p>
10604: <dl>
10605: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10606: <dd><dl>
10607: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10608: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10609: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 ! wiz 10610: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75 rillig 10611: </dl></dd>
10612: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10613: </dl>
10614: </div>
10615: <p>We checked to find a piece of software that wasn't in the packages
10616: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10617: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10618: present in the tree is beyond us, but it's useful for the purposes of
10619: this exercise.</p>
1.128 ! wiz 10620: <div class="sect1" title="A.1. files">
1.75 rillig 10621: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10622: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.128 ! wiz 10623: <div class="sect2" title="A.1.1. Makefile">
1.75 rillig 10624: <div class="titlepage"><div><div><h3 class="title">
10625: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10626: <pre class="programlisting">
1.100 rillig 10627: # $NetBSD$
10628: #
1.1 grant 10629:
1.100 rillig 10630: DISTNAME= bison-1.25
10631: CATEGORIES= devel
10632: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10633:
1.100 rillig 10634: MAINTAINER= thorpej@NetBSD.org
10635: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10636: COMMENT= GNU yacc clone
1.1 grant 10637:
1.100 rillig 10638: GNU_CONFIGURE= yes
10639: INFO_FILES= bison.info
1.1 grant 10640:
1.100 rillig 10641: .include "../../mk/bsd.pkg.mk"
1.1 grant 10642: </pre>
1.75 rillig 10643: </div>
1.128 ! wiz 10644: <div class="sect2" title="A.1.2. DESCR">
1.75 rillig 10645: <div class="titlepage"><div><div><h3 class="title">
10646: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10647: <pre class="programlisting">
1.100 rillig 10648: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.110 hubertf 10649: improvements. Why you would want this when Berkeley <a class="citerefentry" 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.100 rillig 10650: of the NetBSD source tree is beyond me.
1.1 grant 10651: </pre>
1.75 rillig 10652: </div>
1.128 ! wiz 10653: <div class="sect2" title="A.1.3. PLIST">
1.75 rillig 10654: <div class="titlepage"><div><div><h3 class="title">
10655: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10656: <pre class="programlisting">
1.100 rillig 10657: @comment $NetBSD$
10658: bin/bison
10659: man/man1/bison.1.gz
10660: share/bison.simple
10661: share/bison.hairy
1.1 grant 10662: </pre>
1.75 rillig 10663: </div>
1.128 ! wiz 10664: <div class="sect2" title="A.1.4. Checking a package with pkglint">
1.75 rillig 10665: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10666: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10667: </h3></div></div></div>
1.75 rillig 10668: <p>The NetBSD package system comes with
1.91 rillig 10669: <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 10670: which helps to check the contents of these
10671: files. After installation it is quite easy to use, just change to the
10672: directory of the package you wish to examine and execute
1.110 hubertf 10673: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10674: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10675: looks fine.</pre>
10676: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10677: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10678: -Wall</strong></span> for a very thorough check.</p>
10679: </div>
10680: </div>
1.128 ! wiz 10681: <div class="sect1" title="A.2. Steps for building, installing, packaging">
1.75 rillig 10682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10683: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10684: <p>Create the directory where the package lives,
10685: plus any auxiliary directories:</p>
10686: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10687: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10688: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10689: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10690: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10691: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.75 rillig 10692: then continue with fetching the distfile:</p>
10693: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10694: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10695: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10696: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10697: ftp: Error retrieving file: 500 Internal error
10698:
10699: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10700: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10701: ftp: Error retrieving file: 500 Internal error
10702:
10703: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10704: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10705: Successfully retrieved file.</pre>
10706: <p>Generate the checksum of the distfile into
1.76 rillig 10707: <code class="filename">distinfo</code>:</p>
1.88 wiz 10708: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10709: <p>Now compile:</p>
10710: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10711: >> Checksum OK for bison-1.25.tar.gz.
10712: ===> Extracting for bison-1.25
10713: ===> Patching for bison-1.25
10714: ===> Ignoring empty patch directory
10715: ===> Configuring for bison-1.25
10716: creating cache ./config.cache
10717: checking for gcc... cc
10718: checking whether we are using GNU C... yes
10719: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10720: checking how to run the C preprocessor... cc -E
10721: checking for minix/config.h... no
10722: checking for POSIXized ISC... no
10723: checking whether cross-compiling... no
10724: checking for ANSI C header files... yes
10725: checking for string.h... yes
10726: checking for stdlib.h... yes
10727: checking for memory.h... yes
10728: checking for working const... yes
10729: checking for working alloca.h... no
10730: checking for alloca... yes
10731: checking for strerror... yes
10732: updating cache ./config.cache
10733: creating ./config.status
10734: creating Makefile
10735: ===> Building for bison-1.25
10736: 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
10737: 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
10738: 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
10739: 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
10740: 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 10741: 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 10742: 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
10743: 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
10744: 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
10745: 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
10746: 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
10747: 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
10748: 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
10749: 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
10750: 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
10751: 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
10752: 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
10753: 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
10754: 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
10755: 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
10756: 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
10757: 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
10758: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10759: rm -f bison.s1
1.75 rillig 10760: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10761: <p>Everything seems OK, so install the files:</p>
10762: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10763: >> Checksum OK for bison-1.25.tar.gz.
10764: ===> Installing for bison-1.25
10765: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10766: rm -f /usr/pkg/bin/bison
10767: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10768: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10769: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10770: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10771: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10772: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10773: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10774: ===> Registering installation for bison-1.25</pre>
10775: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10776: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10777: binary package, do this now:</p>
10778: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10779: >> Checksum OK for bison-1.25.tar.gz.
10780: ===> Building package for bison-1.25
10781: Creating package bison-1.25.tgz
10782: Registering depends:.
1.75 rillig 10783: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10784: <p>Now that you don't need the source and object files
10785: any more, clean up:</p>
10786: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10787: ===> Cleaning for bison-1.25</pre>
10788: </div>
10789: </div>
1.128 ! wiz 10790: <div class="appendix" title="Appendix B. Build logs">
1.75 rillig 10791: <div class="titlepage"><div><div><h2 class="title">
10792: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10793: <div class="toc">
10794: <p><b>Table of Contents</b></p>
10795: <dl>
10796: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10797: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10798: </dl>
10799: </div>
1.128 ! wiz 10800: <div class="sect1" title="B.1. Building figlet">
1.75 rillig 10801: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10802: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10803: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10804: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10805: => figlet221.tar.gz doesn't seem to exist on this system.
10806: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10807: => [172219 bytes]
10808: Connected to ftp.plig.net.
10809: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10810: 331 Guest login ok, send your complete e-mail address as password.
10811: 230-You are user #5 of 500 simultaneous users allowed.
10812: 230-
1.68 rillig 10813: 230- ___ _ _ _
10814: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10815: 230- | _| _| . |_| . | | | . |_| . | _| . |
10816: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10817: 230- |_| |_| |___| |___|
10818: 230-
10819: 230-** Welcome to ftp.plig.org **
10820: 230-
10821: 230-Please note that all transfers from this FTP site are logged. If you
10822: 230-do not like this, please disconnect now.
10823: 230-
1.120 snj 10824: 230-This archive is available via
1.1 grant 10825: 230-
10826: 230-HTTP: http://ftp.plig.org/
10827: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10828: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10829: 230-
10830: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10831: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10832: 230-
10833: 230-
10834: 230 Logged in anonymously.
10835: Remote system type is UNIX.
10836: Using binary mode to transfer files.
10837: 200 Type okay.
10838: 250 "/pub" is new cwd.
10839: 250-"/pub/figlet" is new cwd.
10840: 250-
10841: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10842: 250-
1.75 rillig 10843: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10844: 250-
10845: 250-The official FIGlet web page is:
1.75 rillig 10846: 250- http://www.figlet.org/
1.1 grant 10847: 250-
10848: 250-If you have questions, please mailto:info@figlet.org. If you want to
10849: 250-contribute a font or something else, you can email us.
1.68 rillig 10850: 250
1.1 grant 10851: 250 "/pub/figlet/program" is new cwd.
10852: 250 "/pub/figlet/program/unix" is new cwd.
10853: local: figlet221.tar.gz remote: figlet221.tar.gz
10854: 502 Unimplemented command.
10855: 227 Entering Passive Mode (195,40,6,41,246,104)
10856: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10857: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10858: 226 Transfer completed.
10859: 172219 bytes received in 00:02 (75.99 KB/s)
10860: 221 Goodbye.
10861: => Checksum OK for figlet221.tar.gz.
10862: ===> Extracting for figlet-2.2.1nb2
10863: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10864: ===> Patching for figlet-2.2.1nb2
10865: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10866: ===> Overriding tools for figlet-2.2.1nb2
10867: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10868: ===> Configuring for figlet-2.2.1nb2
10869: ===> Building for figlet-2.2.1nb2
10870: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10871: chmod a+x figlet
10872: gcc -O2 -o chkfont chkfont.c
10873: => Unwrapping files-to-be-installed.
1.14 xtraeme 10874: <code class="prompt">#</code>
1.75 rillig 10875: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10876: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10877: ===> Installing for figlet-2.2.1nb2
10878: install -d -o root -g wheel -m 755 /usr/pkg/bin
10879: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10880: mkdir -p /usr/pkg/share/figlet
10881: cp figlet /usr/pkg/bin
10882: cp chkfont /usr/pkg/bin
10883: chmod 555 figlist showfigfonts
10884: cp figlist /usr/pkg/bin
10885: cp showfigfonts /usr/pkg/bin
10886: cp fonts/*.flf /usr/pkg/share/figlet
10887: cp fonts/*.flc /usr/pkg/share/figlet
10888: cp figlet.6 /usr/pkg/man/man6
10889: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10890: <code class="prompt">#</code></pre>
10891: </div>
1.128 ! wiz 10892: <div class="sect1" title="B.2. Packaging figlet">
1.75 rillig 10893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10894: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10895: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10896: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10897: ===> Packaging figlet-2.2.1nb2
10898: ===> Building binary package for figlet-2.2.1nb2
10899: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10900: Using SrcDir value of /usr/pkg
1.68 rillig 10901: Registering depends:.
1.75 rillig 10902: <code class="prompt">#</code></pre>
10903: </div>
10904: </div>
1.128 ! wiz 10905: <div class="appendix" title="Appendix C. Directory layout of the pkgsrc FTP server">
1.75 rillig 10906: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10907: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10908: <div class="toc">
10909: <p><b>Table of Contents</b></p>
10910: <dl>
1.128 ! wiz 10911: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
! 10912: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
! 10913: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
! 10914: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
! 10915: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
! 10916: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10917: source packages</a></span></dt>
10918: </dl>
10919: </div>
10920: <p>As in other big projects, the directory layout of pkgsrc
10921: is quite complex for newbies. This chapter explains where you
10922: find things on the FTP server. The base directory on
1.110 hubertf 10923: <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89 rillig 10924: On other servers it may be different, but inside this directory,
10925: everything should look the same, no matter on which server you
10926: are. This directory contains some subdirectories, which are
10927: explained below.</p>
1.128 ! wiz 10928: <div class="sect1" title="C.1. distfiles: The distributed source files">
1.76 rillig 10929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10930: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10931: <p>The directory <code class="filename">distfiles</code> contains lots
10932: of archive files from all pkgsrc packages, which are mirrored
10933: here. The subdirectories are called after their package names
10934: and are used when the distributed files have names that don't
10935: explicitly contain a version number or are otherwise too generic
10936: (for example <code class="filename">release.tar.gz</code>).</p>
10937: </div>
1.128 ! wiz 10938: <div class="sect1" title="C.2. misc: Miscellaneous things">
1.76 rillig 10939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10940: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10941: <p>This directory contains things that individual pkgsrc
10942: developers find worth publishing.</p>
10943: </div>
1.128 ! wiz 10944: <div class="sect1" title="C.3. packages: Binary packages">
1.76 rillig 10945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10946: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10947: <p>This directory contains binary packages for the various
10948: platforms that are supported by pkgsrc.
10949: Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.128 ! wiz 10950: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 10951: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10952: operating system for which the packages have been built. The
1.110 hubertf 10953: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10954: command, so it may differ from the one you are used to
10955: hear.</p></li>
1.128 ! wiz 10956: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10957: architecture of the platform for which the packages have been
1.110 hubertf 10958: built. It also includes the <code class="varname">ABI</code> (Application
10959: Binary Interface) for platforms that have several of
10960: them.</p></li>
1.128 ! wiz 10961: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10962: the operating system. For version numbers that change often (for
10963: example NetBSD-current), the often-changing part should be
10964: replaced with an <code class="literal">x</code>, for example
10965: <code class="literal">4.99.x</code>.</p></li>
1.128 ! wiz 10966: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10967: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10968: for a stable branch, or <code class="literal">head</code> for packages
10969: built from the HEAD branch. The latter should only be used when
10970: the packages are updated on a regular basis. Otherwise the date
10971: from checking out pkgsrc should be appended, for example
10972: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10973: </ul></div>
10974: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10975: can quickly click through the directories on the
10976: server and find the best binary packages for their machines. Since they
10977: usually know the operating system and the hardware architecture, OPSYS
10978: and ARCH are placed first. After these choices, they can select the
10979: best combination of OSVERSION and TAG together, since it is usually the
10980: case that packages stay compatible between different version of the
10981: operating system.</p>
10982: <p>In each of these directories, there is a
10983: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10984: <code class="filename">All</code> which contains all binary packages.
10985: Besides that, there are various category directories that
10986: contain symbolic links to the real binary packages.</p>
10987: </div>
1.128 ! wiz 10988: <div class="sect1" title="C.4. reports: Bulk build reports">
1.76 rillig 10989: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10990: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10991: <p>Here are the reports from bulk builds, for those who want
10992: to fix packages that didn't build on some of the platforms. The
1.128 ! wiz 10993: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.108 rillig 10994: </div>
1.128 ! wiz 10995: <div class="sect1" title="C.5. current, pkgsrc-20xxQy: source packages">
1.108 rillig 10996: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10997: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10998: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10999: source packages</h2></div></div></div>
1.128 ! wiz 11000: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11001: that is the files that define how to create binary packages from
11002: source archives.</p>
11003: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11004: snapshot of the CVS repository, which is updated regularly. The
11005: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11006: directory, ready to be downloaded as a whole.</p>
1.76 rillig 11007: <p>In the directories for the quarterly branches, there is an
11008: additional file called
1.126 jakllsch 11009: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.76 rillig 11010: which contains the state of pkgsrc when it was branched.</p>
11011: </div>
1.75 rillig 11012: </div>
1.128 ! wiz 11013: <div class="appendix" title="Appendix D. Editing guidelines for the pkgsrc guide">
1.75 rillig 11014: <div class="titlepage"><div><div><h2 class="title">
11015: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
11016: <div class="toc">
11017: <p><b>Table of Contents</b></p>
11018: <dl>
1.79 rillig 11019: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 11020: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11021: </dl>
11022: </div>
1.79 rillig 11023: <p>This section contains information on editing the pkgsrc
11024: guide itself.</p>
1.128 ! wiz 11025: <div class="sect1" title="D.1. Make targets">
1.75 rillig 11026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 11027: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11028: <p>The pkgsrc guide's source code is stored in
11029: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11030: are created from it:</p>
1.128 ! wiz 11031: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
! 11032: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
! 11033: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
! 11034: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
! 11035: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79 rillig 11036: The PDF version of the pkgsrc guide.</p></li>
1.128 ! wiz 11037: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79 rillig 11038: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 11039: </ul></div>
11040: </div>
1.128 ! wiz 11041: <div class="sect1" title="D.2. Procedure">
1.75 rillig 11042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11043: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 11044: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 ! wiz 11045: <div class="procedure"><ol class="procedure" type="1">
! 11046: <li class="step" title="Step 1"><p>Make sure you have the packages needed to
1.83 wiz 11047: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 11048: 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
11049: 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 11050: PostScript and PDF versions. You will need both packages
11051: installed, to make sure documentation is consistent across all
11052: formats.</p></li>
1.128 ! wiz 11053: <li class="step" title="Step 2"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 11054: right directory. All further steps will take place
11055: here.</p></li>
1.128 ! wiz 11056: <li class="step" title="Step 3"><p>Edit the XML file(s) in
1.79 rillig 11057: <code class="filename">files/</code>.</p></li>
1.128 ! wiz 11058: <li class="step" title="Step 4"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 11059: guide for valid XML and to build the final output files. If you
11060: get any errors at this stage, you can just edit the files, as
11061: there are only symbolic links in the working directory, pointing
11062: to the files in <code class="filename">files/</code>.</p></li>
1.128 ! wiz 11063: <li class="step" title="Step 5"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 11064: commit)</strong></span></p></li>
1.128 ! wiz 11065: <li class="step" title="Step 6"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 11066: regenerate the output files with the proper RCS
11067: Ids.</p></li>
1.128 ! wiz 11068: <li class="step" title="Step 7">
1.110 hubertf 11069: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 11070: commit the files in both <code class="filename">pkgsrc/doc</code> and
11071: <code class="filename">htdocs</code>.</p>
1.128 ! wiz 11072: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 11073: <h3 class="title">Note</h3>
11074: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 11075: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11076: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 11077: directory.</p>
11078: </div>
11079: </li>
1.79 rillig 11080: </ol></div>
1.75 rillig 11081: </div>
11082: </div>
11083: </div></body>
1.1 grant 11084: </html>
CVSweb <webmaster@jp.NetBSD.org>